aboutsummaryrefslogtreecommitdiff
path: root/main/i2c.h
diff options
context:
space:
mode:
Diffstat (limited to 'main/i2c.h')
-rw-r--r--main/i2c.h14
1 files changed, 13 insertions, 1 deletions
diff --git a/main/i2c.h b/main/i2c.h
index d1173c8..107a04d 100644
--- a/main/i2c.h
+++ b/main/i2c.h
@@ -1,5 +1,17 @@
#pragma once
-//! looking for slave addresses and requesting updates
+/**
+ * \ingroup main_tasks
+ * \{
+ */
+
+/**
+ * \brief I2C bus activity task
+ *
+ * This function does an initial bus scan for puzzle modules, and then goes
+ * into an infinite loop that periodically polls all puzzle modules for their
+ * global state.
+ */
void bus_task();
+/// \}