diff options
| author | Carl Hetherington <cth@carlh.net> | 2012-09-24 01:58:56 +0100 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2012-09-24 01:58:56 +0100 |
| commit | 3fc9a435a720d8b2abd78c1bdc7b34bc635ad797 (patch) | |
| tree | 2b666a8aadcdf6d657af02c64f188af6ba2e5789 /src/lib/encoder.cc | |
| parent | 5c887bc8105d92b4b8e9380e62e655ac6691b439 (diff) | |
Some doxygen documentation improvements.
Diffstat (limited to 'src/lib/encoder.cc')
| -rw-r--r-- | src/lib/encoder.cc | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/lib/encoder.cc b/src/lib/encoder.cc index 18ccd3f57..62ba922da 100644 --- 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) { |