diff options
| author | Carl Hetherington <cth@carlh.net> | 2017-03-02 15:37:13 +0000 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2017-04-19 23:04:32 +0100 |
| commit | 67a68bd971ebe1b35daa3f75873b4ccb53c00ba0 (patch) | |
| tree | 9b1fea4070c3b15f346cc57075bbeed1b963329d /src/lib/encoder.cc | |
| parent | 3449bc0a6d6e77e851240a0953363f5a07ec6517 (diff) | |
Various Doxygen fixes.
Diffstat (limited to 'src/lib/encoder.cc')
| -rw-r--r-- | src/lib/encoder.cc | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/src/lib/encoder.cc b/src/lib/encoder.cc index a9e119d59..e43325f58 100644 --- a/src/lib/encoder.cc +++ b/src/lib/encoder.cc @@ -56,7 +56,9 @@ using dcp::Data; int const Encoder::_history_size = 200; -/** @param f Film that we are encoding */ +/** @param film Film that we are encoding. + * @param writer Writer that we are using. + */ Encoder::Encoder (shared_ptr<const Film> film, shared_ptr<Writer> writer) : _film (film) , _writer (writer) @@ -172,9 +174,7 @@ Encoder::video_frames_enqueued () const return _last_player_video_time->frames_floor (_film->video_frame_rate ()); } -/** Should be called when a frame has been encoded successfully. - * @param n Source frame index. - */ +/** Should be called when a frame has been encoded successfully */ void Encoder::frame_done () { @@ -192,6 +192,9 @@ Encoder::frame_done () * so each time the supplied frame is the one after the previous one. * pv represents one video frame, and could be empty if there is nothing to encode * for this DCP frame. + * + * @param pv PlayerVideo to encode. + * @param time Time of \p pv within the DCP. */ void Encoder::encode (shared_ptr<PlayerVideo> pv, DCPTime time) |