Commenting tweaks.

diff --git a/src/lib/film.cc b/src/lib/film.cc
index 5b21ed3bc7bde2e96db0f6bca290db0562508d61..4ceef17ea43de55d6c83109bbbca7a7d2be6433a 100644 (file)
--- 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 d992b777c68c43f27b8157ee5ed0a27a64e43953..82d492b9aec370bced5d63932b62e71650adad74 100644 (file)
--- 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 ()
 {