controllers: add top-level docs to classes.

lnls-dig · Jan 15, 2025 · 19b959d · 19b959d
1 parent a034fde
commit 19b959d
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/util/controllers.h b/util/controllers.h
@@ -28,6 +28,10 @@ class RegisterController: public RegisterDecoderBase {
     virtual void write_params();
 };
 
+/** Controller base class which can use the register fields as decoded by a
+ * RegisterDecoder to write into a device's registers. Any register field that
+ * should be exposed as writable should be decoded by the `rf_` prefixed
+ * functions from RegisterDecoder, instead of the functions from util-bits.h. */
 class RegisterDecoderController: public RegisterController {
     RegisterDecoder *pdec;