Remove unused Processor::process_begin; some docs.

[dcpomatic.git] / src / lib / stream.h

diff --git a/src/lib/stream.h b/src/lib/stream.h
index 5dd91f5f4b56097c221e290434f3b96624821876..c2a19e5ab5a6899121f0d2ddd188b0244bb75ba2 100644 (file)
--- a/src/lib/stream.h
+++ b/src/lib/stream.h
@@ -17,6 +17,14 @@
 
 */
 
+/** @file src/lib/stream.h
+ *  @brief Representations of audio and subtitle streams.
+ *
+ *  Some content may have multiple `streams' of audio and/or subtitles; perhaps
+ *  for multiple languages, or for stereo / surround mixes.  These classes represent
+ *  those streams, and know about their details.
+ */
+
 #ifndef DVDOMATIC_STREAM_H
 #define DVDOMATIC_STREAM_H
 
@@ -27,12 +35,18 @@ extern "C" {
 #include <libavutil/audioconvert.h>
 }
 
+/** @class Stream
+ *  @brief Parent class for streams.
+ */
 class Stream
 {
 public:
        virtual std::string to_string () const = 0;
 };
 
+/** @class AudioStream
+ *  @brief A stream of audio data.
+ */
 struct AudioStream : public Stream
 {
 public:
@@ -68,6 +82,9 @@ protected:
        int64_t _channel_layout;
 };
 
+/** @class SubtitleStream
+ *  @brief A stream of subtitle data.
+ */
 class SubtitleStream : public Stream
 {
 public: