add doxygen

17 files changed, 36 insertions, 2 deletions

diff --git a/robot/errcatch.h b/robot/errcatch.h
index 836da1b..add4ece 100644
--- a/robot/errcatch.h
+++ b/robot/errcatch.h
@@ -1,5 +1,7 @@
 #pragma once
 
+/** @file errcatch.h */
+
 #include <stdint.h>
 
 #include "../shared/consts.h"
diff --git a/robot/hypervisor.h b/robot/hypervisor.h
index 5008c8f..b5dc0ab 100644
--- a/robot/hypervisor.h
+++ b/robot/hypervisor.h
@@ -1,5 +1,7 @@
 #pragma once
 
+/** @file hypervisor.h */
+
 #include <stdint.h>
 
 extern uint64_t g_w2_hypervisor_cycles;
diff --git a/robot/io.h b/robot/io.h
index 3d91799..be0e9b9 100644
--- a/robot/io.h
+++ b/robot/io.h
@@ -1,9 +1,11 @@
 #pragma once
 
+/** @file io.h */
+
 #include "../shared/protocol.h"
 
-/** i/o module main */
+/** @brief i/o module main */
 void w2_io_main();
 
-/** global struct containing all i/o */
+/** @brief global struct containing all i/o */
 extern w2_s_io_all g_w2_io;
diff --git a/robot/main.h b/robot/main.h
index 5b0a1b2..58f849b 100644
--- a/robot/main.h
+++ b/robot/main.h
@@ -1,4 +1,6 @@
 #pragma once
 
+/** @file main.h */
+
 /** program entrypoint */
 int main();
diff --git a/robot/mode_chrg.h b/robot/mode_chrg.h
index d9b5cc0..a870e58 100644
--- a/robot/mode_chrg.h
+++ b/robot/mode_chrg.h
@@ -1,5 +1,7 @@
 #pragma once
 
+/** @file mode_chrg.h */
+
 /**
  * charge station mode
  *
diff --git a/robot/mode_dirc.h b/robot/mode_dirc.h
index 5b9bbf4..12c967a 100644
--- a/robot/mode_dirc.h
+++ b/robot/mode_dirc.h
@@ -1,5 +1,7 @@
 #pragma once
 
+/** @file mode_dirc.h */
+
 #include <stdint.h>
 
 extern int16_t g_w2_mode_dirc_motor_l;
diff --git a/robot/mode_grid.h b/robot/mode_grid.h
index fcf9100..55093ad 100644
--- a/robot/mode_grid.h
+++ b/robot/mode_grid.h
@@ -1,5 +1,7 @@
 #pragma once
 
+/** @file mode_grid.h */
+
 /**
  * warehouse mode
  *
diff --git a/robot/mode_halt.h b/robot/mode_halt.h
index d92905e..b5ac11f 100644
--- a/robot/mode_halt.h
+++ b/robot/mode_halt.h
@@ -1,5 +1,7 @@
 #pragma once
 
+/** @file mode_halt.h */
+
 /**
  * halt (emergency) mode
  *
diff --git a/robot/mode_lcal.h b/robot/mode_lcal.h
index dd373f0..5a43701 100644
--- a/robot/mode_lcal.h
+++ b/robot/mode_lcal.h
@@ -1,5 +1,7 @@
 #pragma once
 
+/** @file mode_lcal.h */
+
 /**
  * calibration mode
  *
diff --git a/robot/mode_maze.h b/robot/mode_maze.h
index 9fbeb8c..e7490b9 100644
--- a/robot/mode_maze.h
+++ b/robot/mode_maze.h
@@ -1,5 +1,7 @@
 #pragma once
 
+/** @file mode_maze.h */
+
 /**
  * maze mode
  *
diff --git a/robot/mode_scal.h b/robot/mode_scal.h
index 4f1f04d..c427d4b 100644
--- a/robot/mode_scal.h
+++ b/robot/mode_scal.h
@@ -1,5 +1,7 @@
 #pragma once
 
+/** @file mode_scal.h */
+
 /**
  * sensor calibration mode
  *
diff --git a/robot/mode_spin.h b/robot/mode_spin.h
index 926137e..1f721dc 100644
--- a/robot/mode_spin.h
+++ b/robot/mode_spin.h
@@ -1,5 +1,7 @@
 #pragma once
 
+/** @file mode_spin.h */
+
 /**
  * wet floor simulation
  *
diff --git a/robot/modes.h b/robot/modes.h
index 3423a0f..122be4a 100644
--- a/robot/modes.h
+++ b/robot/modes.h
@@ -1,5 +1,7 @@
 #pragma once
 
+/** @file modes.h */
+
 #include "../shared/consts.h"
 
 #include "mode_chrg.h"
diff --git a/robot/orangutan_shim.h b/robot/orangutan_shim.h
index 10420bd..cbb0995 100644
--- a/robot/orangutan_shim.h
+++ b/robot/orangutan_shim.h
@@ -1,5 +1,7 @@
 #pragma once
 
+/** @file orangutan_shim.h */
+
 #ifdef W2_SIM
 #include "sim.h"
 #else
diff --git a/robot/sercomm.h b/robot/sercomm.h
index b1f69c7..13625c0 100644
--- a/robot/sercomm.h
+++ b/robot/sercomm.h
@@ -1,5 +1,7 @@
 #pragma once
 
+/** @file sercomm.h */
+
 #include "../shared/bin.h"
 #include "../shared/consts.h"
 #include "../shared/protocol.h"
diff --git a/robot/setup.h b/robot/setup.h
index 17ac78d..450e102 100644
--- a/robot/setup.h
+++ b/robot/setup.h
@@ -1,5 +1,7 @@
 #pragma once
 
+/** @file setup.h */
+
 /**
  * runs once at startup, plays beep when setup finishes
  *
diff --git a/robot/sim.h b/robot/sim.h
index 08c1d8a..76b57f8 100644
--- a/robot/sim.h
+++ b/robot/sim.h
@@ -1,5 +1,7 @@
 #pragma once
 
+/** @file sim.h */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <unistd.h>