Codechange: document missing parameters and return values

src/settings.cpp

@@ -77,6 +77,7 @@ static ErrorList _settings_error_list; ///< Errors while loading minimal setting
  * - _company_settings
  * - _win32_settings
  * As such, they are not part of this list.
+ * @return The list of generic settings.
  */
 static auto &GenericSettingTables()
 {
@@ -99,6 +100,7 @@ static auto &GenericSettingTables()
 
 /**
  * List of all the private setting tables.
+ * @return The list of private settings.
  */
 static auto &PrivateSettingTables()
 {
@@ -110,6 +112,7 @@ static auto &PrivateSettingTables()
 
 /**
  * List of all the secrets setting tables.
+ * @return The list of secret settings.
  */
 static auto &SecretSettingTables()
 {
@@ -438,6 +441,7 @@ StringID IntSettingDesc::GetHelp() const
 /**
  * Get parameters for drawing the value of the setting.
  * @param value Setting value to set params for.
+ * @return The string parameters for formatting the value of this setting.
  */
 std::pair<StringParameter, StringParameter> IntSettingDesc::GetValueParams(int32_t value) const
 {
@@ -1000,6 +1004,7 @@ static void GameLoadConfig(const IniFile &ini, std::string_view grpname)
 
 /**
  * Load BaseGraphics set selection and configuration.
+ * @param ini The ini-file to read from.
  */
 static void GraphicsSetLoadConfig(IniFile &ini)
 {
@@ -1052,6 +1057,7 @@ static void GraphicsSetLoadConfig(IniFile &ini)
  * @param ini       The configuration to read from.
  * @param grpname   Group name containing the configuration of the GRF.
  * @param is_static GRF is static.
+ * @return The list of loaded NewGRF configurations.
  */
 static GRFConfigList GRFLoadConfig(const IniFile &ini, std::string_view grpname, bool is_static)
 {
@@ -1226,6 +1232,7 @@ static void SaveVersionInConfig(IniFile &ini)
 
 /**
  * Save BaseGraphics set selection and configuration.
+ * @param ini The ini-file to write to.
  */
 static void GraphicsSetSaveConfig(IniFile &ini)
 {
@@ -1671,6 +1678,7 @@ void GetSaveLoadFromSettingTable(SettingTable settings, std::vector<SaveLoad> &s
 /**
  * Create a single table with all settings that should be stored/loaded
  * in the savegame.
+ * @return The settings that are in save games.
  */
 SettingTable GetSaveLoadSettingTable()
 {
@@ -1810,6 +1818,7 @@ CommandCost CmdChangeCompanySetting(DoCommandFlags flags, const std::string &nam
  * @param sd The SettingDesc we want to change.
  * @param value new value of the setting
  * @param force_newgame force the newgame settings
+ * @return \c true iff the setting was changed.
  */
 bool SetSettingValue(const IntSettingDesc *sd, int32_t value, bool force_newgame)
 {
@@ -1849,6 +1858,7 @@ bool SetSettingValue(const IntSettingDesc *sd, int32_t value, bool force_newgame
 
 /**
  * Set the company settings for a new company to their default values.
+ * @param cid The company to reset the settings for.
  */
 void SetDefaultCompanySettings(CompanyID cid)
 {
@@ -1885,6 +1895,7 @@ void SyncCompanySettings()
  * @param sd the setting to change.
  * @param value the value to write
  * @param force_newgame force the newgame settings
+ * @return \c true iff the setting was changed.
  * @note Strings WILL NOT be synced over the network
  */
 bool SetSettingValue(const StringSettingDesc *sd, std::string_view value, bool force_newgame)