Skip to content

Commit

Permalink
Fixed parameter names in Doxygen comments
Browse files Browse the repository at this point in the history
  • Loading branch information
ZhilkinSerg committed Dec 3, 2019
1 parent fd4a3a0 commit 1a07854
Show file tree
Hide file tree
Showing 15 changed files with 36 additions and 37 deletions.
2 changes: 1 addition & 1 deletion src/basecamp.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 );
Expand Down
4 changes: 2 additions & 2 deletions src/game.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/init.h
Original file line number Diff line number Diff line change
Expand Up @@ -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();
/*@}*/

/**
Expand Down
2 changes: 1 addition & 1 deletion src/input.h
Original file line number Diff line number Diff line change
Expand Up @@ -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:
* <code>get_keyname(get_keycode(a), , true) == a</code>
Expand Down
15 changes: 7 additions & 8 deletions src/item.h
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ class item : public visitable<item>
* 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> &iteminfo ) const;
Expand All @@ -361,7 +361,7 @@ class item : public visitable<item>
* 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
*/
Expand All @@ -374,7 +374,7 @@ class item : public visitable<item>
* 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
*/
Expand Down Expand Up @@ -728,15 +728,14 @@ class item : public visitable<item>
/**
* 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 );

/**
* 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
Expand Down Expand Up @@ -926,11 +925,11 @@ class item : public visitable<item>
* 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;
/*@}*/

/**
Expand Down Expand Up @@ -1788,7 +1787,7 @@ class item : public visitable<item>
* 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;
Expand Down
4 changes: 2 additions & 2 deletions src/item_factory.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/map.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down
12 changes: 6 additions & 6 deletions src/mission_companion.h
Original file line number Diff line number Diff line change
Expand Up @@ -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<point> dir, const std::string &text, bool possible = true );
void add_return( const std::string &id, const std::string &name_display,
cata::optional<point> dir, const std::string &text, bool possible = true );
void add( const std::string &id, const std::string &name_display,
cata::optional<point> 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<point> dir, const std::string &text, bool possible = true );
void add_start( const std::string &id, const std::string &name_display,
cata::optional<point> 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
Expand Down
4 changes: 2 additions & 2 deletions src/monster.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 );
Expand Down
3 changes: 1 addition & 2 deletions src/output.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1165,8 +1165,7 @@ void draw_tabs( const catacurses::window &w, const std::vector<std::string> &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.
Expand Down
6 changes: 3 additions & 3 deletions src/output.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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`.
Expand All @@ -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 );
Expand Down
6 changes: 3 additions & 3 deletions src/overmapbuffer.h
Original file line number Diff line number Diff line change
Expand Up @@ -212,10 +212,10 @@ class overmapbuffer

cata::optional<basecamp *> 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
Expand Down Expand Up @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion src/point.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 );
Expand Down
4 changes: 2 additions & 2 deletions src/skill.h
Original file line number Diff line number Diff line change
Expand Up @@ -186,10 +186,10 @@ class SkillLevelMap : public std::map<skill_id, SkillLevel>
* @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<skill_id, int> compare_skill_requirements(
const std::map<skill_id, int> &req ) const;
std::map<skill_id, int> compare_skill_requirements(
const std::map<skill_id, int> &req, const item &context ) const;
std::map<skill_id, int> compare_skill_requirements(
const std::map<skill_id, int> &req ) const;
int exceeds_recipe_requirements( const recipe &rec ) const;
bool has_recipe_requirements( const recipe &rec ) const;
};
Expand Down
4 changes: 2 additions & 2 deletions src/vehicle.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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 );
Expand Down

0 comments on commit 1a07854

Please sign in to comment.