Merge.

[libsub.git] / src / vertical_reference.h

diff --git a/src/vertical_reference.h b/src/vertical_reference.h
index 4bdcde85e3390df06903cc59a691a859db74f9e3..27c4ca4b7fbd3c828509b0fdc578b285e7846b01 100644 (file)
--- a/src/vertical_reference.h
+++ b/src/vertical_reference.h
@@ -26,14 +26,20 @@ namespace sub {
 
 enum VerticalReference
 {
+       /** distance is from the top of the screen to the top of the subtitle, positive moves down */
        TOP_OF_SCREEN,
-       CENTRE_OF_SCREEN,
+       /** distance is from the centre of the screen to the centre of the subtitle, positive moves down */
+       VERTICAL_CENTRE_OF_SCREEN,
+       /** distance is from the bottom of the screen to the bottom of the subtitle, positive moves up */
        BOTTOM_OF_SCREEN,
+       /** position on screen is not known, so we are referring
+        *  to the top of the subtitle; positive distances move down from there
+        */
        TOP_OF_SUBTITLE
 };
 
 VerticalReference string_to_vertical_reference (std::string s);
-       
+
 }
 
 #endif