aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/group_defs.dox
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2021-11-03 14:59:36 +0100
committerAaron Rossetto <aaron.rossetto@ni.com>2021-11-05 12:23:12 -0700
commit3063228cf68968b72d63c4aaad3fe2eb6e42305f (patch)
tree16991675205470bdad8ef1d153e2c6f82b630203 /host/docs/group_defs.dox
parent15d8fdc4b93a35a4f8344bfab5a9256e231866ca (diff)
downloaduhd-3063228cf68968b72d63c4aaad3fe2eb6e42305f.tar.gz
uhd-3063228cf68968b72d63c4aaad3fe2eb6e42305f.tar.bz2
uhd-3063228cf68968b72d63c4aaad3fe2eb6e42305f.zip
docs: Collect all RFNoC block controllers in a module in the manual
This lets Doxygen create a page in the UHD manual that lists all RFNoC block controllers. It will be accessible under Manual -> Modules -> RFNoC -> RFNoC Blocks shipped with UHD.
Diffstat (limited to 'host/docs/group_defs.dox')
-rw-r--r--host/docs/group_defs.dox12
1 files changed, 12 insertions, 0 deletions
diff --git a/host/docs/group_defs.dox b/host/docs/group_defs.dox
new file mode 100644
index 000000000..312def6d9
--- /dev/null
+++ b/host/docs/group_defs.dox
@@ -0,0 +1,12 @@
+/*!
+ * \defgroup rfnoc RFNoC
+ * \brief Additional documentation regarding RFNoC
+ *
+ * @{
+ */
+
+/*! \defgroup rfnoc_blocks RFNoC Blocks
+ * \brief Documentation for RFNoC blocks that are part of UHD.
+ */
+
+/*! @} */