Mercurial > hg > openttd

diff src/misc_gui.cpp @ 13404:4f5e54adb480 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(svn r17913) -Documentation: Add doxygen comments to the tooltip window class.
author alberth <alberth@openttd.org>
date Sat, 31 Oct 2009 11:13:31 +0000
parents 04b02b2cfa2b
children 1a0e76851633
line wrap: on
line diff
--- a/src/misc_gui.cpp
+++ b/src/misc_gui.cpp
@@ -782,12 +782,13 @@
 	NWidget(WWT_PANEL, COLOUR_GREY, 0), SetMinimalSize(200, 32), EndContainer(),
 };
 
+/** Window class for displaying a tooltip. */
 struct TooltipsWindow : public Window
 {
-	StringID string_id;
-	byte paramcount;
-	uint64 params[5];
-	bool use_left_mouse_button;
+	StringID string_id;         ///< String to display as tooltip.
+	byte paramcount;            ///< Number of string parameters in #string_id.
+	uint64 params[5];           ///< The string parameters.
+	bool use_left_mouse_button; ///< Wait for left mouse button to close window (else, wait for right button).
 
 	TooltipsWindow(int x, int y, int width, int height, const Widget *widget,
 								 StringID str, uint paramcount, const uint64 params[], bool use_left_mouse_button) :