aboutsummaryrefslogtreecommitdiff
path: root/lib/pbdrv/pb-route.h
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-06-23 13:54:02 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-06-23 13:54:02 +0200
commitbfa85b6c313a725afe98bbe6ccb60978de3187a9 (patch)
tree313ed5e41bbad9438b1740705ee7d220d35c6c44 /lib/pbdrv/pb-route.h
parentf4e7a23309797c56baf6be3a9e99e74596223474 (diff)
add cross-reference for overwritten pbdrv handlers in main controller software
Diffstat (limited to 'lib/pbdrv/pb-route.h')
-rw-r--r--lib/pbdrv/pb-route.h4
1 files changed, 3 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);