diff options
| author | Carl Hetherington <cth@carlh.net> | 2012-10-18 22:37:05 +0100 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2012-10-18 22:37:05 +0100 |
| commit | de04e4a8418dedb76d6a7954eb4bd286e8170587 (patch) | |
| tree | 999d7ec2cdabc74d5b52dd659a254c9d0b0a9915 /src/lib | |
| parent | edcdbf65acf3d39a0157f4c41528ef7038b2ed53 (diff) | |
Commenting tweaks.
Diffstat (limited to 'src/lib')
| -rw-r--r-- | src/lib/film.cc | 10 | ||||
| -rw-r--r-- | src/lib/film_state.cc | 9 |
2 files changed, 12 insertions, 7 deletions
diff --git a/src/lib/film.cc b/src/lib/film.cc index 5b21ed3bc..4ceef17ea 100644 --- a/src/lib/film.cc +++ b/src/lib/film.cc @@ -275,6 +275,7 @@ Film::copy_from_dvd_post_gui () set_content (largest_file); } +/** Start a job to examine our content file */ void Film::examine_content () { @@ -307,6 +308,7 @@ Film::audio_files () const return f; } +/** Start a job to send our DCP to the configured TMS */ void Film::send_dcp_to_tms () { @@ -322,6 +324,9 @@ Film::copy_from_dvd () JobManager::instance()->add (j); } +/** Count the number of frames that have been encoded for this film. + * @return frame count. + */ int Film::encoded_frames () const { @@ -338,6 +343,11 @@ Film::encoded_frames () const return N; } +/** Return the filename of a subtitle image if one exists for a given thumb index. + * @param Thumbnail index. + * @return Position of the image within the source frame, and the image filename, if one exists. + * Otherwise the filename will be empty. + */ pair<Position, string> Film::thumb_subtitle (int n) const { diff --git a/src/lib/film_state.cc b/src/lib/film_state.cc index d992b777c..82d492b9a 100644 --- a/src/lib/film_state.cc +++ b/src/lib/film_state.cc @@ -45,9 +45,7 @@ using namespace std; using namespace boost; -/** Write state to a stream. - * @param f Stream to write to. - */ +/** Write state to our `metadata' file */ void FilmState::write_metadata () const { @@ -134,10 +132,7 @@ FilmState::write_metadata () const _dirty = false; } -/** Read state from a key / value pair. - * @param k Key. - * @param v Value. - */ +/** Read state from our metadata file */ void FilmState::read_metadata () { |