cpp/openttd-patchpack/source Changeset - r13812:cb6499cc6628

Changeset - r13812:cb6499cc6628

Parent rev.

Child rev.

[Not reviewed]

master

0 1 0

alberth - 15 years ago 2009-11-29 21:27:12
alberth@openttd.org

(svn r18348) -Doc: Doxygen fixes, and removal of an old @note.

1 file changed with 2 insertions and 4 deletions:

src/window_gui.h

0 comments (0 inline, 0 general)

src/window_gui.h

➞

Show inline comments

@@ @@ -544,14 +544,12 @@ public: @@
 	 * Compute the initial position of the window.
 	 * @param *desc         The pointer to the WindowDesc of the window to create.
 	 * @param sm_width      Smallest width of the window.
 	 * @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);
 	/**
 	 * The window must be repainted.
 	 * @note This method should not change any state, it should only use drawing functions.
@@ @@ -599,20 +597,20 @@ public: @@
 	virtual void OnFocusLost() {}
 	/**
 	 * 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; }
 	/**

0 comments (0 inline, 0 general)