diff --git a/src/basecamp.h b/src/basecamp.h index 024a8d091d806..d8dd4aefbc431 100644 --- a/src/basecamp.h +++ b/src/basecamp.h @@ -309,7 +309,7 @@ class basecamp /** * Perform any mix of the three farm tasks. * @param task - * @param omt_trg the overmap pos3 of the farm_ops + * @param omt_tgt the overmap pos3 of the farm_ops * @param op whether to plow, plant, or harvest */ bool farm_return( const std::string &task, const tripoint &omt_tgt, farm_ops op ); diff --git a/src/game.h b/src/game.h index cd57f1dfbc1a7..95fc12ae0d675 100644 --- a/src/game.h +++ b/src/game.h @@ -437,8 +437,8 @@ class game * Revives a corpse at given location. The monster type and some of its properties are * deducted from the corpse. If reviving succeeds, the location is guaranteed to have a * new monster there (see @ref critter_at). - * @param location The place where to put the revived monster. - * @param corpse The corpse item, it must be a valid corpse (see @ref item::is_corpse). + * @param p The place where to put the revived monster. + * @param it The corpse item, it must be a valid corpse (see @ref item::is_corpse). * @return Whether the corpse has actually been redivided. Reviving may fail for many * reasons, including no space to put the monster, corpse being to much damaged etc. * If the monster was revived, the caller should remove the corpse item. diff --git a/src/init.h b/src/init.h index 7b0789aaf639b..be82032f57197 100644 --- a/src/init.h +++ b/src/init.h @@ -145,8 +145,8 @@ class DynamicDataLoader * game should *not* proceed in that case. */ /*@{*/ - void finalize_loaded_data(); void finalize_loaded_data( loading_ui &ui ); + void finalize_loaded_data(); /*@}*/ /** diff --git a/src/input.h b/src/input.h index 35af30fea23e2..18ea09cfb92ff 100644 --- a/src/input.h +++ b/src/input.h @@ -258,7 +258,7 @@ class input_manager * Get the key name associated with the given keyboard keycode. * * @param ch Character code. - * @param input_type Whether the keycode is a gamepad or a keyboard code. + * @param inp_type Whether the keycode is a gamepad or a keyboard code. * @param portable If true, return a language independent and portable name * of the key. This acts as the inverse to get_keyname: * get_keyname(get_keycode(a), , true) == a diff --git a/src/item.h b/src/item.h index 3693b7fa1c648..475402527bdc1 100644 --- a/src/item.h +++ b/src/item.h @@ -349,7 +349,7 @@ class item : public visitable * properties of the @ref itype (if they are visible to the player). The returned string * is already translated and can be *very* long. * @param showtext If true, shows the item description, otherwise only the properties item type. - * @param dump The properties (encapsulated into @ref iteminfo) are added to this vector, + * @param iteminfo The properties (encapsulated into @ref iteminfo) are added to this vector, * the vector can be used to compare them to properties of another item. */ std::string info( bool showtext, std::vector &iteminfo ) const; @@ -361,7 +361,7 @@ class item : public visitable * properties of the @ref itype (if they are visible to the player). The returned string * is already translated and can be *very* long. * @param showtext If true, shows the item description, otherwise only the properties item type. - * @param dump The properties (encapsulated into @ref iteminfo) are added to this vector, + * @param iteminfo The properties (encapsulated into @ref iteminfo) are added to this vector, * the vector can be used to compare them to properties of another item. * @param batch The batch crafting number to multiply data by */ @@ -374,7 +374,7 @@ class item : public visitable * properties of the @ref itype (if they are visible to the player). The returned string * is already translated and can be *very* long. * @param parts controls which parts of the iteminfo to return. - * @param dump The properties (encapsulated into @ref iteminfo) are added to this vector, + * @param info The properties (encapsulated into @ref iteminfo) are added to this vector, * the vector can be used to compare them to properties of another item. * @param batch The batch crafting number to multiply data by */ @@ -728,7 +728,7 @@ class item : public visitable /** * This is part of a workaround so that items don't rot away to nothing if the smoking rack * is outside the reality bubble. - * @param smoking_duration + * @param processing_duration */ void calc_rot_while_processing( time_duration processing_duration ); @@ -736,7 +736,6 @@ class item : public visitable * Update temperature for things like food * Update rot for things that perish * All items that rot also have temperature - * @param temp Temperature at which item is current exposed * @param insulation Amount of insulation item has from surroundings * @param pos The current position * @param carrier The current carrier @@ -926,11 +925,11 @@ class item : public visitable * resistance (to allow hypothetical calculations for gas masks). */ /*@{*/ + int acid_resist( bool to_self = false, int base_env_resist = 0 ) const; + int fire_resist( bool to_self = false, int base_env_resist = 0 ) const; int bash_resist( bool to_self = false ) const; int cut_resist( bool to_self = false ) const; int stab_resist( bool to_self = false ) const; - int acid_resist( bool to_self = false, int base_env_resist = 0 ) const; - int fire_resist( bool to_self = false, int base_env_resist = 0 ) const; /*@}*/ /** @@ -1788,7 +1787,7 @@ class item : public visitable * of that gunmod, the guns range is returned only when the item has no active gunmod. * This function applies to guns and auxiliary gunmods. For other items, 0 is returned. * It includes the range given by the ammo. - * @param u The player that uses the weapon, their strength might affect this. + * @param p The player that uses the weapon, their strength might affect this. * It's optional and can be null. */ int gun_range( const player *p ) const; diff --git a/src/item_factory.h b/src/item_factory.h index 72ba41a45634f..8f4e2d8ebe617 100644 --- a/src/item_factory.h +++ b/src/item_factory.h @@ -95,7 +95,7 @@ class Item_factory * This is intended for inline definitions of item groups, e.g. in monster death drops: * the item group there is embedded into the monster type definition. * @param jsobj The json object to load from. - * @param ident The ident of the item that is to be loaded. + * @param group_id The ident of the item that is to be loaded. * @param subtype The type of the item group, either "collection", "distribution" or "old" * ("old" is a distribution, too). * @throw std::string if the json object contains invalid data. @@ -133,7 +133,7 @@ class Item_factory * Sets the chance of the specified item in the group. * @param group_id Group to add item to * @param item_id Id of item to add to group - * @param weight The relative weight of the item. A value of 0 removes the item from the + * @param chance The relative weight of the item. A value of 0 removes the item from the * group. * @return false if the group doesn't exist. */ diff --git a/src/map.h b/src/map.h index 067eb2e98cae5..89278c42231e2 100644 --- a/src/map.h +++ b/src/map.h @@ -353,7 +353,7 @@ class map * the @ref mapbuffer can not deliver the requested submap (as it does * not exist on disc). * This must be called before the map can be used at all! - * @param p global coordinates of the submap at grid[0]. This + * @param w global coordinates of the submap at grid[0]. This * is in submap coordinates. * @param update_vehicles If true, add vehicles to the vehicle cache. */ diff --git a/src/mission_companion.h b/src/mission_companion.h index 10eb937a49455..c0ba543ede9b8 100644 --- a/src/mission_companion.h +++ b/src/mission_companion.h @@ -49,15 +49,15 @@ class mission_data * @param priority turns the mission key yellow and pushes to front of main tab * @param possible grays the mission key when false and makes it impossible to select */ - void add( const std::string &id, const std::string &name_display = "", - const std::string &text = "" ); - void add_start( const std::string &id, const std::string &name_display, - cata::optional dir, const std::string &text, bool possible = true ); - void add_return( const std::string &id, const std::string &name_display, - cata::optional dir, const std::string &text, bool possible = true ); void add( const std::string &id, const std::string &name_display, cata::optional dir, const std::string &text, bool priority = false, bool possible = true ); + void add_return( const std::string &id, const std::string &name_display, + cata::optional dir, const std::string &text, bool possible = true ); + void add_start( const std::string &id, const std::string &name_display, + cata::optional dir, const std::string &text, bool possible = true ); + void add( const std::string &id, const std::string &name_display = "", + const std::string &text = "" ); }; namespace talk_function diff --git a/src/monster.h b/src/monster.h index 266b0a29ede6a..7ecbfbd4e17b3 100644 --- a/src/monster.h +++ b/src/monster.h @@ -403,8 +403,8 @@ class monster : public Creature /** * Makes monster react to heard sound * - * @param from Location of the sound source - * @param source_volume Volume at the center of the sound source + * @param source Location of the sound source + * @param vol Volume at the center of the sound source * @param distance Distance to sound source (currently just rl_dist) */ void hear_sound( const tripoint &source, int vol, int distance ); diff --git a/src/output.cpp b/src/output.cpp index 654ef2f9fc52d..f943f5fcc1788 100644 --- a/src/output.cpp +++ b/src/output.cpp @@ -1165,8 +1165,7 @@ void draw_tabs( const catacurses::window &w, const std::vector &tab * @param iCurrentLine The starting line or currently selected line out of the iNumLines lines * @param iContentHeight Height of the scrollbar * @param iNumLines Total number of lines - * @param iOffsetY Y drawing offset - * @param iOffsetX X drawing offset + * @param offset Point indicating drawing offset * @param bar_color Default line color * @param bDoNotScrollToEnd True if the last (iContentHeight-1) lines cannot be a start position or be selected * If false, iCurrentLine can be from 0 to iNumLines - 1. diff --git a/src/output.h b/src/output.h index b505296cfa421..b1db894d78c1b 100644 --- a/src/output.h +++ b/src/output.h @@ -250,7 +250,7 @@ int print_scrollable( const catacurses::window &w, int begin_line, const std::st * less than the window width, otherwise the lines will be wrapped by the curses system, which * defeats the purpose of using `foldstring`. * @param base_color The initially used color. This can be overridden using color tags. - * @param mes Actual message to print + * @param text Actual message to print * @param split Character after string is folded * @return The number of lines of the formatted text (after folding). This may be larger than * the height of the window. @@ -280,7 +280,7 @@ inline int fold_and_print( const catacurses::window &w, const point &begin, * The function basically removes all lines before this one and prints the remaining lines * with `fold_and_print`. * @param base_color The initially used color. This can be overridden using color tags. - * @param mes Actual message to print + * @param text Actual message to print * @return Same as `fold_and_print`: the number of lines of the text (after folding). This is * always the same value, regardless of `begin_line`, it can be used to determine the maximal * value for `begin_line`. @@ -306,7 +306,7 @@ inline int fold_and_print_from( const catacurses::window &w, const point &begin, * @param begin The coordinates of line start (curses coordinates) * @param width Maximal width of the printed line, if the text is longer, it is cut off. * @param base_color The initially used color. This can be overridden using color tags. - * @param mes Actual message to print + * @param text Actual message to print */ void trim_and_print( const catacurses::window &w, const point &begin, int width, nc_color base_color, const std::string &text ); diff --git a/src/overmapbuffer.h b/src/overmapbuffer.h index 3eab56ca7b52d..04a5eaafb8bb8 100644 --- a/src/overmapbuffer.h +++ b/src/overmapbuffer.h @@ -212,10 +212,10 @@ class overmapbuffer cata::optional find_camp( const point &p ); /** - * Get all npcs in a area with given radius around (x, y). + * Get all npcs in a area with given radius around given central point. * Only npcs on the given z-level are considered. * Uses square_dist for distance calculation. - * @param x,y,z are submap coordinates. + * @param p Central point in submap coordinates. * @param radius Maximal distance of npc from (x,y). If the npc * is at most this far away from (x,y) it will be returned. * A radius of 0 returns only those npcs that are on the @@ -433,7 +433,7 @@ class overmapbuffer * Intended to be used when you have a special in hand, the desired location and rotation are known * and the special should be directly placed rather than using the overmap's placement algorithm. * @param special The overmap special to place. - * @param location The location to place the overmap special. Absolute overmap terrain coordinates. + * @param p The location to place the overmap special. Absolute overmap terrain coordinates. * @param dir The direction to rotate the overmap special before placement. * @param must_be_unexplored If true, will require that all of the terrains where the special would be * placed are unexplored. diff --git a/src/point.h b/src/point.h index d593ffc4477c3..589d26803d8ab 100644 --- a/src/point.h +++ b/src/point.h @@ -71,7 +71,8 @@ struct point { /** * Rotate point clockwise @param turns times, 90 degrees per turn, * around the center of a rectangle with the dimensions specified - * by @param dim. By default rotates around the origin (0, 0). + * by @param dim + * By default rotates around the origin (0, 0). * NOLINTNEXTLINE(cata-use-named-point-constants) */ point rotate( int turns, const point &dim = { 1, 1 } ) const { assert( turns >= 0 ); diff --git a/src/skill.h b/src/skill.h index 71a6771034ae2..3851ffa9e34ed 100644 --- a/src/skill.h +++ b/src/skill.h @@ -186,10 +186,10 @@ class SkillLevelMap : public std::map * @param context An item to provide context for contextual skills. Can be null. * @return Difference in skills. Positive numbers - exceeds; negative - lacks; empty map - no difference. */ - std::map compare_skill_requirements( - const std::map &req ) const; std::map compare_skill_requirements( const std::map &req, const item &context ) const; + std::map compare_skill_requirements( + const std::map &req ) const; int exceeds_recipe_requirements( const recipe &rec ) const; bool has_recipe_requirements( const recipe &rec ) const; }; diff --git a/src/vehicle.h b/src/vehicle.h index a2cc1efe76ce9..7b49dd1972845 100644 --- a/src/vehicle.h +++ b/src/vehicle.h @@ -689,7 +689,7 @@ class vehicle * assumed to have been already visited! * @param amount An amount of power to traverse with. This is passed back to the visitor, * and reset to the visitor's return value at each step. - * @param visitor A function(vehicle* veh, int amount, int loss) returning int. The function + * @param action A function(vehicle* veh, int amount, int loss) returning int. The function * may do whatever it desires, and may be a lambda (including a capturing lambda). * NB: returning 0 from a visitor will stop traversal immediately! * @return The last visitor's return value. @@ -1078,7 +1078,7 @@ class vehicle /** * Consumes enough fuel by energy content. Does not support cable draining. * @param ftype Type of fuel - * @param energy_w Desired amount of energy of fuel to consume + * @param energy_j Desired amount of energy of fuel to consume * @return Amount of energy actually consumed. May be more or less than energy. */ double drain_energy( const itype_id &ftype, double energy_j );