(svn r23531) -Codechange: document and rename widgets to be consistent and understandable

src/widgets/ai_widget.h

@@ -13,53 +13,53 @@
 #define WIDGETS_AI_WIDGET_H
 
 /** Widgets of the WC_AI_LIST. */
-enum AIListWindowWidgets {
-	AIL_WIDGET_LIST,             ///< The matrix with all available AIs
-	AIL_WIDGET_SCROLLBAR,        ///< Scrollbar next to the AI list
-	AIL_WIDGET_INFO_BG,          ///< Panel to draw some AI information on
-	AIL_WIDGET_ACCEPT,           ///< Accept button
-	AIL_WIDGET_CANCEL,           ///< Cancel button
+enum AIListWidgets {
+	WID_AIL_LIST,      ///< The matrix with all available AIs.
+	WID_AIL_SCROLLBAR, ///< Scrollbar next to the AI list.
+	WID_AIL_INFO_BG,   ///< Panel to draw some AI information on.
+	WID_AIL_ACCEPT,    ///< Accept button.
+	WID_AIL_CANCEL,    ///< Cancel button.
 };
 
 /** Widgets of the WC_AI_SETTINGS. */
-enum AISettingsWindowWidgets {
-	AIS_WIDGET_BACKGROUND,   ///< Panel to draw the settings on
-	AIS_WIDGET_SCROLLBAR,    ///< Scrollbar to scroll through all settings
-	AIS_WIDGET_ACCEPT,       ///< Accept button
-	AIS_WIDGET_RESET,        ///< Reset button
+enum AISettingsWidgets {
+	WID_AIS_BACKGROUND, ///< Panel to draw the settings on.
+	WID_AIS_SCROLLBAR,  ///< Scrollbar to scroll through all settings.
+	WID_AIS_ACCEPT,     ///< Accept button.
+	WID_AIS_RESET,      ///< Reset button.
 };
 
 /** Widgets of the WC_GAME_OPTIONS (WC_GAME_OPTIONS is also used in others). */
-enum AIConfigWindowWidgets {
-	AIC_WIDGET_BACKGROUND,   ///< Window background
-	AIC_WIDGET_DECREASE,     ///< Decrease the number of AIs
-	AIC_WIDGET_INCREASE,     ///< Increase the number of AIs
-	AIC_WIDGET_NUMBER,       ///< Number of AIs
-	AIC_WIDGET_LIST,         ///< List with currently selected AIs
-	AIC_WIDGET_SCROLLBAR,    ///< Scrollbar to scroll through the selected AIs
-	AIC_WIDGET_MOVE_UP,      ///< Move up button
-	AIC_WIDGET_MOVE_DOWN,    ///< Move down button
-	AIC_WIDGET_CHANGE,       ///< Select another AI button
-	AIC_WIDGET_CONFIGURE,    ///< Change AI settings button
-	AIC_WIDGET_CLOSE,        ///< Close window button
-	AIC_WIDGET_CONTENT_DOWNLOAD, ///< Download content button
+enum AIConfigWidgets {
+	WID_AIC_BACKGROUND,       ///< Window background.
+	WID_AIC_DECREASE,         ///< Decrease the number of AIs.
+	WID_AIC_INCREASE,         ///< Increase the number of AIs.
+	WID_AIC_NUMBER,           ///< Number of AIs.
+	WID_AIC_LIST,             ///< List with currently selected AIs.
+	WID_AIC_SCROLLBAR,        ///< Scrollbar to scroll through the selected AIs.
+	WID_AIC_MOVE_UP,          ///< Move up button.
+	WID_AIC_MOVE_DOWN,        ///< Move down button.
+	WID_AIC_CHANGE,           ///< Select another AI button.
+	WID_AIC_CONFIGURE,        ///< Change AI settings button.
+	WID_AIC_CLOSE,            ///< Close window button.
+	WID_AIC_CONTENT_DOWNLOAD, ///< Download content button.
 };
 
 /** Widgets of the WC_AI_DEBUG. */
-enum AIDebugWindowWidgets {
-	AID_WIDGET_VIEW,
-	AID_WIDGET_NAME_TEXT,
-	AID_WIDGET_SETTINGS,
-	AID_WIDGET_RELOAD_TOGGLE,
-	AID_WIDGET_LOG_PANEL,
-	AID_WIDGET_SCROLLBAR,
-	AID_WIDGET_COMPANY_BUTTON_START,
-	AID_WIDGET_COMPANY_BUTTON_END = AID_WIDGET_COMPANY_BUTTON_START + MAX_COMPANIES - 1,
-	AID_BREAK_STRING_WIDGETS,
-	AID_WIDGET_BREAK_STR_ON_OFF_BTN,
-	AID_WIDGET_BREAK_STR_EDIT_BOX,
-	AID_WIDGET_MATCH_CASE_BTN,
-	AID_WIDGET_CONTINUE_BTN,
+enum AIDebugWidgets {
+	WID_AID_VIEW,                 ///< The row of company buttons.
+	WID_AID_NAME_TEXT,            ///< Name of the current selected.
+	WID_AID_SETTINGS,             ///< Settings button.
+	WID_AID_RELOAD_TOGGLE,        ///< Reload button.
+	WID_AID_LOG_PANEL,            ///< Panel where the log is in.
+	WID_AID_SCROLLBAR,            ///< Scrollbar of the log pannel.
+	WID_AID_COMPANY_BUTTON_START, ///< Buttons in the VIEW.
+	WID_AID_COMPANY_BUTTON_END = WID_AID_COMPANY_BUTTON_START + MAX_COMPANIES - 1, ///< Last possible button in the VIEW.
+	WID_AID_BREAK_STRING_WIDGETS, ///< The panel to handle the breaking on string.
+	WID_AID_BREAK_STR_ON_OFF_BTN, ///< Enable breaking on string.
+	WID_AID_BREAK_STR_EDIT_BOX,   ///< Edit box for the string to break on.
+	WID_AID_MATCH_CASE_BTN,       ///< Checkbox to use match caching or not.
+	WID_AID_CONTINUE_BTN,         ///< Continue button.
 };
 
 #endif /* WIDGETS_AI_WIDGET_H */