summaryrefslogtreecommitdiff
path: root/src/vertical_reference.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2020-02-13 22:19:52 +0100
committerCarl Hetherington <cth@carlh.net>2020-02-14 00:25:35 +0100
commit4361a0b95f27ac36a00bdb0b28eca4e8a8c1763c (patch)
treee0696b78d7ece34d4ac2b4609d7d9e719ca8311b /src/vertical_reference.h
parent1b0d3a25622031bff3c0dce186d5901c27ddfdcf (diff)
Clarify meaning of horizontal and vertical references.
Diffstat (limited to 'src/vertical_reference.h')
-rw-r--r--src/vertical_reference.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/vertical_reference.h b/src/vertical_reference.h
index ca079cb..27c4ca4 100644
--- a/src/vertical_reference.h
+++ b/src/vertical_reference.h
@@ -26,11 +26,11 @@ namespace sub {
enum VerticalReference
{
- /** distance is from the top of the screen, positive moves down */
+ /** distance is from the top of the screen to the top of the subtitle, positive moves down */
TOP_OF_SCREEN,
- /** distance is from the centre of the screen, positive moves down */
+ /** 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, positive moves up */
+ /** 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