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

src/widgets/intro_widget.h

@@ -14,25 +14,25 @@
 
 /** Widgets of the WC_SELECT_GAME. */
 enum SelectGameIntroWidgets {
-	SGI_GENERATE_GAME,
-	SGI_LOAD_GAME,
-	SGI_PLAY_SCENARIO,
-	SGI_PLAY_HEIGHTMAP,
-	SGI_EDIT_SCENARIO,
-	SGI_PLAY_NETWORK,
-	SGI_TEMPERATE_LANDSCAPE,
-	SGI_ARCTIC_LANDSCAPE,
-	SGI_TROPIC_LANDSCAPE,
-	SGI_TOYLAND_LANDSCAPE,
-	SGI_TRANSLATION_SELECTION,
-	SGI_TRANSLATION,
-	SGI_OPTIONS,
-	SGI_DIFFICULTIES,
-	SGI_SETTINGS_OPTIONS,
-	SGI_GRF_SETTINGS,
-	SGI_CONTENT_DOWNLOAD,
-	SGI_AI_SETTINGS,
-	SGI_EXIT,
+	WID_SGI_GENERATE_GAME,         ///< Generate game button.
+	WID_SGI_LOAD_GAME,             ///< Load game button.
+	WID_SGI_PLAY_SCENARIO,         ///< Play scenario button.
+	WID_SGI_PLAY_HEIGHTMAP,        ///< Play heightmap button.
+	WID_SGI_EDIT_SCENARIO,         ///< Edit scenario button.
+	WID_SGI_PLAY_NETWORK,          ///< Play network button.
+	WID_SGI_TEMPERATE_LANDSCAPE,   ///< Select temperate landscape button.
+	WID_SGI_ARCTIC_LANDSCAPE,      ///< Select arctic landscape button.
+	WID_SGI_TROPIC_LANDSCAPE,      ///< Select tropic landscape button.
+	WID_SGI_TOYLAND_LANDSCAPE,     ///< Select toyland landscape button.
+	WID_SGI_TRANSLATION_SELECTION, ///< Translation selection.
+	WID_SGI_TRANSLATION,           ///< Translation.
+	WID_SGI_OPTIONS,               ///< Options button.
+	WID_SGI_DIFFICULTIES,          ///< Difficulties button.
+	WID_SGI_SETTINGS_OPTIONS,      ///< Settings button.
+	WID_SGI_GRF_SETTINGS,          ///< NewGRF button.
+	WID_SGI_CONTENT_DOWNLOAD,      ///< Content Download button.
+	WID_SGI_AI_SETTINGS,           ///< AI button.
+	WID_SGI_EXIT,                  ///< Exit button.
 };
 
 #endif /* WIDGETS_INTRO_WIDGET_H */

src/widgets/main_widget.h

@@ -13,8 +13,8 @@
 #define WIDGETS_MAIN_WIDGET_H
 
 /** Widgets of the WC_MAIN_WINDOW. */
-enum MainWindowWidgets {
-	MW_VIEWPORT, ///< Main window viewport.
+enum MainWidgets {
+	WID_M_VIEWPORT, ///< Main window viewport.
 };
 
 #endif /* WIDGETS_MAIN_WIDGET_H */

src/widgets/misc_widget.h

@@ -14,35 +14,35 @@
 
 /** Widgets of the WC_LAND_INFO. */
 enum LandInfoWidgets {
-	LIW_BACKGROUND, ///< Background to draw on
+	WID_LI_BACKGROUND, ///< Background of the window.
 };
 
 /** Widgets of the WC_TOOLTIPS. */
 enum ToolTipsWidgets {
-	TTW_BACKGROUND, ///< Background to draw on
+	WID_TT_BACKGROUND, ///< Background of the window.
 };
 
 /** Widgets of the WC_GAME_OPTIONS (WC_GAME_OPTIONS is also used in others). */
 enum AboutWidgets {
-	AW_SCROLLING_TEXT,       ///< The actually scrolling text
-	AW_WEBSITE,              ///< URL of OpenTTD website
+	WID_A_SCROLLING_TEXT, ///< The actually scrolling text.
+	WID_A_WEBSITE,        ///< URL of OpenTTD website.
 };
 
 /** Widgets of the WC_QUERY_STRING (WC_QUERY_STRING is also used in QueryEditSignWidgets). */
 enum QueryStringWidgets {
-	QUERY_STR_WIDGET_CAPTION,
-	QUERY_STR_WIDGET_TEXT,
-	QUERY_STR_WIDGET_DEFAULT,
-	QUERY_STR_WIDGET_CANCEL,
-	QUERY_STR_WIDGET_OK
+	WID_QS_CAPTION, ///< Caption of the window.
+	WID_QS_TEXT,    ///< Text of the query.
+	WID_QS_DEFAULT, ///< Default button.
+	WID_QS_CANCEL,  ///< Cancel button.
+	WID_QS_OK       ///< OK button.
 };
 
 /** Widgets of the WC_CONFIRM_POPUP_QUERY (WC_CONFIRM_POPUP_QUERY is also used in BootstrapAskForDownloadWidgets). */
 enum QueryWidgets {
-	QUERY_WIDGET_CAPTION,
-	QUERY_WIDGET_TEXT,
-	QUERY_WIDGET_NO,
-	QUERY_WIDGET_YES
+	WID_Q_CAPTION, ///< Caption of the window.
+	WID_Q_TEXT,    ///< Text of the query.
+	WID_Q_NO,      ///< Yes button.
+	WID_Q_YES      ///< No button.
 };
 
 #endif /* WIDGETS_MISC_WIDGET_H */