diff src/main_gui.cpp @ 16310:cced8cded106 draft

(svn r21018) -Doc: Add Doxygen comments to some function.
author alberth <alberth@openttd.org>
date Sat, 23 Oct 2010 18:28:20 +0000
parents 96db4d85ff89
children e73c78393547
line wrap: on
line diff
--- a/src/main_gui.cpp
+++ b/src/main_gui.cpp
@@ -128,8 +128,13 @@
 #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;