From 997551c59979ace11e63451a7b81120610354241 Mon Sep 17 00:00:00 2001
From: alberth <alberth@openttd.org>
Date: Sat, 11 Dec 2010 15:14:28 +0000
Subject: (svn r21467) -Doc: Add a few doxygen comments to config file settings
 code.

---
 src/settings_gui.cpp | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

(limited to 'src/settings_gui.cpp')

diff --git a/src/settings_gui.cpp b/src/settings_gui.cpp
index f48411e02..069766520 100644
--- a/src/settings_gui.cpp
+++ b/src/settings_gui.cpp
@@ -60,6 +60,12 @@ static const StringID _autosave_dropdown[] = {
 	INVALID_STRING_ID,
 };
 
+/**
+ * Fill a static array with consecutive stringIDs for use with a drop down.
+ * @param base First stringID.
+ * @param num  Number of stringIDs (must be at most 32).
+ * *return Pointer to the static buffer with stringIDs.
+ */
 static StringID *BuildDynamicDropdown(StringID base, int num)
 {
 	static StringID buf[32 + 1];
@@ -69,10 +75,11 @@ static StringID *BuildDynamicDropdown(StringID base, int num)
 	return buf;
 }
 
-int _nb_orig_names = SPECSTR_TOWNNAME_LAST - SPECSTR_TOWNNAME_START + 1;
-static StringID *_grf_names = NULL;
-static int _nb_grf_names = 0;
+int _nb_orig_names = SPECSTR_TOWNNAME_LAST - SPECSTR_TOWNNAME_START + 1; ///< Number of original town names.
+static StringID *_grf_names = NULL; ///< Pointer to town names defined by NewGRFs.
+static int _nb_grf_names = 0;       ///< Number of town names defined by NewGRFs.
 
+/** Allocate memory for the NewGRF town names. */
 void InitGRFTownGeneratorNames()
 {
 	free(_grf_names);
@@ -81,6 +88,11 @@ void InitGRFTownGeneratorNames()
 	for (StringID *s = _grf_names; *s != INVALID_STRING_ID; s++) _nb_grf_names++;
 }
 
+/**
+ * Get a town name.
+ * @param town_name Number of the wanted town name.
+ * @return Name of the town as string ID.
+ */
 static inline StringID TownName(int town_name)
 {
 	if (town_name < _nb_orig_names) return STR_GAME_OPTIONS_TOWN_NAME_ORIGINAL_ENGLISH + town_name;
@@ -89,6 +101,10 @@ static inline StringID TownName(int town_name)
 	return STR_UNDEFINED;
 }
 
+/**
+ * Get index of the current screen resolution.
+ * @return Index of the current screen resolution if it is a known resolution, #_num_resolutions otherwise.
+ */
 static int GetCurRes()
 {
 	int i;
@@ -532,7 +548,7 @@ static const WindowDesc _game_options_desc(
 	_nested_game_options_widgets, lengthof(_nested_game_options_widgets)
 );
 
-
+/** Open the game options window. */
 void ShowGameOptions()
 {
 	DeleteWindowById(WC_GAME_OPTIONS, 0);
@@ -809,6 +825,7 @@ static const WindowDesc _game_difficulty_desc(
 	_nested_game_difficulty_widgets, lengthof(_nested_game_difficulty_widgets)
 );
 
+/** Open the game-difficulty window. */
 void ShowGameDifficulty()
 {
 	DeleteWindowById(WC_GAME_OPTIONS, 0);
@@ -1719,6 +1736,7 @@ static const WindowDesc _settings_selection_desc(
 	_nested_settings_selection_widgets, lengthof(_nested_settings_selection_widgets)
 );
 
+/** Open advanced settings window. */
 void ShowGameSettings()
 {
 	DeleteWindowById(WC_GAME_OPTIONS, 0);
@@ -1993,6 +2011,7 @@ static const WindowDesc _cust_currency_desc(
 	_nested_cust_currency_widgets, lengthof(_nested_cust_currency_widgets)
 );
 
+/** Open custom currency window. */
 static void ShowCustCurrency()
 {
 	DeleteWindowById(WC_CUSTOM_CURRENCY, 0);
-- 
cgit v1.2.3-54-g00ecf