Some doxygen documentation improvements.

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

diff --git a/src/lib/encoder.h b/src/lib/encoder.h
index 5c0c4c03fdb95fabf993b5f7ad1fbc08f19cf111..539b2912ce9580c36b6aad8766dbf5e92ee9b871 100644 (file)
--- a/src/lib/encoder.h
+++ b/src/lib/encoder.h
@@ -84,10 +84,15 @@ protected:
 
        /** Mutex for _time_history, _just_skipped and _last_frame */
        mutable boost::mutex _history_mutex;
+       /** List of the times of completion of the last _history_size frames;
+           first is the most recently completed.
+       */
        std::list<struct timeval> _time_history;
+       /** Number of frames that we should keep history for */
        static int const _history_size;
        /** true if the last frame we processed was skipped (because it was already done) */
        bool _just_skipped;
+       /** Index of the last frame to be processed */
        int _last_frame;
 };