aboutsummaryrefslogtreecommitdiff
path: root/lib/pbdrv/index.dox
diff options
context:
space:
mode:
Diffstat (limited to 'lib/pbdrv/index.dox')
-rw-r--r--lib/pbdrv/index.dox5
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/pbdrv/index.dox b/lib/pbdrv/index.dox
index 8ddcb6a..0be5f33 100644
--- a/lib/pbdrv/index.dox
+++ b/lib/pbdrv/index.dox
@@ -68,6 +68,11 @@ extend or conditionally replace the default handlers), without needing to
completely overwrite the built-in handlers or understand the internals of \ref
pbdrv-mod.
+The boolean value returned by some hooks (e.g. those under \ref pb_hook_route
+or \ref pb_hook_i2c) represents if the default handler should run after the
+hook returns. This allow you to conditionally 'catch' calls to their respective
+base functions by returning \c true.
+
\}
*/