0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix doc comments

Browse source
This commit is contained in:
gfgtdf 2024-11-12 06:12:54 +01:00 • committed by sevu
parent a5f40c353d
commit d668aea7d0
3 changed files with 5 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
src/actions/create.hpp
View file

@ -184,7 +184,6 @@ void recruit_unit(const unit_type & u_type, int side_num, const map_location & l
* @param loc the location it was recalled onto.
* @param from the location it was recalled from.
* @param facing the desired facing for the unit, map_location::direction::indeterminate to determine facing automatically.
* @param show
* @returns false if the recall could not be found in the team's recall list.
*/
bool recall_unit(const std::string & id, team & current_team,

1
src/actions/move.cpp
View file

@ -1321,7 +1321,6 @@ static void move_unit_internal(unit_mover& mover)
* @param[in] continued_move If set to true, this is a continuation of an earlier move (movement is not
* interrupted should units be spotted).
* @param[in] skip_ally_sighted If set to true, movement is not interrupted should allied units be spotted.
* @param[in] show_move Controls whether or not the movement is animated for the player.
* @param[out] move_spectator If supplied, this will be given the information uncovered by the move and about the
* move
*/

12
src/synced_context.hpp
View file

@ -47,27 +47,25 @@ public:
*
* @param commandname The command to run.
* @param data The data to use with the command.
* @param use_undo This parameter is used to ignore undos during an ai move to optimize.
* @param show
* @param error_handler An error handler for the case that data contains invalid data.
* @param spectator An error handler for the case that data contains invalid data.
*
* @return True if the action was successful.
*/
static bool run(
const std::string& commandname, const config& data, action_spectator& observer = get_default_spectator());
const std::string& commandname, const config& data, action_spectator& spectator = get_default_spectator());
static bool run_and_store(
const std::string& commandname, const config& data, action_spectator& observer = get_default_spectator());
const std::string& commandname, const config& data, action_spectator& spectator = get_default_spectator());
static bool run_and_throw(
const std::string& commandname, const config& data, action_spectator& observer = get_default_spectator());
const std::string& commandname, const config& data, action_spectator& spectator = get_default_spectator());
/**
* Checks whether we are currently running in a synced context, and if not we enters it.
* This is never called from so_replay_handle.
*/
static bool run_in_synced_context_if_not_already(
const std::string& commandname, const config& data, action_spectator& observer = get_default_spectator());
const std::string& commandname, const config& data, action_spectator& spectator = get_default_spectator());
/**
* @return Whether we are currently executing a synced action like recruit, start, recall, disband, movement,