doxygen groups

include/save.h

@@ -20,27 +20,37 @@ typedef enum {
     SAVE_DONE,
 } SaveState;
 
-extern SaveResult HandleSave(u32 arg0);
+/**
+ * Attempt to save the game.
+ *
+ * @param idx The save slot.
+ * @return #SaveResult result.
+ */
+extern SaveResult HandleSave(u32 idx);
 
+/**
+ * Contains all information about a save file.
+ * The contents of this structure are read from and written to EEPROM.
+ */
 typedef struct {
-    /*0x000*/ u8 invalid;
-    /*0x000*/ u8 initialized;
-    /*0x002*/ u8 msg_speed;
-    /*0x003*/ u8 brightness;
+    /*0x000*/ u8 invalid;     /**< File is invalid. */
+    /*0x000*/ u8 initialized; /**< File is initialized. */
+    /*0x002*/ u8 msg_speed;   /**< Message speed. */
+    /*0x003*/ u8 brightness;  /**< Brightness. */
     /*0x004*/ u8 filler4[0x2];
     /*0x006*/ u8 unk6;
     /*0x007*/ u8 unk7;
-    /*0x008*/ u8 global_progress;
+    /*0x008*/ u8 global_progress; /**< @see UpdateGlobalProgress */
     /*0x009*/ u8 field_0x9[0x34];
-    /*0x040*/ u32 windcrests;
+    /*0x040*/ u32 windcrests; /**< Windcrest flags. */
     /*0x044*/ u8 filler44[0xC];
     /*0x050*/ u32 unk50;
     /*0x054*/ u8 filler54[0xC];
-    /*0x060*/ u32 areaVisitFlags[8];
-    /*0x080*/ char name[FILENAME_LENGTH];
+    /*0x060*/ u32 areaVisitFlags[8];      /**< Area visit flags. */
+    /*0x080*/ char name[FILENAME_LENGTH]; /**< Save file name. */
     /*0x086*/ u8 filler86[0x2];
-    /*0x088*/ PlayerRoomStatus saved_status;
-    /*0x0A8*/ Stats stats;
+    /*0x088*/ PlayerRoomStatus saved_status; /**< Player room status. */
+    /*0x0A8*/ Stats stats;                   /**< Player stats. */
     /*0x0D0*/ u8 fillerD0[0x48];
     /*0x118*/ u8 unk118[0x13];
     /*0x12B*/ u8 unk12B[0x16];
@@ -48,25 +58,69 @@ typedef struct {
     /*0x1C1*/ u8 unk1C1[128];
     /*0x241*/ u8 unk241[13];
     /*0x24E*/ u8 unk24E[14];
-    /*0x25C*/ u8 flags[0x200];
+    /*0x25C*/ u8 flags[0x200]; /**< Flags. */
     /*0x45C*/ u8 unk45C[0x10];
     /*0x46C*/ u8 unk46C[0x20];
     /*0x48C*/ u32 timers[7];
-    /*0x4A8*/ u32 demo_timer;
+    /*0x4A8*/ u32 demo_timer; /**< Demo timer. */
     /*0x4AC*/ u8 filler4ac[0x8];
 } SaveFile;
 
+/**
+ * The current save file.
+ */
 extern SaveFile gSave;
 
+/**
+ * Initialize the save system.
+ *
+ * @return Success
+ */
 u32 InitSaveData(void);
 
-u32 Write_02000000(SaveHeader*);
-s32 ReadSaveFile(u32, SaveFile*);
+/**
+ * Read save header.
+ *
+ * @return Success.
+ */
 u32 Read_02000000(SaveHeader*);
+
+/**
+ * Write save header.
+ *
+ * @return Success.
+ */
+u32 Write_02000000(SaveHeader*);
+
+/**
+ * Read save file.
+ *
+ * @return Success.
+ */
+s32 ReadSaveFile(u32, SaveFile*);
+
+/**
+ * Mark a save file as deleted.
+ *
+ * @param index The save file index.
+ */
 void SetFileStatusDeleted(u32 index);
 
 extern const char gUnk_0811E470[];
 
+/**
+ * Update the global progress (0 - 10).
+ * There are 10 different indicators of game completion:
+    9 : Flag SEIIKI_STAINED_GLASS
+    8 : Flag LV5_CLEAR
+    7 : Flag OUBO_KAKERA
+    6 : Flag LV4_CLEAR
+    5 : Flag LV3_CLEAR
+    4 : Flag SOUGEN_08_TORITSUKI
+    2 : Flag LV1_CLEAR
+    1 : Default
+    }
+ */
 void UpdateGlobalProgress(void);
 
 #ifdef DEMO_USA