gronod/OpenTTD
1
0
Fork 0
mirror of https://github.com/OpenTTD/OpenTTD.git synced 2025-03-09 23:50:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

(svn r27084) -Doc: Improve documentation of AllocateWindowDescFront.

Browse Source
This commit is contained in:
alberth 2014-12-18 16:50:11 +00:00
parent 43a58ced5c
commit edea2ce96d
3 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/road_gui.cpp
View File

@ -841,7 +841,7 @@ static WindowDesc _build_road_scen_desc(
/** /**
* Show the road building toolbar in the scenario editor. * 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() Window *ShowBuildRoadScenToolbar()
{ {

4
src/terraform_gui.cpp
View File

@ -361,7 +361,7 @@ static WindowDesc _terraform_desc(
/** /**
* Show the toolbar for terraforming in the game. * Show the toolbar for terraforming in the game.
* @param link The toolbar we might want to link to. * @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) Window *ShowTerraformToolbar(Window *link)
{ {
@ -763,7 +763,7 @@ static WindowDesc _scen_edit_land_gen_desc(
/** /**
* Show the toolbar for terraforming in the scenario editor. * 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() Window *ShowEditorTerraformToolbar()
{ {

3
src/window_gui.h
View File

@ -848,9 +848,10 @@ Window *FindWindowFromPt(int x, int y);
/** /**
* Open a new window. * 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 desc The pointer to the WindowDesc to be created
* @param window_number the window number of the new window * @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> template <typename Wcls>
Wcls *AllocateWindowDescFront(WindowDesc *desc, int window_number) Wcls *AllocateWindowDescFront(WindowDesc *desc, int window_number)