Fix cases of made-up Doxygen syntax
This commit is contained in:
parent
7fe5437298
commit
1e167aaa66
9 changed files with 29 additions and 19 deletions
|
@ -24,7 +24,7 @@ namespace notifications
|
|||
enum type {CHAT, TURN_CHANGED, OTHER};
|
||||
|
||||
/**
|
||||
* Displays a desktop notification message @message, from @a owner, of type @t.
|
||||
* Displays a desktop notification @a message, from @a owner, of type @a t.
|
||||
*
|
||||
* If it is an appropriate time to send a desktop notification (i.e. the window
|
||||
* does not have focus and the feature is not disabled by the preferences),
|
||||
|
|
|
@ -104,8 +104,9 @@ bool wmi_container::fire_item(const std::string & id, const map_location & hex,
|
|||
/**
|
||||
* Returns the menu items that can be shown for the given location.
|
||||
* Should be used with a wmi_pager to limit the number of items displayed at once.
|
||||
*
|
||||
* @param[out] items Pointers to applicable menu items will be pushed onto @a items.
|
||||
* @param[out] descriptions Menu item text will be pushed onto @descriptions (in the same order as @a items).
|
||||
* @param[out] descriptions Menu item text will be pushed onto @a descriptions (in the same order as @a items).
|
||||
*/
|
||||
std::vector<std::pair<boost::shared_ptr<const wml_menu_item>, std::string> > wmi_container::get_items(const map_location& hex,
|
||||
game_data & gamedata, filter_context & fc, unit_map & units, const_iterator start, const_iterator finish) const
|
||||
|
|
|
@ -419,8 +419,8 @@ void tcontrol::definition_load_configuration(const std::string& control_type)
|
|||
set_config(get_control(control_type, definition_));
|
||||
if(canvas().size() != config()->state.size())
|
||||
{
|
||||
/// @TODO: Some widgets (toggle panel, toggle button) have a variable canvas count which is determined by its definition.
|
||||
/// I think we should remove the canvas_count from tcontrols construcor and always read it from the definition.
|
||||
// TODO: Some widgets (toggle panel, toggle button) have a variable canvas count which is determined by its definition.
|
||||
// I think we should remove the canvas_count from tcontrols constructor and always read it from the definition.
|
||||
LOG_GUI_L << "Corrected canvas count to " << config()->state.size();
|
||||
canvas() = std::vector<tcanvas>(config()->state.size());
|
||||
}
|
||||
|
|
|
@ -160,9 +160,9 @@ public:
|
|||
* 1. The hotkey is valid in the current scope.
|
||||
* 2. The Keyboard modifiers and SDL_Event mathes this hotkey.
|
||||
*
|
||||
* @param event The @SDL_Event that has triggered and is being evaluated.
|
||||
* @param event The SDL_Event that has triggered and is being evaluated.
|
||||
*/
|
||||
bool matches(const SDL_Event &event) const;
|
||||
bool matches(const SDL_Event& event) const;
|
||||
|
||||
/**
|
||||
* Checks whether the hotkey bindings and scope are equal.
|
||||
|
@ -387,7 +387,8 @@ const hotkey_list& get_hotkeys();
|
|||
|
||||
/**
|
||||
* Unset the command bindings for all hotkeys matching the command.
|
||||
* @command The binding to be unset
|
||||
*
|
||||
* @param command The binding to be unset
|
||||
*/
|
||||
void clear_hotkeys(const std::string& command);
|
||||
|
||||
|
|
|
@ -393,7 +393,7 @@ void play_controller::hotkey_handler::expand_autosaves(std::vector<std::string>&
|
|||
savenames_.push_back("");
|
||||
}
|
||||
}
|
||||
///replaces "wml" in @items with all active wml menu items for the current field
|
||||
|
||||
void play_controller::hotkey_handler::expand_wml_commands(std::vector<std::string>& items)
|
||||
{
|
||||
wml_commands_.clear();
|
||||
|
|
|
@ -53,7 +53,9 @@ protected:
|
|||
const game_state & gamestate() const;
|
||||
|
||||
private:
|
||||
/** Private data related to menu implementation (expansion of AUTOSAVES, WML entries) */
|
||||
//
|
||||
// Private data related to menu implementation (expansion of AUTOSAVES, WML entries)
|
||||
//
|
||||
|
||||
/// A smart pointer used when retrieving menu items.
|
||||
typedef boost::shared_ptr<const game_events::wml_menu_item> const_item_ptr;
|
||||
|
@ -63,6 +65,9 @@ private:
|
|||
|
||||
std::vector<std::string> savenames_;
|
||||
|
||||
/**
|
||||
* Replaces "wml" in @a items with all active WML menu items for the current field.
|
||||
*/
|
||||
void expand_wml_commands(std::vector<std::string>& items);
|
||||
std::vector<const_item_ptr> wml_commands_;
|
||||
boost::scoped_ptr<wmi_pager> wml_command_pager_;
|
||||
|
|
|
@ -185,19 +185,20 @@ class rotate_modification : public modification
|
|||
public:
|
||||
/**
|
||||
* Constructor.
|
||||
* @pre @zoom >= @offset Otherwise the result will have empty pixels.
|
||||
* @pre @offset > 0 Otherwise the procedure will not return.
|
||||
*
|
||||
* @pre zoom >= offset Otherwise the result will have empty pixels.
|
||||
* @pre offset > 0 Otherwise the procedure will not return.
|
||||
*
|
||||
* @param degrees Amount of rotation (in degrees).
|
||||
* Positive values are clockwise; negative are counter-clockwise.
|
||||
* @param zoom The zoom level to calculate the rotation from.
|
||||
* Greater values result in better results and increased runtime.
|
||||
* This parameter will be ignored if @degrees is a multiple of 90.
|
||||
* This parameter will be ignored if @a degrees is a multiple of 90.
|
||||
* @param offset Determines the step size of the scanning of the zoomed source.
|
||||
* Different offsets can produce better results, try them out.
|
||||
* Greater values result in decreased runtime.
|
||||
* This parameter will be ignored if @degrees is a multiple of 90.
|
||||
* If @offset is greater than @zoom the result will have empty pixels.
|
||||
* This parameter will be ignored if @a degrees is a multiple of 90.
|
||||
* If @a offset is greater than @a zoom the result will have empty pixels.
|
||||
*/
|
||||
rotate_modification(int degrees = 90, int zoom = 16, int offset = 8)
|
||||
: degrees_(degrees), zoom_(zoom), offset_(offset)
|
||||
|
|
|
@ -364,8 +364,8 @@ surface blend_surface(
|
|||
/**
|
||||
* Rotates a surface by any degrees.
|
||||
*
|
||||
* @pre @zoom >= @offset Otherwise @return will have empty pixels.
|
||||
* @pre @offset > 0 Otherwise the procedure will not return.
|
||||
* @pre @p zoom >= @p offset Otherwise @return will have empty pixels.
|
||||
* @pre @p offset > 0 Otherwise the procedure will not return.
|
||||
*
|
||||
* @param surf The surface to rotate.
|
||||
* @param angle The angle of rotation.
|
||||
|
@ -472,8 +472,8 @@ private:
|
|||
*
|
||||
* @param surf The image to get or receive the pixel from.
|
||||
* @param surf_lock The locked surface to make sure the pointers are valid.
|
||||
* @x The position in the row of the pixel.
|
||||
* @y The row of the pixel.
|
||||
* @param x The position in the row of the pixel.
|
||||
* @param y The row of the pixel.
|
||||
*/
|
||||
void put_pixel(const surface& surf, surface_lock& surf_lock, int x, int y, Uint32 pixel);
|
||||
Uint32 get_pixel(const surface& surf, const const_surface_lock& surf_lock, int x, int y);
|
||||
|
|
|
@ -191,7 +191,9 @@ public:
|
|||
|
||||
/**
|
||||
* @param variation_id The id of the variation we search for.
|
||||
* @return Iff one of the type's variations' (or the sibling's if the unit_type is a variation itself) id matches @variation_id.
|
||||
* @return Whether one of the type's variations' (or the
|
||||
* siblings' if the unit_type is a variation
|
||||
* itself) id matches @a variation_id.
|
||||
*/
|
||||
bool has_variation(const std::string& variation_id) const;
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue