Merge branch '2.0' of ssh://main.carlh.net/home/carl/git/dcpomatic into 2.0
[dcpomatic.git] / src / lib / single_stream_audio_content.h
index 588c250fe7282fdeec15e1305f7ef4496a2b6a4d..fcfaf14ca1b211edf805d279b88744fd99b97488 100644 (file)
 
 */
 
+/** @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:
@@ -33,7 +40,6 @@ public:
 
        void as_xml (xmlpp::Node* node) const;
 
-       /* AudioContent */
        int audio_channels () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _audio_channels;