From edea2ce96d3f00ad16a6efbc9a63f7663f8ef640 Mon Sep 17 00:00:00 2001 From: alberth Date: Thu, 18 Dec 2014 16:50:11 +0000 Subject: [PATCH] (svn r27084) -Doc: Improve documentation of AllocateWindowDescFront. --- src/road_gui.cpp | 2 +- src/terraform_gui.cpp | 4 ++-- 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 7824f1f293..6b23ca631e 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 3642af4e6b..0f41da75df 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 e3314d12b6..5391565606 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 Wcls *AllocateWindowDescFront(WindowDesc *desc, int window_number)