Author: mordante
Date: Fri Sep 19 17:30:28 2008
New Revision: 29550
URL: http://svn.gna.org/viewcvs/wesnoth?rev=29550&view=rev
Log:
Update doxygen comment style.
Modified:
trunk/src/multiplayer_connect.cpp
trunk/src/multiplayer_connect.hpp
Modified: trunk/src/multiplayer_connect.cpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/multiplayer_connect.cpp?rev=29550&r1=29549&r2=29550&view=diff
==============================================================================
--- trunk/src/multiplayer_connect.cpp (original)
+++ trunk/src/multiplayer_connect.cpp Fri Sep 19 17:30:28 2008
@@ -12,8 +12,10 @@
See the COPYING file for more details.
*/
-//! @file multiplayer_connect.cpp
-//! Prepare to join a multiplayer-game.
+/**
+ * @file multiplayer_connect.cpp
+ * Prepare to join a multiplayer-game.
+ */
#include "global.hpp"
@@ -1216,8 +1218,10 @@
connected_user_list::iterator player = find_player(name);
if(player != users_.end()) {
- //! @todo Seems like a needless limitation to only
allow one side
- //! per player.
+ /**
+ * @todo Seems like a needless limitation to only allow
one side
+ * per player.
+ */
if(find_player_side(name) != -1) {
config response;
response.values["failed"] = "yes";
@@ -1522,7 +1526,6 @@
}
}
-//! Called by the constructor to initialize the game from a create::parameters
structure.
void connect::load_game()
{
if(params_.saved_game) {
Modified: trunk/src/multiplayer_connect.hpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/multiplayer_connect.hpp?rev=29550&r1=29549&r2=29550&view=diff
==============================================================================
--- trunk/src/multiplayer_connect.hpp (original)
+++ trunk/src/multiplayer_connect.hpp Fri Sep 19 17:30:28 2008
@@ -12,8 +12,7 @@
See the COPYING file for more details.
*/
-//! @file multiplayer_connect.hpp
-//!
+/** @file multiplayer_connect.hpp */
#ifndef MULTIPLAYER_CONNECT_H_INCLUDED
#define MULTIPLAYER_CONNECT_H_INCLUDED
@@ -60,62 +59,78 @@
void process_event();
- //! Returns true if this side changed since last call to
changed()
+ /** Returns true if this side changed since last call to
changed(). */
bool changed();
- //! Gets a config object representing this side.
- //! If include_leader is set to true, the config objects include
- //! the "type=" defining the leader type, else it does not.
+ /**
+ * Gets a config object representing this side.
+ *
+ * If include_leader is set to true, the config objects include
the
+ * "type=" defining the leader type, else it does not.
+ */
config get_config() const;
- //! Returns true if this side is waiting for a network player
- //! and players allowed
+ /**
+ * Returns true if this side is waiting for a network player and
+ * players allowed.
+ */
bool available(const std::string& name = "") const;
- //! Return true if players are allowed to take this side
+ /** Return true if players are allowed to take this side. */
bool allow_player() const;
- //! Sets the controller of a side.
+ /** Sets the controller of a side. */
void set_controller(mp::controller controller);
mp::controller get_controller() const;
- //! Adds an user to the user list combo
+ /** Adds an user to the user list combo. */
void update_user_list();
- //! Returns the username of this side
+ /** Returns the username of this side. */
const std::string& get_current_player() const
- { return current_player_; }
+ { return current_player_; }
+
const std::string& get_id() const;
bool is_owned_by(const std::string& name) const;
- //! Sets the username of this side
+
+ /** Sets the username of this side. */
void set_id(const std::string& id);
const std::string& get_save_id() const;
- //! Imports data from the network into this side,
- //! and updates the UI accordingly.
+ /**
+ * Imports data from the network into this side, and updates
the UI
+ * accordingly.
+ */
void import_network_user(const config& data);
- //! Resets this side to its default state, and updates the UI
accordingly.
+ /** Resets this side to its default state, and updates the UI
accordingly. */
void reset(mp::controller controller);
- //! Resolves the random leader / factions.
+ /** Resolves the random leader / factions. */
void resolve_random();
void hide_ai_algorithm_combo(bool invis);
private:
void init_ai_algorithm_combo();
void update_ai_algorithm_combo()
{hide_ai_algorithm_combo(parent_->hidden());}
- //! Fill or refresh the faction combo using the proper team
color
+
+ /** Fill or refresh the faction combo using the proper team
color. */
void update_faction_combo();
void update_controller_ui();
void update_ui();
- //! The mp::connect widget owning this mp::connect::side.
- //! Used in the constructor, must be first.
+ /**
+ * The mp::connect widget owning this mp::connect::side.
+ *
+ * Used in the constructor, must be first.
+ */
connect* parent_;
- //! A non-const config. Be careful not to insert keys when only
reading.
- //! (Use cfg_.get_attribute().)
+ /**
+ * A non-const config. Be careful not to insert keys when only
reading.
+ *
+ * (Use cfg_.get_attribute().)
+ */
config cfg_;
// Configurable variables
@@ -167,13 +182,16 @@
virtual void process_event();
void take_reserved_side(connect::side& side, const config& data);
- /** Returns the game state, which contains all information
- * about the current scenario.
+
+ /**
+ * Returns the game state, which contains all information about the
current
+ * scenario.
*/
const game_state& get_state();
- /** Updates the current game state, resolves random factions,
- * and sends a "start game" message to the network.
+ /**
+ * Updates the current game state, resolves random factions, and sends a
+ * "start game" message to the network.
*/
void start_game();
@@ -190,46 +208,52 @@
private:
// Those 2 functions are actually the steps of the (complex)
// construction of this class.
+
+ /**
+ * Called by the constructor to initialize the game from a
+ * create::parameters structure.
+ */
void load_game();
void lists_init();
- // Convenience function
+ /** Convenience function. */
config* current_config();
- //! Updates the level_ variable to reflect the sides in the sides_
vector
+ /** Updates the level_ variable to reflect the sides in the sides_
vector. */
void update_level();
- //! Updates the level, and send a diff to the clients.
+ /** Updates the level, and send a diff to the clients. */
void update_and_send_diff(bool update_time_of_day = false);
- //! Returns true if there still are sides available for this game.
+ /** Returns true if there still are sides available for this game. */
bool sides_available();
- //! Updates the state of the player list,
- //! the launch button and of the start game label,
- //! to reflect the actual state.
+ /**
+ * Updates the state of the player list, the launch button and of the
start
+ * game label, to reflect the actual state.
+ */
void update_playerlist_state(bool silent=true);
- //! Returns the index of a player, from its id, or -1 if the player was
not found.
+ /** Returns the index of a player, from its id, or -1 if the player was
not found. */
connected_user_list::iterator find_player(const std::string& id);
- //! Returns the side which is taken by a given player, or -1 if none
was found.
+ /** Returns the side which is taken by a given player, or -1 if none
was found. */
int find_player_side(const std::string& id) const;
- //! Adds a player.
+ /** Adds a player. */
void update_user_combos();
- //! Removes a player and kicks it from the game.
+ /** Removes a player and kicks it from the game. */
void kick_player(const std::string& name);
config level_;
- //! This is the "game state" object which is created by this dialog.
+ /** This is the "game state" object which is created by this dialog. */
game_state state_;
create::parameters params_;
- //! The list of available sides for the current era.
+ /** The list of available sides for the current era. */
config::child_list era_sides_;
// Lists used for combos
_______________________________________________
Wesnoth-commits mailing list
[email protected]
https://mail.gna.org/listinfo/wesnoth-commits
