Merge master branch.

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

diff --git a/src/lib/audio_decoder.h b/src/lib/audio_decoder.h
index e9fbd6f62f19f1605f1e77ec3685f98601d71a0c..3bf585f4de1f77259de867f218d66fa6fe4fe141 100644 (file)
--- a/src/lib/audio_decoder.h
+++ b/src/lib/audio_decoder.h
@@ -17,6 +17,10 @@
 
 */
 
+/** @file src/lib/audio_decoder.h
+ *  @brief Parent class for audio decoders.
+ */
+
 #ifndef DVDOMATIC_AUDIO_DECODER_H
 #define DVDOMATIC_AUDIO_DECODER_H
 
@@ -24,23 +28,30 @@
 #include "stream.h"
 #include "decoder.h"
 
+/** @class AudioDecoder.
+ *  @brief Parent class for audio decoders.
+ */
 class AudioDecoder : public AudioSource, public virtual Decoder
 {
 public:
-       AudioDecoder (boost::shared_ptr<Film>, boost::shared_ptr<const Options>, Job *);
+       AudioDecoder (boost::shared_ptr<Film>, DecodeOptions, Job *);
 
        virtual void set_audio_stream (boost::shared_ptr<AudioStream>);
 
+       /** @return Audio stream that we are using */
        boost::shared_ptr<AudioStream> audio_stream () const {
                return _audio_stream;
        }
 
+       /** @return All available audio streams */
        std::vector<boost::shared_ptr<AudioStream> > audio_streams () const {
                return _audio_streams;
        }
 
 protected:
+       /** Audio stream that we are using */
        boost::shared_ptr<AudioStream> _audio_stream;
+       /** All available audio streams */
        std::vector<boost::shared_ptr<AudioStream> > _audio_streams;
 };