Some comments and a few small cleanups.

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

diff --git a/src/lib/audio_merger.h b/src/lib/audio_merger.h
index 87bda7f8b2f58fa190379d85ac21cd2e1e16e0a1..ffca29c57cdf471908115a42b6fc01fee3c8ffe8 100644 (file)
--- a/src/lib/audio_merger.h
+++ b/src/lib/audio_merger.h
@@ -17,22 +17,28 @@
 
 */
 
+/** @file  src/audio_merger.h
+ *  @brief AudioMerger class.
+ */
+
 #include "audio_buffers.h"
 #include "dcpomatic_time.h"
 #include "util.h"
 
+/** @class AudioMerger.
+ *  @brief A class that can merge audio data from many sources.
+ */
 class AudioMerger
 {
 public:
        AudioMerger (int frame_rate);
 
-       /** Pull audio up to a given time; after this call, no more data can be pushed
-        *  before the specified time.
-        */
        std::list<std::pair<boost::shared_ptr<AudioBuffers>, DCPTime> > pull (DCPTime time);
        void push (boost::shared_ptr<const AudioBuffers> audio, DCPTime time);
 
 private:
+       Frame frames (DCPTime t) const;
+
        class Buffer
        {
        public: