summaryrefslogtreecommitdiff
path: root/src/viewport_type.h
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2010-10-23 18:28:20 +0000
committeralberth <alberth@openttd.org>2010-10-23 18:28:20 +0000
commit8f24ec94717ec7de4d2483e3c8eb8f0f042f9b5c (patch)
treef7a796a9b22b34694d4b97710efe3a4b3304a067 /src/viewport_type.h
parentaf941fc5983e8bb204183247a7b89b9049339a8d (diff)
downloadopenttd-8f24ec94717ec7de4d2483e3c8eb8f0f042f9b5c.tar.xz
(svn r21018) -Doc: Add Doxygen comments to some function.
Diffstat (limited to 'src/viewport_type.h')
-rw-r--r--src/viewport_type.h10
1 files changed, 7 insertions, 3 deletions
diff --git a/src/viewport_type.h b/src/viewport_type.h
index 274a29e26..9fbd9279e 100644
--- a/src/viewport_type.h
+++ b/src/viewport_type.h
@@ -51,10 +51,14 @@ struct ViewportSign {
void MarkDirty() const;
};
+/**
+ * Directions of zooming.
+ * @see DoZoomInOutWindow
+ */
enum ZoomStateChange {
- ZOOM_IN = 0,
- ZOOM_OUT = 1,
- ZOOM_NONE = 2, // hack, used to update the button status
+ ZOOM_IN = 0, ///< Zoom in (get more detailed view).
+ ZOOM_OUT = 1, ///< Zoom out (get helicopter view).
+ ZOOM_NONE = 2, ///< Hack, used to update the button status.
};
/**