cpp/openttd-patchpack/source Changeset - r21930:fe446f7b57e5

Changeset - r21930:fe446f7b57e5

Parent rev.

Child rev.

[Not reviewed]

master

0 3 0

alberth - 10 years ago 2014-12-18 16:50:11
alberth@openttd.org

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

3 files changed with 5 insertions and 4 deletions:

src/road_gui.cpp

src/terraform_gui.cpp

src/window_gui.h

0 comments (0 inline, 0 general)

src/road_gui.cpp

➞

Show inline comments

@@ @@ -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()
+{

src/terraform_gui.cpp

➞

Show inline comments

@@ @@ -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_de @@
 /**
  * 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()
+{

src/window_gui.h

➞

Show inline comments

@@ @@ -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)

0 comments (0 inline, 0 general)