# HG changeset patch # User alberth # Date 2010-05-30 13:16:51 # Node ID 520036c6c1044386bd9abfda2dbca67e1660a1bc # Parent ccfbc4196c34b7636511dba1e7b971a5089e6a6b (svn r19910) -Doc: Doxygen additions. diff --git a/src/settings.cpp b/src/settings.cpp --- a/src/settings.cpp +++ b/src/settings.cpp @@ -1464,6 +1464,10 @@ void SaveToConfig() delete ini; } +/** + * Get the list of known NewGrf presets. + * @param list[inout] Pointer to list for storing the preset names. + */ void GetGRFPresetList(GRFPresetList *list) { list->Clear(); @@ -1479,6 +1483,12 @@ void GetGRFPresetList(GRFPresetList *lis delete ini; } +/** + * Load a NewGRF configuration by preset-name. + * @param config_name Name of the preset. + * @return NewGRF configuration. + * @see GetGRFPresetList + */ GRFConfig *LoadGRFPresetFromConfig(const char *config_name) { char *section = (char*)alloca(strlen(config_name) + 8); @@ -1491,6 +1501,12 @@ GRFConfig *LoadGRFPresetFromConfig(const return config; } +/** + * Save a NewGRF configuration with a preset name. + * @param config_name Name of the preset. + * @param config NewGRF configuration to save. + * @see GetGRFPresetList + */ void SaveGRFPresetToConfig(const char *config_name, GRFConfig *config) { char *section = (char*)alloca(strlen(config_name) + 8); @@ -1502,6 +1518,10 @@ void SaveGRFPresetToConfig(const char *c delete ini; } +/** + * Delete a NewGRF configuration by preset name. + * @param config_name Name of the preset. + */ void DeleteGRFPresetFromConfig(const char *config_name) { char *section = (char*)alloca(strlen(config_name) + 8); diff --git a/src/window.cpp b/src/window.cpp --- a/src/window.cpp +++ b/src/window.cpp @@ -56,8 +56,8 @@ int _scrollbar_start_pos; int _scrollbar_size; byte _scroller_click_timeout; -bool _scrolling_scrollbar; -bool _scrolling_viewport; +bool _scrolling_scrollbar; ///< A scrollbar is being scrolled with the mouse. +bool _scrolling_viewport; ///< A viewport is being scrolled with the mouse. SpecialMouseMode _special_mouse_mode; ///< Mode of the mouse.