diff options
| -rw-r--r-- | src/blitter/32bpp_optimized.cpp | 2 | ||||
| -rw-r--r-- | src/core/alloc_func.hpp | 6 | ||||
| -rw-r--r-- | src/depot_gui.cpp | 3 | ||||
| -rw-r--r-- | src/economy.cpp | 1 | ||||
| -rw-r--r-- | src/newgrf_industries.cpp | 1 | ||||
| -rw-r--r-- | src/osk_gui.cpp | 2 | ||||
| -rw-r--r-- | src/rail_gui.cpp | 5 | ||||
| -rw-r--r-- | src/rail_map.h | 2 | ||||
| -rw-r--r-- | src/road_cmd.cpp | 1 | ||||
| -rw-r--r-- | src/saveload/afterload.cpp | 1 | ||||
| -rw-r--r-- | src/settings.cpp | 10 | ||||
| -rw-r--r-- | src/smallmap_gui.cpp | 3 | ||||
| -rw-r--r-- | src/spritecache.cpp | 1 | ||||
| -rw-r--r-- | src/station_cmd.cpp | 2 | ||||
| -rw-r--r-- | src/strings_func.h | 1 | ||||
| -rw-r--r-- | src/terraform_cmd.cpp | 2 | ||||
| -rw-r--r-- | src/town_cmd.cpp | 1 | ||||
| -rw-r--r-- | src/widget.cpp | 2 |
18 files changed, 15 insertions, 31 deletions
diff --git a/src/blitter/32bpp_optimized.cpp b/src/blitter/32bpp_optimized.cpp index da38560ab..9c42b6a44 100644 --- a/src/blitter/32bpp_optimized.cpp +++ b/src/blitter/32bpp_optimized.cpp @@ -21,7 +21,7 @@ static FBlitter_32bppOptimized iFBlitter_32bppOptimized; /** * Draws a sprite to a (screen) buffer. It is templated to allow faster operation. * - * @param mode blitter mode + * @tparam mode blitter mode * @param bp further blitting parameters * @param zoom zoom level at which we are drawing */ diff --git a/src/core/alloc_func.hpp b/src/core/alloc_func.hpp index e86a34763..5268803e8 100644 --- a/src/core/alloc_func.hpp +++ b/src/core/alloc_func.hpp @@ -27,7 +27,7 @@ void NORETURN ReallocError(size_t size); * type. * @note throws an error when there is no memory anymore. * @note the memory contains garbage data (i.e. possibly non-zero values). - * @param T the type of the variable(s) to allocation. + * @tparam T the type of the variable(s) to allocation. * @param num_elements the number of elements to allocate of the given type. * @return NULL when num_elements == 0, non-NULL otherwise. */ @@ -52,7 +52,7 @@ static FORCEINLINE T *MallocT(size_t num_elements) * type. * @note throws an error when there is no memory anymore. * @note the memory contains all zero values. - * @param T the type of the variable(s) to allocation. + * @tparam T the type of the variable(s) to allocation. * @param num_elements the number of elements to allocate of the given type. * @return NULL when num_elements == 0, non-NULL otherwise. */ @@ -77,7 +77,7 @@ static FORCEINLINE T *CallocT(size_t num_elements) * type. It extends/shrinks the memory allocation given in t_ptr. * @note throws an error when there is no memory anymore. * @note the pointer to the data may change, but the data will remain valid. - * @param T the type of the variable(s) to allocation. + * @tparam T the type of the variable(s) to allocation. * @param t_ptr the previous allocation to extend/shrink. * @param num_elements the number of elements to allocate of the given type. * @return NULL when num_elements == 0, non-NULL otherwise. diff --git a/src/depot_gui.cpp b/src/depot_gui.cpp index 9dba83ad4..60365f7ae 100644 --- a/src/depot_gui.cpp +++ b/src/depot_gui.cpp @@ -262,8 +262,7 @@ struct DepotWindow : Window { } /** Draw a vehicle in the depot window in the box with the top left corner at x,y - * @param *w Window to draw in - * @param *v Vehicle to draw + * @param v Vehicle to draw * @param x Left side of the box to draw in * @param y Top of the box to draw in */ diff --git a/src/economy.cpp b/src/economy.cpp index 10be114e2..ccb673bd5 100644 --- a/src/economy.cpp +++ b/src/economy.cpp @@ -989,7 +989,6 @@ static void TriggerIndustryProduction(Industry *i) /** * Makes us a new cargo payment helper. * @param front The front of the train - * @param destinations List to add the destinations of 'our' cargo to */ CargoPayment::CargoPayment(Vehicle *front) : front(front), diff --git a/src/newgrf_industries.cpp b/src/newgrf_industries.cpp index 9dd2e56d3..1be3ee64e 100644 --- a/src/newgrf_industries.cpp +++ b/src/newgrf_industries.cpp @@ -156,7 +156,6 @@ static uint32 GetCountAndDistanceOfClosestInstance(byte param_setID, byte layout * @param variable that is queried * @param parameter unused * @param available will return false if ever the variable asked for does not exist - * @param ind is of course the industry we are inquiring * @return the value stored in the corresponding variable*/ uint32 IndustryGetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available) { diff --git a/src/osk_gui.cpp b/src/osk_gui.cpp index e209ed1a6..ce6d343a9 100644 --- a/src/osk_gui.cpp +++ b/src/osk_gui.cpp @@ -534,8 +534,6 @@ void GetKeyboardLayout() /** * Show the on-screen keyboard (osk) associated with a given textbox * @param parent pointer to the Window where this keyboard originated from - * @param q querystr_d pointer to the query string of the parent, which is - * shared for both windows * @param button widget number of parent's textbox * @param cancel widget number of parent's cancel button (0 if cancel events * should not be passed) diff --git a/src/rail_gui.cpp b/src/rail_gui.cpp index 7822338b1..282154a19 100644 --- a/src/rail_gui.cpp +++ b/src/rail_gui.cpp @@ -636,7 +636,6 @@ struct BuildRailToolbarWindow : Window { /** Configures the rail toolbar for railtype given * @param railtype the railtype to display - * @param w the window to modify */ void SetupRailToolbar(RailType railtype) { @@ -1933,10 +1932,10 @@ static void SetDefaultRailGui() /** * Updates the current signal variant used in the signal GUI * to the one adequate to current year. - * @param 0 needed to be called when a setting changes + * @param p needed to be called when a setting changes * @return success, needed for settings */ -bool ResetSignalVariant(int32 = 0) +bool ResetSignalVariant(int32 p = 0) { SignalVariant new_variant = (_cur_year < _settings_client.gui.semaphore_build_before ? SIG_SEMAPHORE : SIG_ELECTRIC); diff --git a/src/rail_map.h b/src/rail_map.h index 5a203aa2b..f9cca02f0 100644 --- a/src/rail_map.h +++ b/src/rail_map.h @@ -368,7 +368,7 @@ static inline void SetSignalStates(TileIndex tile, uint state) /** * Set the states of the signals (Along/AgainstTrackDir) * @param tile the tile to set the states for - * @param state the new state + * @return the state of the signals */ static inline uint GetSignalStates(TileIndex tile) { diff --git a/src/road_cmd.cpp b/src/road_cmd.cpp index 3b859c6db..b3e8e4889 100644 --- a/src/road_cmd.cpp +++ b/src/road_cmd.cpp @@ -1269,7 +1269,6 @@ void DrawRoadDepotSprite(int x, int y, DiagDirection dir, RoadType rt) /** * Updates cached nearest town for all road tiles * @param invalidate are we just invalidating cached data? - * @param ignore town that should be ignored (because we are deleting it now) * @pre invalidate == true implies _generating_world == true */ void UpdateNearestTownForRoadTiles(bool invalidate) diff --git a/src/saveload/afterload.cpp b/src/saveload/afterload.cpp index b1d2625d5..0124740ba 100644 --- a/src/saveload/afterload.cpp +++ b/src/saveload/afterload.cpp @@ -61,7 +61,6 @@ extern void InitializeRailGUI(); * This as for example docks and shipdepots do not store * whether the tile used to be canal or 'normal' water. * @param t the tile to change. - * @param o the owner of the new tile. * @param include_invalid_water_class Also consider WATER_CLASS_INVALID, i.e. industry tiles on land */ void SetWaterClassDependingOnSurroundings(TileIndex t, bool include_invalid_water_class) diff --git a/src/settings.cpp b/src/settings.cpp index ac01cfd30..ba7cec8ad 100644 --- a/src/settings.cpp +++ b/src/settings.cpp @@ -1492,10 +1492,8 @@ CommandCost CmdChangeCompanySetting(TileIndex tile, DoCommandFlag flags, uint32 /** Top function to save the new value of an element of the Settings struct * @param index offset in the SettingDesc array of the Settings struct which * identifies the setting member we want to change - * @param object pointer to a valid settings struct that has its settings change. - * This only affects setting-members that are not needed to be the same on all - * clients in a network game. - * @param value new value of the setting */ + * @param value new value of the setting + */ bool SetSettingValue(uint index, int32 value) { const SettingDesc *sd = &_settings[index]; @@ -1526,8 +1524,8 @@ bool SetSettingValue(uint index, int32 value) /** Top function to save the new value of an element of the Settings struct * @param index offset in the SettingDesc array of the CompanySettings struct * which identifies the setting member we want to change - * @param object pointer to a valid CompanySettings struct that has its settings changed. - * @param value new value of the setting */ + * @param value new value of the setting + */ void SetCompanySetting(uint index, int32 value) { const SettingDesc *sd = &_company_settings[index]; diff --git a/src/smallmap_gui.cpp b/src/smallmap_gui.cpp index 7e1757005..850f92933 100644 --- a/src/smallmap_gui.cpp +++ b/src/smallmap_gui.cpp @@ -647,9 +647,6 @@ public: * <li>Town names (optional)</li></ol> * * @param dpi pointer to pixel to write onto - * @param w pointer to Window struct - * @param type type of map requested (vegetation, owners, routes, etc) - * @param show_towns true if the town names should be displayed, false if not. */ void DrawSmallMap(DrawPixelInfo *dpi) { diff --git a/src/spritecache.cpp b/src/spritecache.cpp index b139573a2..991347552 100644 --- a/src/spritecache.cpp +++ b/src/spritecache.cpp @@ -493,7 +493,6 @@ void *AllocSprite(size_t mem_req) * For ST_FONT sprites, it is normal. In other cases, default sprite is loaded instead. * @param sprite ID of loaded sprite * @param requested requested sprite type - * @param available available sprite type * @param sc the currently known sprite cache for the requested sprite * @return fallback sprite * @note this function will do usererror() in the case the fallback sprite isn't available */ diff --git a/src/station_cmd.cpp b/src/station_cmd.cpp index 5cbc4a4fd..2c4cb14df 100644 --- a/src/station_cmd.cpp +++ b/src/station_cmd.cpp @@ -863,7 +863,7 @@ void GetStationLayout(byte *layout, int numtracks, int plat_len, const StationSp /** * Find a nearby station that joins this station. * @tparam T the class to find a station for - * @param error_message the error message when building a station on top of others + * @tparam error_message the error message when building a station on top of others * @param existing_station an existing station we build over * @param station_to_join the station to join to * @param adjacent whether adjacent stations are allowed diff --git a/src/strings_func.h b/src/strings_func.h index bbf1739b1..1cc286f0d 100644 --- a/src/strings_func.h +++ b/src/strings_func.h @@ -59,7 +59,6 @@ static inline uint64 GetDParamX(const uint64 *s, uint n) /** * Get the current string parameter at index \a n from the global string parameter array. - * @param s Array of string parameters. * @param n Index of the string parameter. * @return Value of the requested string parameter. */ diff --git a/src/terraform_cmd.cpp b/src/terraform_cmd.cpp index d569b15b9..9270592fd 100644 --- a/src/terraform_cmd.cpp +++ b/src/terraform_cmd.cpp @@ -149,7 +149,7 @@ static void TerraformAddDirtyTileAround(TerraformerState *ts, TileIndex tile) * @param ts TerraformerState. * @param tile Tile. * @param height Aimed height. - * @param return Error code or cost. + * @return Error code or cost. */ static CommandCost TerraformTileHeight(TerraformerState *ts, TileIndex tile, int height) { diff --git a/src/town_cmd.cpp b/src/town_cmd.cpp index a4e9d27be..aa935d2da 100644 --- a/src/town_cmd.cpp +++ b/src/town_cmd.cpp @@ -1486,7 +1486,6 @@ void UpdateTownMaxPass(Town *t) * @param tile Where to put it * @param townnameparts The town name * @param size Parameter for size determination - * @param size_mode How the size should be determined * @param city whether to build a city or town * @param layout the (road) layout of the town */ diff --git a/src/widget.cpp b/src/widget.cpp index 3108409ea..c84269ce1 100644 --- a/src/widget.cpp +++ b/src/widget.cpp @@ -2356,7 +2356,7 @@ Scrollbar *NWidgetLeaf::FindScrollbar(Window *w, bool allow_next) * @param pt Point in the widget. * @return The point refers to the button. * - * @param The magic constants are also used at #DrawButtonDropdown. + * @note The magic constants are also used at #DrawButtonDropdown. */ bool NWidgetLeaf::ButtonHit(const Point &pt) { |