diff options
| author | Carl Hetherington <cth@carlh.net> | 2020-02-13 22:19:52 +0100 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2020-02-14 00:25:35 +0100 |
| commit | 4361a0b95f27ac36a00bdb0b28eca4e8a8c1763c (patch) | |
| tree | e0696b78d7ece34d4ac2b4609d7d9e719ca8311b /src | |
| parent | 1b0d3a25622031bff3c0dce186d5901c27ddfdcf (diff) | |
Clarify meaning of horizontal and vertical references.
Diffstat (limited to 'src')
| -rw-r--r-- | src/horizontal_reference.h | 8 | ||||
| -rw-r--r-- | src/vertical_reference.h | 6 |
2 files changed, 7 insertions, 7 deletions
diff --git a/src/horizontal_reference.h b/src/horizontal_reference.h index ffe97fe..d32ff60 100644 --- a/src/horizontal_reference.h +++ b/src/horizontal_reference.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2017 Carl Hetherington <cth@carlh.net> + Copyright (C) 2017-2020 Carl Hetherington <cth@carlh.net> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -26,11 +26,11 @@ namespace sub { enum HorizontalReference { - /** distance is from the left of the screen, positive moves right */ + /** distance is from the left of the screen to the left of the subtitle, positive moves right */ LEFT_OF_SCREEN, - /** distance is from the centre of the screen, positive moves right */ + /** distance is from the centre of the screen to the centre of the subtitle, positive moves right */ HORIZONTAL_CENTRE_OF_SCREEN, - /** distance is from the right of the screen, positive moves left */ + /** distance is from the right of the screen to the right of the subtitle, positive moves left */ RIGHT_OF_SCREEN }; 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 |