Comments.

4 files changed, 39 insertions, 5 deletions

diff --git a/src/lib/cinema.h b/src/lib/cinema.h
index d8e28ecfd..2e7660860 100644
--- a/src/lib/cinema.h
+++ b/src/lib/cinema.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/lib/cinema.h
+ *  @brief Screen and Cinema classes.
+ */
+
 #include <boost/enable_shared_from_this.hpp>
 #include <dcp/certificates.h>
 
@@ -26,6 +30,12 @@ namespace cxml {
 	class Node;
 }
 
+/** @class Screen
+ *  @brief A representation of a Screen for KDM generation.
+ *
+ *  This is the name of the screen and the certificate of its
+ *  server.
+ */
 class Screen
 {
 public:
@@ -43,6 +53,12 @@ public:
 	boost::shared_ptr<dcp::Certificate> certificate;
 };
 
+/** @class Cinema
+ *  @brief A description of a Cinema for KDM generation.
+ *
+ *  This is a cinema name, contact email address and a list of
+ *  Screen objects.
+ */
 class Cinema : public boost::enable_shared_from_this<Cinema>
 {
 public:
diff --git a/src/lib/content.cc b/src/lib/content.cc
index 1fb4681a2..0c37d9386 100644
--- a/src/lib/content.cc
+++ b/src/lib/content.cc
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/lib/content.cc
+ *  @brief Content class.
+ */
+
 #include <boost/thread/mutex.hpp>
 #include <libxml++/libxml++.h>
 #include <libcxml/cxml.h>
diff --git a/src/lib/content.h b/src/lib/content.h
index fc3a531fa..659995b3b 100644
--- a/src/lib/content.h
+++ b/src/lib/content.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/lib/content.h
+ *  @brief Content class.
+ */
+
 #ifndef DCPOMATIC_CONTENT_H
 #define DCPOMATIC_CONTENT_H
 
@@ -46,6 +50,9 @@ public:
 	static int const TRIM_END;
 };
 
+/** @class Content
+ *  @brief A piece of content represented by one or more files on disk.
+ */
 class Content : public boost::enable_shared_from_this<Content>, public boost::noncopyable
 {
 public:
@@ -138,8 +145,8 @@ protected:
 	boost::weak_ptr<const Film> _film;
 
 	/** _mutex which should be used to protect accesses, as examine
-	    jobs can update content state in threads other than the main one.
-	*/
+	 *  jobs can update content state in threads other than the main one.
+	 */
 	mutable boost::mutex _mutex;
 
 	/** Paths of our data files */
diff --git a/src/lib/content_audio.h b/src/lib/content_audio.h
index 6ee702f2c..535c0b491 100644
--- a/src/lib/content_audio.h
+++ b/src/lib/content_audio.h
@@ -17,8 +17,15 @@
 
 */
 
+/** @file  src/lib/content_audio.h
+ *  @brief ContentAudio class.
+ */
+
 #include "audio_buffers.h"
 
+/** @class ContentAudio
+ *  @brief A block of audio from a piece of content, with a timestamp as a frame within that content.
+ */
 class ContentAudio
 {
 public: