Comments.
authorCarl Hetherington <cth@carlh.net>
Thu, 9 Jun 2016 14:26:03 +0000 (15:26 +0100)
committerCarl Hetherington <cth@carlh.net>
Thu, 9 Jun 2016 14:26:03 +0000 (15:26 +0100)
src/vertical_reference.h

index 1ac921b45998b5cd400010dec63cefc69473da9a..91565500a2e53cf8dc5115ace2d758c05fee5eae 100644 (file)
@@ -26,11 +26,14 @@ namespace sub {
 
 enum VerticalReference
 {
+       /** distance is from the top of the screen, positive moves down */
        TOP_OF_SCREEN,
+       /** distance is from the centre of the screen, positive moves down */
        CENTRE_OF_SCREEN,
+       /** distance is from the bottom of the screen, positive moves up */
        BOTTOM_OF_SCREEN,
        /** position on screen is not known, so we are referring
-        *  to the top of the subtitle.
+        *  to the top of the subtitle; positive distances move down from there
         */
        TOP_OF_SUBTITLE
 };