diff options
author | alberth <alberth@openttd.org> | 2009-08-14 18:41:03 +0000 |
---|---|---|
committer | alberth <alberth@openttd.org> | 2009-08-14 18:41:03 +0000 |
commit | 4eb155ccfb3c50892ad9c19d07921880851d943c (patch) | |
tree | ad77425831c3d4e2295d803dc62d0649a3fc4b2a /src/widgets | |
parent | ab9995ddbce4c5743842f0703abb3f9288371222 (diff) | |
download | openttd-4eb155ccfb3c50892ad9c19d07921880851d943c.tar.xz |
(svn r17171) -Doc: Additions and corrections of various doxygen strings.
Diffstat (limited to 'src/widgets')
-rw-r--r-- | src/widgets/dropdown.cpp | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/src/widgets/dropdown.cpp b/src/widgets/dropdown.cpp index 447f64a35..012adf604 100644 --- a/src/widgets/dropdown.cpp +++ b/src/widgets/dropdown.cpp @@ -77,9 +77,9 @@ static const NWidgetPart _nested_dropdown_menu_widgets[] = { }; struct DropdownWindow : Window { - WindowClass parent_wnd_class; - WindowNumber parent_wnd_num; - byte parent_button; + WindowClass parent_wnd_class; ///< Parent window class. + WindowNumber parent_wnd_num; ///< Parent window number. + byte parent_button; ///< Parent widget number where the window is dropped from. DropDownList *list; int selected_index; byte click_delay; @@ -388,6 +388,7 @@ void ShowDropDownMenu(Window *w, const StringID *strings, int selected, int butt /** * Delete the drop-down menu from window \a pw * @param pw Parent window of the drop-down menu window + * @return Parent widget number if the drop-down was found and closed, \c -1 if the window was not found. */ int HideDropDownMenu(Window *pw) { |