From 8f24ec94717ec7de4d2483e3c8eb8f0f042f9b5c Mon Sep 17 00:00:00 2001
From: alberth <alberth@openttd.org>
Date: Sat, 23 Oct 2010 18:28:20 +0000
Subject: (svn r21018) -Doc: Add Doxygen comments to some function.

---
 src/viewport_type.h | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

(limited to 'src/viewport_type.h')

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.
 };
 
 /**
-- 
cgit v1.2.3-70-g09d2