From: Carl Hetherington <cth@carlh.net>
Date: Fri, 8 Feb 2013 12:54:15 +0000 (+0000)
Subject: Some comments.
X-Git-Tag: v2.0.48~1337^2~690
X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=commitdiff_plain;h=567abac0d7824f27b8fdcd6fb7da7e5ddae62a0f

Some comments.
---

diff --git a/src/lib/encoder.cc b/src/lib/encoder.cc
index 8d8e8c0e4..0c810d12c 100644
--- a/src/lib/encoder.cc
+++ b/src/lib/encoder.cc
@@ -50,9 +50,7 @@ using namespace boost;
 
 int const Encoder::_history_size = 25;
 
-/** @param f Film that we are encoding.
- *  @param o Options.
- */
+/** @param f Film that we are encoding */
 Encoder::Encoder (shared_ptr<Film> f)
 	: _film (f)
 	, _video_frames_in (0)
diff --git a/src/lib/video_decoder.cc b/src/lib/video_decoder.cc
index 0fa16bc32..c11b752ae 100644
--- a/src/lib/video_decoder.cc
+++ b/src/lib/video_decoder.cc
@@ -53,6 +53,10 @@ VideoDecoder::emit_video (shared_ptr<Image> image, double t)
 	_last_source_time = t;
 }
 
+/** Called by subclasses to repeat the last video frame that we
+ *  passed to emit_video().  If emit_video hasn't yet been called,
+ *  we will generate a black frame.
+ */
 void
 VideoDecoder::repeat_last_video ()
 {
@@ -64,6 +68,11 @@ VideoDecoder::repeat_last_video ()
 	signal_video (_last_image, true, _last_subtitle);
 }
 
+/** Emit our signal to say that some video data is ready.
+ *  @param image Video frame.
+ *  @param same true if `image' is the same as the last one we emitted.
+ *  @param sub Subtitle for this frame, or 0.
+ */
 void
 VideoDecoder::signal_video (shared_ptr<Image> image, bool same, shared_ptr<Subtitle> sub)
 {
@@ -75,6 +84,11 @@ VideoDecoder::signal_video (shared_ptr<Image> image, bool same, shared_ptr<Subti
 	_last_subtitle = sub;
 }
 
+/** Set up the current subtitle.  This will be put onto frames that
+ *  fit within its time specification.  s may be 0 to say that there
+ *  is no current subtitle.
+ *  @param s New current subtitle, or 0.
+ */
 void
 VideoDecoder::emit_subtitle (shared_ptr<TimedSubtitle> s)
 {
@@ -86,6 +100,9 @@ VideoDecoder::emit_subtitle (shared_ptr<TimedSubtitle> s)
 	}
 }
 
+/** Set which stream of subtitles we should use from our source.
+ *  @param s Stream to use.
+ */
 void
 VideoDecoder::set_subtitle_stream (shared_ptr<SubtitleStream> s)
 {