Update file documentation

include/989snd.h

@@ -1,5 +1,7 @@
 /**
  * @file 989snd.h
+ *
+ * @brief 989snd sound driver.
  */
 #ifndef 989SND_H
 #define 989SND_H

include/alarm.h

@@ -1,5 +1,7 @@
 /**
  * @file alarm.h
+ *
+ * @brief Alarm system.
  */
 #ifndef ALARM_H
 #define ALARM_H

include/bas.h

@@ -1,5 +1,7 @@
 /**
  * @file bas.h
+ *
+ * @brief Binary Async Stream.
  */
 #ifndef BAS_H
 #define BAS_H

include/basic.h

@@ -9,6 +9,11 @@
 #include "common.h"
 #include <splice/sidebag.h>
 
+/**
+ * @brief Basic object.
+ *
+ * Base class for most objects.
+ */
 struct BASIC
 {
     int field_0x0;

include/binoc.h

@@ -1,7 +1,7 @@
 /**
  * @file binoc.h
  *
- * @brief Binoc-u-com
+ * @brief Binoc-u-com.
  */
 #ifndef BINOC_H
 #define BINOC_H
@@ -9,7 +9,7 @@
 #include "common.h"
 
 /**
- * @brief Horizontal text justification
+ * @brief Horizontal text justification.
 */
 typedef enum JH
 {
@@ -21,7 +21,7 @@ typedef enum JH
 } JH;
 
 /**
- * @brief Vertical text justification
+ * @brief Vertical text justification.
 */
 typedef enum JV
 {
@@ -33,7 +33,7 @@ typedef enum JV
 } JV;
 
 /**
- * @brief RGBA color value
+ * @brief RGBA color value.
 */
 struct RGBA
 {

include/bomb.h

@@ -6,6 +6,9 @@
 
 #include "common.h"
 
-// ...
+struct BOMB
+{
+    // ...
+};
 
 #endif // BOMB_H

include/brx.h

@@ -1,5 +1,7 @@
 /**
  * @file brx.h
+ *
+ * @brief Binary Resource Archive.
  */
 #ifndef BRX_H
 #define BRX_H

include/chkpnt.h

@@ -18,7 +18,10 @@
  *
  * @note CHKPNT : ALO : LO : BASIC
  */
-struct CHKPNT;
+struct CHKPNT : public ALO
+{
+	// ...
+};
 
 /**
  * @brief Checkpoint Manager

include/cid.h

@@ -1,7 +1,7 @@
 /**
  * @file cid.h
  *
- * @brief Collision ID?
+ * @brief Class ID.
  */
 #ifndef CID_H
 #define CID_H
@@ -9,9 +9,7 @@
 #include "common.h"
 
 /**
- * @brief Collision ID?
- *
- * @note Not sure if actually collision or something else.
+ * @brief Class ID.
  */
 enum CID
 {

include/clock.h

@@ -1,7 +1,7 @@
 /**
  * @file clock.h
  *
- * @brief Engine clock
+ * @brief Engine clock.
  */
 #ifndef CLOCK_H
 #define CLOCK_H

include/common.h

@@ -1,3 +1,8 @@
+/**
+ * @file common.h
+ *
+ * @brief Common header file.
+ */
 #ifndef COMMON_H
 #define COMMON_H
 

include/cplcy.h

@@ -1,5 +1,9 @@
 /**
  * @file cplcy.h
+ *
+ * @brief Camera policy.
+ *
+ * @todo Delete this file, or move camera policy structs from cm.h.
  */
 #ifndef CPLCY_H
 #define CPLCY_H

include/dart.h

@@ -1,5 +1,7 @@
 /**
  * @file dart.h
+ *
+ * @brief Dart gun projectiles.
  */
 #ifndef DART_H
 #define DART_H

include/difficulty.h

@@ -1,7 +1,7 @@
 /**
  * @file difficulty.h
  *
- * Dynamic difficulty system.
+ * @brief Dynamic difficulty system.
  */
 #ifndef DIFFICULTY_H
 #define DIFFICULTY_H

include/emitter.h

@@ -1,5 +1,7 @@
 /**
  * @file emitter.h
+ *
+ * @brief Particle emitter.
  */
 #ifndef EMITTER_H
 #define EMITTER_H

include/find.h

@@ -1,5 +1,7 @@
 /**
  * @file find.h
+ *
+ * @brief Find objects in the SW.
  */
 #ifndef FIND_H
 #define FIND_H

include/flash.h

@@ -1,5 +1,7 @@
 /**
  * @file flash.h
+ *
+ * @brief Flash (might be flash animation, or literal screen flashes).
  */
 #ifndef FLASH_H
 #define FLASH_H

include/fly.h

@@ -1,5 +1,7 @@
 /**
  * @file fly.h
+ *
+ * @brief Fly critters.
  */
 #ifndef FLY_H
 #define FLY_H

include/font.h

@@ -1,5 +1,7 @@
 /**
  * @file font.h
+ *
+ * @brief Font system.
  */
 #ifndef FONT_H
 #define FONT_H

include/frm.h

@@ -1,5 +1,7 @@
 /**
  * @file frm.h
+ *
+ * @brief Frame manager.
  */
 #ifndef FRM_H
 #define FRM_H

include/geom.h

@@ -1,11 +1,18 @@
 /**
  * @file geom.h
+ *
+ * @brief Geometry.
  */
 #ifndef GEOM_H
 #define GEOM_H
 
 #include "common.h"
 
+/**
+ * @brief Edge
+ *
+ * Represents an edge in a geometry.
+ */
 struct EDGE
 {
     ushort aipos[2];
@@ -14,4 +21,15 @@ struct EDGE
     EDGE *pedgeOtherNext;
 };
 
+/**
+ * @brief Geometry
+
+ *
+ * @todo Implement struct.
+ */
+struct GEOM
+{
+    // ...
+};
+
 #endif // GEOM_H

include/joy.h

@@ -1,7 +1,7 @@
 /**
  * @file joy.h
  *
- * @brief Joypad state.
+ * @brief Joypad manager.
  */
 #ifndef JOY_H
 #define JOY_H

include/mq.h

@@ -1,7 +1,7 @@
 /**
  * @file mq.h
  *
- * @brief Message queue(?)
+ * @brief Message queue(?).
  */
 #ifndef MQ_H
 #define MQ_H

include/pnt.h

@@ -1,5 +1,9 @@
 /**
  * @file pnt.h
+ *
+ * @brief Points.
+ *
+ * @todo Delete this header or move PNT structs here.
  */
 #ifndef PNT_H
 #define PNT_H

include/po.h

@@ -1,7 +1,7 @@
 /**
  * @file po.h
  *
- * @brief TBD
+ * @brief Player object(?).
  */
 #ifndef PO_H
 #define PO_H

include/render.h

@@ -1,5 +1,7 @@
 /**
  * @file render.h
+ *
+ * @brief Rendering system.
  */
 #ifndef RENDER_H
 #define RENDER_H

include/rip.h

@@ -1,5 +1,7 @@
 /**
  * @file rip.h
+ *
+ * @brief Rip-off game (crabs).
  */
 #ifndef RIP_H
 #define RIP_H

include/rumble.h

@@ -1,5 +1,7 @@
 /**
  * @file rumble.h
+ *
+ * @brief Joypad rumble system.
  */
 #ifndef RUMBLE_H
 #define RUMBLE_H

include/screen.h

@@ -1,5 +1,7 @@
 /**
  * @file screen.h
+ *
+ * @brief User interface manager.
  */
 #ifndef SCREEN_H
 #define SCREEN_H

include/shd.h

@@ -1,5 +1,7 @@
 /**
  * @file shd.h
+ *
+ * @brief Shaders.
  */
 #ifndef SHD_H
 #define SHD_H

include/sound.h

@@ -1,5 +1,7 @@
 /**
  * @file sound.h
+ *
+ * @brief Sound playback.
  */
 #ifndef SOUND_H
 #define SOUND_H

include/speaker.h

@@ -1,5 +1,7 @@
 /**
  * @file speaker.h
+ *
+ * @brief Sound speaker management.
  */
 #ifndef SPEAKER_H
 #define SPEAKER_H

include/sw.h

@@ -1,5 +1,7 @@
 /**
  * @file sw.h
+ *
+ * @brief Scene world?
  */
 #ifndef SW_H
 #define SW_H

include/transition.h

@@ -1,5 +1,7 @@
 /**
  * @file transition.h
+ *
+ * @brief Level transitions.
  */
 #ifndef TRANSITION_H
 #define TRANSITION_H

include/types.h

@@ -1,7 +1,7 @@
 /**
  * @file types.h
  *
- * @brief Defines types used throughout the game.
+ * @brief Types used throughout the engine.
 */
 #ifndef TYPES_H
 #define TYPES_H

include/vec.h

@@ -1,7 +1,7 @@
 /**
  * @file vec.h
  *
- * @brief Declares VECTOR and other related classes/functions.
+ * @brief Vector math functions.
  */
 #ifndef VEC_H
 #define VEC_H

include/zap.h

@@ -1,5 +1,7 @@
 /**
  * @file zap.h
+ *
+ * @brief Damage system.
  */
 #ifndef ZAP_H
 #define ZAP_H