(svn r17942) -Documentation: Add a few doxygen comments to the dropdown code.

1 files changed, 11 insertions, 1 deletions

diff --git a/src/widgets/dropdown.cpp b/src/widgets/dropdown.cpp
index 8123554b5..094e431e4 100644
--- a/src/widgets/dropdown.cpp
+++ b/src/widgets/dropdown.cpp
@@ -87,7 +87,7 @@ struct DropdownWindow : Window {
 	WindowNumber parent_wnd_num;  ///< Parent window number.
 	byte parent_button;           ///< Parent widget number where the window is dropped from.
 	DropDownList *list;
-	int selected_index;
+	int selected_index;           ///< Index of the selected item in the list.
 	byte click_delay;
 	bool drag_mode;
 	bool instant_close;
@@ -380,6 +380,16 @@ void ShowDropDownList(Window *w, DropDownList *list, int selected, int button, u
 	dw->instant_close    = instant_close;
 }
 
+/** Show a dropdown menu window near a widget of the parent window.
+ * The result code of the items is their index in the #strings list.
+ * @param w             Parent window that wants the dropdown menu.
+ * @param strings       Menu list, end with #INVALID_STRING_ID
+ * @param selected      Index of initial selected item.
+ * @param button        Button widget number of the parent window #w that wants the dropdown menu.
+ * @param disabled_mask Bitmask for diabled items (items with their bit set are not copied to the dropdown list).
+ * @param hidden_mask   Bitmask for hidden items (items with their bit set are displayed, but not selectable in the dropdown list).
+ * @param width         Width of the dropdown menu. If \c 0, use the width of parent widget #button.
+ */
 void ShowDropDownMenu(Window *w, const StringID *strings, int selected, int button, uint32 disabled_mask, uint32 hidden_mask, uint width)
 {
 	uint result = 0;