summaryrefslogtreecommitdiff
path: root/src/window_gui.h
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2009-11-29 21:27:12 +0000
committeralberth <alberth@openttd.org>2009-11-29 21:27:12 +0000
commitccd7399ea0d290edb5734f572edefd596a629e19 (patch)
treec29c5b26446319491191b636b71650c0dc6a173c /src/window_gui.h
parentf2f9ef7a9f72efb5bc1f0011f9e3f08011a0989e (diff)
downloadopenttd-ccd7399ea0d290edb5734f572edefd596a629e19.tar.xz
(svn r18348) -Doc: Doxygen fixes, and removal of an old @note.
Diffstat (limited to 'src/window_gui.h')
-rw-r--r--src/window_gui.h6
1 files changed, 2 insertions, 4 deletions
diff --git a/src/window_gui.h b/src/window_gui.h
index 4e327a3c4..15107e424 100644
--- a/src/window_gui.h
+++ b/src/window_gui.h
@@ -547,8 +547,6 @@ public:
* @param sm_height Smallest height of the window.
* @param window_number The window number of the new window.
* @return Initial position of the top-left corner of the window.
- *
- * @note Due to the way C++ works, only windows with nested widgets can usefully override this function.
*/
virtual Point OnInitialPosition(const WindowDesc *desc, int16 sm_width, int16 sm_height, int window_number);
@@ -602,14 +600,14 @@ public:
* A key has been pressed.
* @param key the Unicode value of the key.
* @param keycode the untranslated key code including shift state.
- * @return ES_HANDLED if the key press has been handled and no other
+ * @return #ES_HANDLED if the key press has been handled and no other
* window should receive the event.
*/
virtual EventState OnKeyPress(uint16 key, uint16 keycode) { return ES_NOT_HANDLED; }
/**
* The state of the control key has changed
- * @return ES_HANDLED if the change has been handled and no other
+ * @return #ES_HANDLED if the change has been handled and no other
* window should receive the event.
*/
virtual EventState OnCTRLStateChange() { return ES_NOT_HANDLED; }