diff options
author | alberth <alberth@openttd.org> | 2010-10-23 18:28:20 +0000 |
---|---|---|
committer | alberth <alberth@openttd.org> | 2010-10-23 18:28:20 +0000 |
commit | 8f24ec94717ec7de4d2483e3c8eb8f0f042f9b5c (patch) | |
tree | f7a796a9b22b34694d4b97710efe3a4b3304a067 /src/main_gui.cpp | |
parent | af941fc5983e8bb204183247a7b89b9049339a8d (diff) | |
download | openttd-8f24ec94717ec7de4d2483e3c8eb8f0f042f9b5c.tar.xz |
(svn r21018) -Doc: Add Doxygen comments to some function.
Diffstat (limited to 'src/main_gui.cpp')
-rw-r--r-- | src/main_gui.cpp | 9 |
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; |