From b1defe9019642dc4b80697291d40ed88f09de8be Mon Sep 17 00:00:00 2001
From: Carl Hetherington <cth@carlh.net>
Date: Sun, 18 Nov 2012 22:46:15 +0000
Subject: Fix mis-alignment of copied AlignedImages; add some asserts; some
 docs.

---
 src/lib/video_source.h | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

(limited to 'src/lib/video_source.h')

diff --git a/src/lib/video_source.h b/src/lib/video_source.h
index de0635ac7..d53589e2e 100644
--- a/src/lib/video_source.h
+++ b/src/lib/video_source.h
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/video_source.h
+ *  @brief Parent class for classes which emit video data.
+ */
+
 #ifndef DVDOMATIC_VIDEO_SOURCE_H
 #define DVDOMATIC_VIDEO_SOURCE_H
 
@@ -28,12 +32,15 @@ class VideoSink;
 class Subtitle;
 class Image;
 
+/** @class VideoSink
+ *  @param A class that emits video data.
+ */
 class VideoSource
 {
 public:
 
 	/** Emitted when a video frame is ready.
-	 *  First parameter is the frame within the source.
+	 *  First parameter is the video image.
 	 *  Second parameter is either 0 or a subtitle that should be on this frame.
 	 */
 	boost::signals2::signal<void (boost::shared_ptr<Image>, boost::shared_ptr<Subtitle>)> Video;
-- 
cgit v1.2.3