(svn r21018) -Doc: Add Doxygen comments to some function.

1 files changed, 7 insertions, 2 deletions

diff --git a/src/main_gui.cpp b/src/main_gui.cpp
index e77a3f250..ec2406366 100644
--- a/src/main_gui.cpp
+++ b/src/main_gui.cpp
@@ -128,8 +128,13 @@ void ShowNetworkGiveMoneyWindow(CompanyID company)
 #endif /* ENABLE_NETWORK */
 
 
-/* Zooms a viewport in a window in or out
- * No button handling or what so ever */
+/**
+ * Zooms a viewport in a window in or out.
+ * @param how Zooming direction.
+ * @param w   Window owning the viewport.
+ * @return Returns \c true if zooming step could be done, \c false if further zooming is not possible.
+ * @note No button handling or what so ever is done.
+ */
 bool DoZoomInOutWindow(ZoomStateChange how, Window *w)
 {
 	ViewPort *vp;