Some doxygen documentation improvements.

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

diff --git a/src/lib/encoder.cc b/src/lib/encoder.cc
index 18ccd3f5757b7d1250600704a970e399a7ac876c..62ba922daffc5c66f881afe11ee9cc8e63a7765b 100644 (file)
--- a/src/lib/encoder.cc
+++ b/src/lib/encoder.cc
@@ -60,6 +60,7 @@ Encoder::current_frames_per_second () const
        return _history_size / (seconds (now) - seconds (_time_history.back ()));
 }
 
+/** @return true if the last frame to be processed was skipped as it already existed */
 bool
 Encoder::skipping () const
 {
@@ -67,6 +68,7 @@ Encoder::skipping () const
        return _just_skipped;
 }
 
+/** @return Index of last frame to be successfully encoded */
 int
 Encoder::last_frame () const
 {
@@ -74,6 +76,9 @@ Encoder::last_frame () const
        return _last_frame;
 }
 
+/** Should be called when a frame has been encoded successfully.
+ *  @param n Frame index.
+ */
 void
 Encoder::frame_done (int n)
 {