some define comment and replace number by const (#469)

include/defines.h

@@ -3,13 +3,13 @@
 
 
 /**
- * Options for Controller Pak state
+ * @brief Options for Controller Pak state
  */
 #define OK 1
 #define BAD 0
 
 /**
- * Enable debug mode
+ * @brief Enable debug mode
  * 
  * Press start to skip through menus
  * 
@@ -37,13 +37,13 @@
  * D-pad RIGHT = BOWSER
  * D-pad DOWN  = MARIO
  *  
-*/
+ */
 #define DEBUG_MODE 0
 #define DEBUG_MENU 1
 #define HOLD_ALL_DPAD_AND_C_BUTTONS (U_JPAD | L_JPAD | R_JPAD | D_JPAD | U_CBUTTONS | L_CBUTTONS | R_CBUTTONS | D_CBUTTONS)
 
 /**
- * Options for gDebugMenuSelection
+ * @brief Options for gDebugMenuSelection
  */
 #define DEBUG_MENU_DISABLED 1
 #define DEBUG_MENU_DEBUG_MODE 2
@@ -55,7 +55,7 @@
 #define DEBUG_MENU_EXITED 64
 
 /**
- * Options for gDebugGotoScene
+ * @brief Options for gDebugGotoScene
  */
 #define DEBUG_GOTO_RACING 0
 #define DEBUG_GOTO_ENDING_SEQUENCE 1
@@ -63,8 +63,7 @@
 #define DEBUG_GOTO_CREDITS_SEQUENCE_CC_EXTRA 3
 
 /**
- * Jump to demo mode from the debug menu
- * using L and A
+ * @brief Jump to demo mode from the debug menu using L and A
  */
 #define DEMO_MODE_ACTIVE 1
 #define DEMO_MODE_INACTIVE 0
@@ -75,18 +74,16 @@
  * Start sequence means waiting for the light to turn green.
  * Used in the Player struct's 'type' member: player->type
  */
-
 #define PLAYER_INACTIVE             0         // 0x0000
-#define PLAYER_EXISTS               (1 << 15) // 0x8000
-#define PLAYER_CINEMATIC_MODE       (1 << 11) // 0x0800 // Also used to track eliminations in Battle mode.
-#define PLAYER_STAGING              (1 <<  9) // 0x0200
-#define PLAYER_START_SEQUENCE       (1 << 13) // 0x2000
-#define PLAYER_CPU                  (1 << 12) // 0x1000
-#define PLAYER_HUMAN                (1 << 14) // 0x4000
+#define PLAYER_UNKNOWN_0x40         (1 <<  6) // 0x0040
 #define PLAYER_INVISIBLE_OR_BOMB    (1 <<  8) // 0x0100
-#define PLAYER_UNKNOWN_0x40            (1 <<  6) // 0x0040
-// unused?
-#define PLAYER_UNKNOWN              (1 << 10) // 0x0400
+#define PLAYER_STAGING              (1 <<  9) // 0x0200
+#define PLAYER_UNKNOWN              (1 << 10) // 0x0400 // unused ?
+#define PLAYER_CINEMATIC_MODE       (1 << 11) // 0x0800 // Also used to track eliminations in Battle mode.
+#define PLAYER_CPU                  (1 << 12) // 0x1000
+#define PLAYER_START_SEQUENCE       (1 << 13) // 0x2000
+#define PLAYER_HUMAN                (1 << 14) // 0x4000
+#define PLAYER_EXISTS               (1 << 15) // 0x8000
 
 // Compiles to -0x1000 in diff.py
 #define PLAYER_HUMAN_AND_CPU PLAYER_EXISTS | PLAYER_HUMAN | PLAYER_CPU | PLAYER_START_SEQUENCE
@@ -117,15 +114,15 @@
 #define MAX_NUM_MAIN_MENU_GAME_TYPES 3
 
 /**
- * Options for gModeSelection
-**/
+ * @brief Options for gModeSelection
+ */
 #define GRAND_PRIX  0
 #define TIME_TRIALS 1
 #define VERSUS      2
 #define BATTLE      3
 
 /**
- * Options for gCCSelection
+ * @brief Options for gCCSelection
  * CC stands for cubic-centimetres.
  * It measures engine displacement composed from
  * cylinder volume.
@@ -139,11 +136,11 @@
 #define CC_BATTLE   4
 
 /**
- * Options for gCupSelection
+ * @brief Options for gCupSelection
  * There is a "cup" for battle mode, probably so that
  * the battle courses could be displayed in the same
  * way race courses are.
-**/
+ */
 #define MUSHROOM_CUP 0
 #define FLOWER_CUP   1
 #define STAR_CUP     2
@@ -152,11 +149,11 @@
 #define NUM_CUPS     5
 
 /**
- * Character IDs
+ * @brief Character IDs
  * Note that these are not the same as the values
  * found in gCharacterGridSelections as those are
  * ordered by table
-**/
+ */
 #define MARIO  0
 #define LUIGI  1
 #define YOSHI  2
@@ -167,8 +164,8 @@
 #define BOWSER 7
 
 /**
- * Options for gMenuSelection
-**/
+ * @brief Options for gMenuSelection
+ */
 #define OPTIONS_MENU 5
 #define DATA_MENU 6
 #define COURSE_DATA_MENU 7
@@ -181,8 +178,8 @@
 #define RACING_DUPLICATE 14
 
 /**
- * Options for gGameState gMenuSelectionFromQuit and gMenuSelectionFromEndingSequence
-**/
+ * @brief Options for gGameState gMenuSelectionFromQuit and gMenuSelectionFromEndingSequence
+ */
 #define START_MENU_FROM_QUIT 0
 #define MAIN_MENU_FROM_QUIT 1
 #define PLAYER_SELECT_MENU_FROM_QUIT 2
@@ -192,8 +189,8 @@
 #define CREDITS_SEQUENCE 9
 
 /**
- * Options for gMainMenuSelectionDepth
-**/
+ * @brief Options for gMainMenuSelectionDepth
+ */
 #define BLANK_MAIN_MENU 0
 #define OPTIONS_SELECTION 1
 #define DATA_SELECTION 2
@@ -205,8 +202,8 @@
 #define TIME_TRIALS_DATA_SELECTION_FROM_BACK_OUT 8
 
 /**
- * Options for gControllerPakMenuSelection
-**/
+ * @brief Options for gControllerPakMenuSelection
+ */
 #define CONTROLLER_PAK_MENU_SELECT_RECORD 1
 #define CONTROLLER_PAK_MENU_END 2
 #define CONTROLLER_PAK_MENU_ERASE 3
@@ -219,7 +216,7 @@
 #define CONTROLLER_PAK_MENU_ERASE_ERROR_PAK_CHANGED 10
 
 /**
- * Options for gScreenModeSelection and gActiveScreenMode
+ * @brief Options for gScreenModeSelection and gActiveScreenMode
  */
 #define SCREEN_MODE_1P 0
 #define SCREEN_MODE_2P_SPLITSCREEN_HORIZONTAL 1
@@ -228,8 +225,8 @@
 #define NUM_SCREEN_MODES 4
 
 /**
- * Indexes for accessing Time Trial records
-**/
+ * @brief Indexes for accessing Time Trial records
+ */
 #define TIME_TRIAL_3LAP_RECORD_1 0
 #define TIME_TRIAL_3LAP_RECORD_2 1
 #define TIME_TRIAL_3LAP_RECORD_3 2
@@ -238,13 +235,13 @@
 #define TIME_TRIAL_1LAP_RECORD   5
 
 /**
- * Text color options
+ * @brief Text color options
  * The 2 cycling options cycle through Blue -> Green -> Red
  * Cycle 2 appears to be one step ahead of Cycle 1
  * Other values like 6 and 7 sort of work, they cause rapid
  * flashing between 2 colors, but also cause individual characters
  * to be cutoff on their right side
-**/
+ */
 #define TEXT_BLUE                   0
 #define TEXT_GREEN                  1
 #define TEXT_RED                    2
@@ -253,10 +250,10 @@
 #define TEXT_BLUE_GREEN_RED_CYCLE_2 5
 
 /**
- * Sound mode options
+ * @brief Sound mode options
  * Option 2 appears to be unused, as such its probably not
  * a valid option
-**/
+ */
 #define SOUND_STEREO      0
 #define SOUND_HEADPHONES  1
 #define SOUND_UNUSED      2
@@ -264,9 +261,9 @@
 #define NUM_SOUND_MODES   4
 
 /**
- * Title screen demo options
+ * @brief Title screen demo options
  * All demos use 100 CC
-**/
+ */
 #define DEMO_ONE   0 // Mario,                  Mario Raceway,   Grand Prix
 #define DEMO_TWO   1 // Yoshi DK,               Choco Mountain,  Versus
 #define DEMO_THREE 2 // Luigi,                  Kalamari Desert, Grand Prix
@@ -282,8 +279,8 @@
 #define NUM_COURSES_PER_CUP 4
 
 /**
- * Item IDs
-**/
+ * @brief Item IDs
+ */
 #define ITEM_NONE                0
 #define ITEM_BANANA              1
 #define ITEM_BANANA_BUNCH        2
@@ -302,14 +299,14 @@
 #define ITEM_SUPER_MUSHROOM      15
 
 /**
- * Balloon status
-**/
+ * @brief Balloon status
+ */
 #define BALLOON_STATUS_GONE       0
 #define BALLOON_STATUS_PRESENT    1
 #define BALLOON_STATUS_DEPARTING  2
 
 /**
- * Max representable time, 100 minutes measured in centiseconds
+ * @brief Max representable time, 100 minutes measured in centiseconds
  */
 #define MAX_TIME 0x927C0
 
@@ -317,14 +314,14 @@
  * @brief effect of player's
  * for statusEffect
  */
-#define BOOST_EFFECT 0x200 // being boosted by trigger a mushroom or star
-#define BOO_EFFECT 0x800 // being a boo
-#define STAR_EFFECT 0x2000 // being a star
-#define HOLD_BANANA_EFFECT 0x40000 // holding a banana
+#define BOOST_EFFECT        0x200 // being boosted by trigger a mushroom or star
+#define BOO_EFFECT          0x800 // being a boo
+#define STAR_EFFECT         0x2000 // being a star
 #define HIT_ROTATING_EFFECT 0x4000 // hitting a rotating object
-#define HIT_BY_ITEM_EFFECT 0x1000000 // being hit by an item
-#define REVERSE_EFFECT 0x400000 // being in the wrong direction
-#define LIGHTNING_EFFECT 0x40000000 // being hit by lightning
+#define HOLD_BANANA_EFFECT  0x40000 // holding a banana
+#define REVERSE_EFFECT      0x400000 // being in the wrong direction
+#define HIT_BY_ITEM_EFFECT  0x1000000 // being hit by an item
+#define LIGHTNING_EFFECT    0x40000000 // being hit by lightning
 
 
 /**