# HG changeset patch # User Mrowqa # Date 1354609450 -3600 # Node ID 83d85e32c713ad6d15a54034215c7648c839334d # Parent c14b27abe45212111215f78b308e8079409ee3d8 GCI2012: Corrected headers for generate documentation (doxygen) diff -r c14b27abe452 -r 83d85e32c713 project_files/frontlib/base64/base64.h --- a/project_files/frontlib/base64/base64.h Thu Dec 06 10:01:01 2012 +0100 +++ b/project_files/frontlib/base64/base64.h Tue Dec 04 09:24:10 2012 +0100 @@ -24,7 +24,7 @@ /* Get bool. */ # include -/* This uses that the expression (n+(k-1))/k means the smallest +/*! This uses that the expression (n+(k-1))/k means the smallest integer >= n/k, i.e., the ceiling of n/k. */ # define BASE64_LENGTH(inlen) ((((inlen) + 2) / 3) * 4) diff -r c14b27abe452 -r 83d85e32c713 project_files/frontlib/hwconsts.h --- a/project_files/frontlib/hwconsts.h Thu Dec 06 10:01:01 2012 +0100 +++ b/project_files/frontlib/hwconsts.h Tue Dec 04 09:24:10 2012 +0100 @@ -41,24 +41,24 @@ #define PROTOCOL_VERSION 42 #define MIN_SERVER_VERSION 1 -// Used for sending scripts to the engine +//! Used for sending scripts to the engine #define MULTIPLAYER_SCRIPT_PATH "Scripts/Multiplayer/" #define WEAPONS_COUNT 56 // TODO allow frontend to override these? -/* A merge of mikade/bugq colours w/ a bit of channel feedback */ -#define HW_TEAMCOLOR_ARRAY { UINT32_C(0xffff0204), /* red */ \ - UINT32_C(0xff4980c1), /* blue */ \ - UINT32_C(0xff1de6ba), /* teal */ \ - UINT32_C(0xffb541ef), /* purple */ \ - UINT32_C(0xffe55bb0), /* pink */ \ - UINT32_C(0xff20bf00), /* green */ \ - UINT32_C(0xfffe8b0e), /* orange */ \ - UINT32_C(0xff5f3605), /* brown */ \ - UINT32_C(0xffffff01), /* yellow */ \ - /* add new colors here */ \ - 0 } /* Keep this 0 at the end */ +/*! A merge of mikade/bugq colours w/ a bit of channel feedback */ +#define HW_TEAMCOLOR_ARRAY { UINT32_C(0xffff0204), /*! red */ \ + UINT32_C(0xff4980c1), /*! blue */ \ + UINT32_C(0xff1de6ba), /*! teal */ \ + UINT32_C(0xffb541ef), /*! purple */ \ + UINT32_C(0xffe55bb0), /*! pink */ \ + UINT32_C(0xff20bf00), /*! green */ \ + UINT32_C(0xfffe8b0e), /*! orange */ \ + UINT32_C(0xff5f3605), /*! brown */ \ + UINT32_C(0xffffff01), /*! yellow */ \ + /*! add new colors here */ \ + 0 } /*! Keep this 0 at the end */ extern const size_t flib_teamcolor_count; extern const uint32_t flib_teamcolors[]; @@ -83,25 +83,25 @@ */ int flib_get_weapons_count(); -/* +/*! * These structs define the meaning of values in the flib_scheme struct, i.e. their correspondence to * ini settings, engine commands and positions in the network protocol (the last is encoded in the * order of settings/mods). */ typedef struct { - const char *name; // A name identifying this setting (used as key in the schemes file) - const char *engineCommand; // The command needed to send the setting to the engine. May be null if the setting is not sent to the engine (for the "health" setting) - const bool maxMeansInfinity; // If true, send a very high number to the engine if the setting is equal to its maximum - const bool times1000; // If true (for time-based settings), multiply the setting by 1000 before sending it to the engine. - const int min; // The smallest allowed value - const int max; // The highest allowed value - const int def; // The default value + const char *name; //! A name identifying this setting (used as key in the schemes file) + const char *engineCommand; //! The command needed to send the setting to the engine. May be null if the setting is not sent to the engine (for the "health" setting) + const bool maxMeansInfinity; //! If true, send a very high number to the engine if the setting is equal to its maximum + const bool times1000; //! If true (for time-based settings), multiply the setting by 1000 before sending it to the engine. + const int min; //! The smallest allowed value + const int max; //! The highest allowed value + const int def; //! The default value } flib_metascheme_setting; typedef struct { - const char *name; // A name identifying this mod (used as key in the schemes file) - const int bitmaskIndex; // Mods are sent to the engine in a single integer, this field describes which bit of that integer is used - // for this particular mod. + const char *name; //! A name identifying this mod (used as key in the schemes file) + const int bitmaskIndex; //! Mods are sent to the engine in a single integer, this field describes which bit of that integer is used + //! for this particular mod. } flib_metascheme_mod; typedef struct { diff -r c14b27abe452 -r 83d85e32c713 project_files/frontlib/md5/md5.h --- a/project_files/frontlib/md5/md5.h Thu Dec 06 10:01:01 2012 +0100 +++ b/project_files/frontlib/md5/md5.h Tue Dec 04 09:24:10 2012 +0100 @@ -63,11 +63,11 @@ typedef unsigned char md5_byte_t; /* 8-bit byte */ typedef unsigned int md5_word_t; /* 32-bit word */ -/* Define the state of the MD5 Algorithm. */ +/*! Define the state of the MD5 Algorithm. */ typedef struct md5_state_s { - md5_word_t count[2]; /* message length in bits, lsw first */ - md5_word_t abcd[4]; /* digest buffer */ - md5_byte_t buf[64]; /* accumulate block */ + md5_word_t count[2]; /*! message length in bits, lsw first */ + md5_word_t abcd[4]; /*! digest buffer */ + md5_byte_t buf[64]; /*! accumulate block */ } md5_state_t; #ifdef __cplusplus @@ -75,13 +75,13 @@ { #endif -/* Initialize the algorithm. */ +/*! Initialize the algorithm. */ void md5_init(md5_state_t *pms); -/* Append a string to the message. */ +/*! Append a string to the message. */ void md5_append(md5_state_t *pms, const md5_byte_t *data, int nbytes); -/* Finish the message and return the digest. */ +/*! Finish the message and return the digest. */ void md5_finish(md5_state_t *pms, md5_byte_t digest[16]); #ifdef __cplusplus diff -r c14b27abe452 -r 83d85e32c713 project_files/frontlib/model/gamesetup.h --- a/project_files/frontlib/model/gamesetup.h Thu Dec 06 10:01:01 2012 +0100 +++ b/project_files/frontlib/model/gamesetup.h Tue Dec 04 09:24:10 2012 +0100 @@ -31,7 +31,7 @@ #include "teamlist.h" typedef struct { - char *style; // e.g. "Capture the Flag" + char *style; //! e.g. "Capture the Flag" flib_scheme *gamescheme; flib_map *map; flib_teamlist *teamlist; diff -r c14b27abe452 -r 83d85e32c713 project_files/frontlib/model/map.h --- a/project_files/frontlib/model/map.h Thu Dec 06 10:01:01 2012 +0100 +++ b/project_files/frontlib/model/map.h Tue Dec 04 09:24:10 2012 +0100 @@ -51,14 +51,14 @@ * at the struct for details. */ typedef struct { - int mapgen; // Always one of the MAPGEN_ constants - char *name; // The name of the map for MAPGEN_NAMED (e.g. "Cogs"), otherwise one of "+rnd+", "+maze+" or "+drawn+". - char *seed; // Used for all maps. This is a random seed for all (non-AI) entropy in the round. Typically a random UUID, but can be any string. - char *theme; // Used for all maps. This is the name of a directory in Data/Themes (e.g. "Beach") - uint8_t *drawData; // Used for MAPGEN_DRAWN - size_t drawDataSize; // Used for MAPGEN_DRAWN - int templateFilter; // Used for MAPGEN_REGULAR. One of the TEMPLATEFILTER_xxx constants. - int mazeSize; // Used for MAPGEN_MAZE. One of the MAZE_SIZE_xxx constants. + int mapgen; //! Always one of the MAPGEN_ constants + char *name; //! The name of the map for MAPGEN_NAMED (e.g. "Cogs"), otherwise one of "+rnd+", "+maze+" or "+drawn+". + char *seed; //! Used for all maps. This is a random seed for all (non-AI) entropy in the round. Typically a random UUID, but can be any string. + char *theme; //! Used for all maps. This is the name of a directory in Data/Themes (e.g. "Beach") + uint8_t *drawData; //! Used for MAPGEN_DRAWN + size_t drawDataSize; //! Used for MAPGEN_DRAWN + int templateFilter; //! Used for MAPGEN_REGULAR. One of the TEMPLATEFILTER_xxx constants. + int mazeSize; //! Used for MAPGEN_MAZE. One of the MAZE_SIZE_xxx constants. } flib_map; /** diff -r c14b27abe452 -r 83d85e32c713 project_files/frontlib/model/mapcfg.h --- a/project_files/frontlib/model/mapcfg.h Thu Dec 06 10:01:01 2012 +0100 +++ b/project_files/frontlib/model/mapcfg.h Tue Dec 04 09:24:10 2012 +0100 @@ -17,7 +17,7 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/* +/*! * Data structure and functions for accessing the map.cfg of named maps. */ diff -r c14b27abe452 -r 83d85e32c713 project_files/frontlib/model/room.h --- a/project_files/frontlib/model/room.h Thu Dec 06 10:01:01 2012 +0100 +++ b/project_files/frontlib/model/room.h Tue Dec 04 09:24:10 2012 +0100 @@ -27,12 +27,12 @@ #include typedef struct { - bool inProgress; // true if the game is running + bool inProgress; //! true if the game is running char *name; int playerCount; int teamCount; char *owner; - char *map; // This is either a map name, or one of +rnd+, +maze+ or +drawn+. + char *map; //! This is either a map name, or one of +rnd+, +maze+ or +drawn+. char *scheme; char *weapons; } flib_room; diff -r c14b27abe452 -r 83d85e32c713 project_files/frontlib/model/team.h --- a/project_files/frontlib/model/team.h Thu Dec 06 10:01:01 2012 +0100 +++ b/project_files/frontlib/model/team.h Tue Dec 04 09:24:10 2012 +0100 @@ -49,18 +49,18 @@ typedef struct { char *name; - char *hat; // e.g. hair_yellow; References a .png file in Data/Graphics/Hats + char *hat; //! e.g. hair_yellow; References a .png file in Data/Graphics/Hats - // Statistics. They are irrelevant for the engine or server, - // but provided for ini reading/writing by the frontend. + //! Statistics. They are irrelevant for the engine or server, + //! but provided for ini reading/writing by the frontend. int rounds; int kills; int deaths; int suicides; - int difficulty; // 0 = human, 1 = most difficult bot ... 5 = least difficult bot (somewhat counterintuitive) + int difficulty; //! 0 = human, 1 = most difficult bot ... 5 = least difficult bot (somewhat counterintuitive) - // Transient setting used in game setup + //! Transient setting used in game setup int initialHealth; flib_weaponset *weaponset; } flib_hog; @@ -68,25 +68,25 @@ typedef struct { flib_hog hogs[HEDGEHOGS_PER_TEAM]; char *name; - char *grave; // e.g. "Bone"; References a .png file in Data/Graphics/Graves - char *fort; // e.g. "Castle"; References a series of files in Data/Forts - char *voicepack; // e.g. "Classic"; References a directory in Data/Sounds/voices - char *flag; // e.g. "hedgewars"; References a .png file in Data/Graphics/Flags + char *grave; //! e.g. "Bone"; References a .png file in Data/Graphics/Graves + char *fort; //! e.g. "Castle"; References a series of files in Data/Forts + char *voicepack; //! e.g. "Classic"; References a directory in Data/Sounds/voices + char *flag; //! e.g. "hedgewars"; References a .png file in Data/Graphics/Flags flib_binding *bindings; int bindingCount; - // Statistics. They are irrelevant for the engine or server, - // but provided for ini reading/writing by the frontend. + //! Statistics. They are irrelevant for the engine or server, + //! but provided for ini reading/writing by the frontend. int rounds; int wins; int campaignProgress; - // Transient settings used in game setup - int colorIndex; // Index into a color table - int hogsInGame; // The number of hogs that will actually play - bool remoteDriven; // true for non-local teams in a network game - char *ownerName; // Username of the owner of a team in a network game + //! Transient settings used in game setup + int colorIndex; //! Index into a color table + int hogsInGame; //! The number of hogs that will actually play + bool remoteDriven; //! true for non-local teams in a network game + char *ownerName; //! Username of the owner of a team in a network game } flib_team; /** diff -r c14b27abe452 -r 83d85e32c713 project_files/frontlib/net/netconn.h --- a/project_files/frontlib/net/netconn.h Thu Dec 06 10:01:01 2012 +0100 +++ b/project_files/frontlib/net/netconn.h Tue Dec 04 09:24:10 2012 +0100 @@ -68,19 +68,19 @@ #define NETCONN_STATE_ROOM 2 #define NETCONN_STATE_DISCONNECTED 10 -#define NETCONN_DISCONNECT_NORMAL 0 // The connection was closed normally -#define NETCONN_DISCONNECT_SERVER_TOO_OLD 1 // The server has a lower protocol version than we do -#define NETCONN_DISCONNECT_AUTH_FAILED 2 // You sent a password with flib_netconn_send_password that was not accepted -#define NETCONN_DISCONNECT_CONNLOST 3 // The network connection was lost -#define NETCONN_DISCONNECT_INTERNAL_ERROR 100 // Something went wrong in frontlib itself +#define NETCONN_DISCONNECT_NORMAL 0 //! The connection was closed normally +#define NETCONN_DISCONNECT_SERVER_TOO_OLD 1 //! The server has a lower protocol version than we do +#define NETCONN_DISCONNECT_AUTH_FAILED 2 //! You sent a password with flib_netconn_send_password that was not accepted +#define NETCONN_DISCONNECT_CONNLOST 3 //! The network connection was lost +#define NETCONN_DISCONNECT_INTERNAL_ERROR 100 //! Something went wrong in frontlib itself -#define NETCONN_ROOMLEAVE_ABANDONED 0 // The room was closed because the chief left -#define NETCONN_ROOMLEAVE_KICKED 1 // You have been kicked from the room +#define NETCONN_ROOMLEAVE_ABANDONED 0 //! The room was closed because the chief left +#define NETCONN_ROOMLEAVE_KICKED 1 //! You have been kicked from the room -#define NETCONN_MSG_TYPE_PLAYERINFO 0 // A response to flib_netconn_send_playerInfo -#define NETCONN_MSG_TYPE_SERVERMESSAGE 1 // The welcome message when connecting to the lobby -#define NETCONN_MSG_TYPE_WARNING 2 // A general warning message -#define NETCONN_MSG_TYPE_ERROR 3 // A general error message +#define NETCONN_MSG_TYPE_PLAYERINFO 0 //! A response to flib_netconn_send_playerInfo +#define NETCONN_MSG_TYPE_SERVERMESSAGE 1 //! The welcome message when connecting to the lobby +#define NETCONN_MSG_TYPE_WARNING 2 //! A general warning message +#define NETCONN_MSG_TYPE_ERROR 3 //! A general error message #define NETCONN_MAPCHANGE_FULL 0 #define NETCONN_MAPCHANGE_MAP 1 diff -r c14b27abe452 -r 83d85e32c713 project_files/frontlib/net/netconn_internal.h --- a/project_files/frontlib/net/netconn_internal.h Thu Dec 06 10:01:01 2012 +0100 +++ b/project_files/frontlib/net/netconn_internal.h Tue Dec 04 09:24:10 2012 +0100 @@ -40,9 +40,9 @@ char *playerName; char *dataDirPath; - int netconnState; // One of the NETCONN_STATE constants + int netconnState; //! One of the NETCONN_STATE constants - bool isChief; // Player can modify the current room + bool isChief; //! Player can modify the current room flib_map *map; flib_teamlist pendingTeamlist; flib_teamlist teamlist;