Mercurial > hg > openttd
changeset 13079:090bac35e7e4 draft
(svn r17579) -Fix: remove doxygen docs for removed parameters, or change @param to @tparam if necessary
author | rubidium <rubidium@openttd.org> |
---|---|
date | Sat, 19 Sep 2009 15:17:47 +0000 |
parents | 854fcab2b59d |
children | 24794bb1e853 |
files | src/blitter/32bpp_optimized.cpp src/core/alloc_func.hpp src/depot_gui.cpp src/economy.cpp src/newgrf_industries.cpp src/osk_gui.cpp src/rail_gui.cpp src/rail_map.h src/road_cmd.cpp src/saveload/afterload.cpp src/settings.cpp src/smallmap_gui.cpp src/spritecache.cpp src/station_cmd.cpp src/strings_func.h src/terraform_cmd.cpp src/town_cmd.cpp src/widget.cpp |
diffstat | 18 files changed, 15 insertions(+), 31 deletions(-) [+] |
line wrap: on
line diff
--- a/src/blitter/32bpp_optimized.cpp +++ b/src/blitter/32bpp_optimized.cpp @@ -21,7 +21,7 @@ /** * 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 */
--- a/src/core/alloc_func.hpp +++ b/src/core/alloc_func.hpp @@ -27,7 +27,7 @@ * 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 @@ * 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 @@ * 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.
--- a/src/depot_gui.cpp +++ b/src/depot_gui.cpp @@ -262,8 +262,7 @@ } /** 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 */
--- a/src/economy.cpp +++ b/src/economy.cpp @@ -989,7 +989,6 @@ /** * 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),
--- a/src/newgrf_industries.cpp +++ b/src/newgrf_industries.cpp @@ -156,7 +156,6 @@ * @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) {
--- a/src/osk_gui.cpp +++ b/src/osk_gui.cpp @@ -534,8 +534,6 @@ /** * 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)
--- a/src/rail_gui.cpp +++ b/src/rail_gui.cpp @@ -636,7 +636,6 @@ /** 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 @@ /** * 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);
--- a/src/rail_map.h +++ b/src/rail_map.h @@ -368,7 +368,7 @@ /** * 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) {
--- a/src/road_cmd.cpp +++ b/src/road_cmd.cpp @@ -1269,7 +1269,6 @@ /** * 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)
--- a/src/saveload/afterload.cpp +++ b/src/saveload/afterload.cpp @@ -61,7 +61,6 @@ * 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)
--- a/src/settings.cpp +++ b/src/settings.cpp @@ -1492,10 +1492,8 @@ /** 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 @@ /** 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];
--- a/src/smallmap_gui.cpp +++ b/src/smallmap_gui.cpp @@ -647,9 +647,6 @@ * <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) {
--- a/src/spritecache.cpp +++ b/src/spritecache.cpp @@ -493,7 +493,6 @@ * 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 */
--- a/src/station_cmd.cpp +++ b/src/station_cmd.cpp @@ -863,7 +863,7 @@ /** * 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
--- a/src/strings_func.h +++ b/src/strings_func.h @@ -59,7 +59,6 @@ /** * 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. */
--- a/src/terraform_cmd.cpp +++ b/src/terraform_cmd.cpp @@ -149,7 +149,7 @@ * @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) {
--- a/src/town_cmd.cpp +++ b/src/town_cmd.cpp @@ -1486,7 +1486,6 @@ * @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 */
--- a/src/widget.cpp +++ b/src/widget.cpp @@ -2356,7 +2356,7 @@ * @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) {