From: Carl Hetherington <cth@carlh.net>
Date: Thu, 10 Jul 2014 10:36:19 +0000 (+0100)
Subject: Docs.
X-Git-Tag: v2.0.48~740
X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=commitdiff_plain;h=6dc102cef17ac0b3f3089985813c58bc16058e66

Docs.
---

diff --git a/src/lib/content.h b/src/lib/content.h
index ab14dc6f5..f7e97feac 100644
--- a/src/lib/content.h
+++ b/src/lib/content.h
@@ -63,16 +63,23 @@ public:
 	Content (boost::shared_ptr<const Film>, cxml::ConstNodePtr);
 	Content (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
 	virtual ~Content () {}
+
+	/** Examine the content to establish digest, frame rates and any other
+	 *  useful metadata.
+	 *  @param job Job to use to report progress, or 0.
+	 */
+	virtual void examine (boost::shared_ptr<Job> job);
 	
-	virtual void examine (boost::shared_ptr<Job>);
 	/** @return Quick one-line summary of the content, as will be presented in the
 	 *  film editor.
 	 */
 	virtual std::string summary () const = 0;
+	
 	/** @return Technical details of this content; these are written to logs to
 	 *  help with debugging.
 	 */
 	virtual std::string technical_summary () const;
+	
 	virtual std::string information () const = 0;
 	virtual void as_xml (xmlpp::Node *) const;
 	virtual DCPTime full_length () const = 0;
diff --git a/src/lib/dcp_content.h b/src/lib/dcp_content.h
index 7ead80ecb..7b7e85d9d 100644
--- a/src/lib/dcp_content.h
+++ b/src/lib/dcp_content.h
@@ -17,11 +17,18 @@
 
 */
 
+/** @file  src/lib/dcp_content.h
+ *  @brief DCPContent class.
+ */
+
 #include <libcxml/cxml.h>
 #include "video_content.h"
 #include "single_stream_audio_content.h"
 #include "subtitle_content.h"
 
+/** @class DCPContent
+ *  @brief An existing DCP used as input.
+ */
 class DCPContent : public VideoContent, public SingleStreamAudioContent, public SubtitleContent
 {
 public:
diff --git a/src/lib/single_stream_audio_content.h b/src/lib/single_stream_audio_content.h
index 588c250fe..9abc25e56 100644
--- a/src/lib/single_stream_audio_content.h
+++ b/src/lib/single_stream_audio_content.h
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/lib/single_stream_audio_content.h
+ *  @brief SingleStreamAudioContent class.
+ */
+
 #ifndef DCPOMATIC_SINGLE_STREAM_AUDIO_CONTENT_H
 #define DCPOMATIC_SINGLE_STREAM_AUDIO_CONTENT_H
 
@@ -24,6 +28,9 @@
 
 class AudioExaminer;
 
+/** @class SingleStreamAudioContent
+ *  @brief A piece of AudioContent that has a single audio stream.
+ */
 class SingleStreamAudioContent : public AudioContent
 {
 public: