summaryrefslogtreecommitdiff
path: root/src/window_gui.h
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2014-12-18 16:50:11 +0000
committeralberth <alberth@openttd.org>2014-12-18 16:50:11 +0000
commitedea2ce96d3f00ad16a6efbc9a63f7663f8ef640 (patch)
tree41972e1ff80c4d630997b611153e77b51fa54219 /src/window_gui.h
parent43a58ced5c16914a2a59d50e85f2f017e025f8c3 (diff)
downloadopenttd-edea2ce96d3f00ad16a6efbc9a63f7663f8ef640.tar.xz
(svn r27084) -Doc: Improve documentation of AllocateWindowDescFront.
Diffstat (limited to 'src/window_gui.h')
-rw-r--r--src/window_gui.h3
1 files changed, 2 insertions, 1 deletions
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)