add cross-reference for overwritten pbdrv handlers in main controller software

4 files changed, 22 insertions, 1 deletions

diff --git a/lib/pbdrv/pb-route.h b/lib/pbdrv/pb-route.h
index b80e4ec..2a28c0b 100644
--- a/lib/pbdrv/pb-route.h
+++ b/lib/pbdrv/pb-route.h
@@ -98,6 +98,7 @@ void pb_route_cmd_state_req(pb_msg_t * msg);
  * controller handles this type of command.
  */
 void pb_route_cmd_state_res(pb_msg_t * msg);
+// TODO: add link to pb_route_cmd_state_res handler in main/i2c.c
 /**
  * \brief Handle a \ref PB_CMD_STATE "STATE" message with action \ref
  * PB_ACTION_SET "SET"
@@ -122,7 +123,8 @@ void pb_route_cmd_magic_req(pb_msg_t * msg);
  * PB_ACTION_RES "RES"
  *
  * The default implementation of this function is empty, as only the main
- * controller handles this type of command.
+ * controller handles this type of command. (\ref main_route_cmd_magic_res
+ * "link")
  */
 void pb_route_cmd_magic_res(pb_msg_t * msg);
 
diff --git a/main/i2c.c b/main/i2c.c
index 2503560..f366793 100644
--- a/main/i2c.c
+++ b/main/i2c.c
@@ -41,6 +41,17 @@ void bus_task() {
 	}
 }
 
+/**
+ * \ingroup main_pb_override
+ * \anchor main_route_cmd_magic_res
+ *
+ * This function registers the I2C address of the puzzle module that replied to
+ * the \c MAGIC \c REQ command into a list of "known puzzle modules", which are
+ * then periodically updated during gameplay.
+ *
+ * \note Up to \ref CFG_PB_MOD_MAX puzzle modules can be registered
+ * simultaniously.
+ */
 void pb_route_cmd_magic_res(pb_msg_t * msg) {
 	if (modules_size == CFG_PB_MOD_MAX) return;
 	modules[modules_size++] = msg->sender;
diff --git a/main/i2c.h b/main/i2c.h
index 107a04d..27c0b02 100644
--- a/main/i2c.h
+++ b/main/i2c.h
@@ -15,3 +15,4 @@
 void bus_task();
 
 /// \}
+
diff --git a/main/index.dox b/main/index.dox
index aa2d07a..0fee58a 100644
--- a/main/index.dox
+++ b/main/index.dox
@@ -4,3 +4,10 @@
 \defgroup main_tasks tasks
 \brief Tasks
 */
+
+/**
+\ingroup main
+\defgroup main_pb_override overrides
+\brief Override functions from \ref pbdrv-mod
+*/
+