Docs.

diff --git a/src/lib/content.h b/src/lib/content.h
index ab14dc6f5d94ddc163dc5e4f83f3f04eec245d0f..f7e97feac9a3489d1083f96278a4eea3e491d367 100644 (file)
--- 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 7ead80ecb373730de35d89a2d92c6eaa9cf3bca9..7b7e85d9df745220e334207cb8ebe6ffd9c1d29e 100644 (file)
--- 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 588c250fe7282fdeec15e1305f7ef4496a2b6a4d..9abc25e5617fd3752527fbbf57677ebc6e7ae36a 100644 (file)
--- 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: