Improve boot folder documentation

src/boot/cheats.h

@@ -1,10 +1,25 @@
+/**
+ * @file cheats.h
+ * @brief Header file for cheat installation functions.
+ * @ingroup boot
+ */
+
 #ifndef CHEATS_H__
 #define CHEATS_H__
 
 #include <stdint.h>
-
 #include "cic.h"
 
-bool cheats_install (cic_type_t cic_type, uint32_t *cheat_list);
+/**
+ * @brief Installs cheats based on the CIC type.
+ *
+ * This function installs the cheats provided in the cheat list based on the
+ * specified CIC type.
+ *
+ * @param cic_type The type of CIC (Copy Protection Chip) used.
+ * @param cheat_list A pointer to an array of cheats to be installed.
+ * @return true if the cheats were successfully installed, false otherwise.
+ */
+bool cheats_install(cic_type_t cic_type, uint32_t *cheat_list);
 
-#endif
+#endif // CHEATS_H__

src/boot/cic.h

@@ -1,33 +1,55 @@
+/**
+ * @file cic.h
+ * @brief Header file for CIC (Copy Protection Chip) related functions and definitions.
+ * @ingroup boot
+ */
+
 #ifndef CIC_H__
 #define CIC_H__
 
-
 #include <stdint.h>
 
-
 #define IPL3_LENGTH     (4032)
 
-
+/**
+ * @enum cic_type_t
+ * @brief Enumeration of different CIC types.
+ */
 typedef enum {
-    CIC_5101,
-    CIC_5167,
-    CIC_6101,
-    CIC_7102,
-    CIC_x102,
-    CIC_x103,
-    CIC_x105,
-    CIC_x106,
-    CIC_8301,
-    CIC_8302,
-    CIC_8303,
-    CIC_8401,
-    CIC_8501,
-    CIC_UNKNOWN,
+    CIC_5101,   /**< CIC type 5101 */
+    CIC_5167,   /**< CIC type 5167 */
+    CIC_6101,   /**< CIC type 6101 */
+    CIC_7102,   /**< CIC type 7102 */
+    CIC_x102,   /**< CIC type x102 */
+    CIC_x103,   /**< CIC type x103 */
+    CIC_x105,   /**< CIC type x105 */
+    CIC_x106,   /**< CIC type x106 */
+    CIC_8301,   /**< CIC type 8301 */
+    CIC_8302,   /**< CIC type 8302 */
+    CIC_8303,   /**< CIC type 8303 */
+    CIC_8401,   /**< CIC type 8401 */
+    CIC_8501,   /**< CIC type 8501 */
+    CIC_UNKNOWN /**< Unknown CIC type */
 } cic_type_t;
 
+/**
+ * @brief Detects the CIC type based on the provided IPL3 data.
+ *
+ * This function analyzes the provided IPL3 data to determine the CIC type.
+ *
+ * @param ipl3 A pointer to the IPL3 data.
+ * @return The detected CIC type.
+ */
+cic_type_t cic_detect(uint8_t *ipl3);
 
-cic_type_t cic_detect (uint8_t *ipl3);
-uint8_t cic_get_seed (cic_type_t cic_type);
+/**
+ * @brief Gets the seed value for the specified CIC type.
+ *
+ * This function returns the seed value associated with the given CIC type.
+ *
+ * @param cic_type The type of CIC.
+ * @return The seed value for the specified CIC type.
+ */
+uint8_t cic_get_seed(cic_type_t cic_type);
 
-
-#endif
+#endif // CIC_H__

src/boot/reboot.h

@@ -1,17 +1,31 @@
+/**
+ * @file reboot.h
+ * @brief Header file for reboot-related definitions.
+ * @ingroup boot
+ */
+
 #ifndef REBOOT_H__
 #define REBOOT_H__
 
-
 #ifndef __ASSEMBLER__
 
 #include <stdint.h>
 #include <stddef.h>
 
-
+/**
+ * @brief Start address of the reboot code.
+ *
+ * This variable marks the start address of the reboot code section.
+ */
 extern uint32_t reboot_start __attribute__((section(".text")));
+
+/**
+ * @brief Size of the reboot code.
+ *
+ * This variable holds the size of the reboot code section.
+ */
 extern size_t reboot_size __attribute__((section(".text")));
 
-#endif
+#endif // __ASSEMBLER__
 
-
-#endif
+#endif // REBOOT_H__

src/boot/vr4300_asm.h

@@ -1,3 +1,9 @@
+/**
+ * @file vr4300_asm.h
+ * @brief Header file for v4300 CPU-related definitions.
+ * @ingroup boot
+ */
+
 #ifndef VR4300_ASM_H__
 #define VR4300_ASM_H__