diff options
author | alberth <alberth@openttd.org> | 2014-12-18 16:50:11 +0000 |
---|---|---|
committer | alberth <alberth@openttd.org> | 2014-12-18 16:50:11 +0000 |
commit | edea2ce96d3f00ad16a6efbc9a63f7663f8ef640 (patch) | |
tree | 41972e1ff80c4d630997b611153e77b51fa54219 /src | |
parent | 43a58ced5c16914a2a59d50e85f2f017e025f8c3 (diff) | |
download | openttd-edea2ce96d3f00ad16a6efbc9a63f7663f8ef640.tar.xz |
(svn r27084) -Doc: Improve documentation of AllocateWindowDescFront.
Diffstat (limited to 'src')
-rw-r--r-- | src/road_gui.cpp | 2 | ||||
-rw-r--r-- | src/terraform_gui.cpp | 4 | ||||
-rw-r--r-- | src/window_gui.h | 3 |
3 files changed, 5 insertions, 4 deletions
diff --git a/src/road_gui.cpp b/src/road_gui.cpp index 7824f1f29..6b23ca631 100644 --- a/src/road_gui.cpp +++ b/src/road_gui.cpp @@ -841,7 +841,7 @@ static WindowDesc _build_road_scen_desc( /** * Show the road building toolbar in the scenario editor. - * @return The just opened toolbar. + * @return The just opened toolbar, or \c NULL if the toolbar was already open. */ Window *ShowBuildRoadScenToolbar() { diff --git a/src/terraform_gui.cpp b/src/terraform_gui.cpp index 3642af4e6..0f41da75d 100644 --- a/src/terraform_gui.cpp +++ b/src/terraform_gui.cpp @@ -361,7 +361,7 @@ static WindowDesc _terraform_desc( /** * Show the toolbar for terraforming in the game. * @param link The toolbar we might want to link to. - * @return The allocated toolbar. + * @return The allocated toolbar if the window was newly opened, else \c NULL. */ Window *ShowTerraformToolbar(Window *link) { @@ -763,7 +763,7 @@ static WindowDesc _scen_edit_land_gen_desc( /** * Show the toolbar for terraforming in the scenario editor. - * @return The allocated toolbar. + * @return The allocated toolbar if the window was newly opened, else \c NULL. */ Window *ShowEditorTerraformToolbar() { diff --git a/src/window_gui.h b/src/window_gui.h index e3314d12b..539156560 100644 --- a/src/window_gui.h +++ b/src/window_gui.h @@ -848,9 +848,10 @@ Window *FindWindowFromPt(int x, int y); /** * Open a new window. + * @tparam Wcls %Window class to use if the window does not exist. * @param desc The pointer to the WindowDesc to be created * @param window_number the window number of the new window - * @return see Window pointer of the newly created window + * @return %Window pointer of the newly created window, or \c NULL. */ template <typename Wcls> Wcls *AllocateWindowDescFront(WindowDesc *desc, int window_number) |