summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2009-10-31 11:13:31 +0000
committeralberth <alberth@openttd.org>2009-10-31 11:13:31 +0000
commit8e7af56d53840399c13c4862b74205a31a68fd64 (patch)
tree24921d50583758429c324170c441a60b44505fc8
parent1be5d92a9c00a5e0a6f365fc05da280cf1adfca0 (diff)
downloadopenttd-8e7af56d53840399c13c4862b74205a31a68fd64.tar.xz
(svn r17913) -Documentation: Add doxygen comments to the tooltip window class.
-rw-r--r--src/misc_gui.cpp9
1 files changed, 5 insertions, 4 deletions
diff --git a/src/misc_gui.cpp b/src/misc_gui.cpp
index 0c113679f..5ffd47f5f 100644
--- a/src/misc_gui.cpp
+++ b/src/misc_gui.cpp
@@ -782,12 +782,13 @@ static const NWidgetPart _nested_tooltips_widgets[] = {
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) :