From dca56d88f34daa66d0df30e966030f84e99b4bea Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Thu, 9 Jun 2016 15:26:03 +0100 Subject: Comments. --- src/vertical_reference.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'src') diff --git a/src/vertical_reference.h b/src/vertical_reference.h index 1ac921b..9156550 100644 --- a/src/vertical_reference.h +++ b/src/vertical_reference.h @@ -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 }; -- cgit v1.2.3