--- 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 {