From b1defe9019642dc4b80697291d40ed88f09de8be Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Sun, 18 Nov 2012 22:46:15 +0000 Subject: Fix mis-alignment of copied AlignedImages; add some asserts; some docs. --- src/lib/audio_decoder.h | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'src/lib/audio_decoder.h') diff --git a/src/lib/audio_decoder.h b/src/lib/audio_decoder.h index e9fbd6f62..1570fe3b0 100644 --- 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,6 +28,9 @@ #include "stream.h" #include "decoder.h" +/** @class AudioDecoder. + * @brief Parent class for audio decoders. + */ class AudioDecoder : public AudioSource, public virtual Decoder { public: @@ -31,16 +38,20 @@ public: virtual void set_audio_stream (boost::shared_ptr); + /** @return Audio stream that we are using */ boost::shared_ptr audio_stream () const { return _audio_stream; } + /** @return All available audio streams */ std::vector > audio_streams () const { return _audio_streams; } protected: + /** Audio stream that we are using */ boost::shared_ptr _audio_stream; + /** All available audio streams */ std::vector > _audio_streams; }; -- cgit v1.2.3