aboutsummaryrefslogtreecommitdiffstats
path: root/host/include/uhd/rfnoc/switchboard_block_control.hpp
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/include/uhd/rfnoc/switchboard_block_control.hpp
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/include/uhd/rfnoc/switchboard_block_control.hpp')
-rw-r--r--host/include/uhd/rfnoc/switchboard_block_control.hpp2
1 files changed, 2 insertions, 0 deletions
diff --git a/host/include/uhd/rfnoc/switchboard_block_control.hpp b/host/include/uhd/rfnoc/switchboard_block_control.hpp
index 785838806..66ce47ffa 100644
--- a/host/include/uhd/rfnoc/switchboard_block_control.hpp
+++ b/host/include/uhd/rfnoc/switchboard_block_control.hpp
@@ -13,6 +13,8 @@ namespace uhd { namespace rfnoc {
/*! Switchboard Block Control Class
*
+ * \ingroup rfnoc_blocks
+ *
* The Switchboard Block is an RFNoC block that routes any single input to any
* single output. Routing is 1 to 1, that is, an input port can only be connected
* to one output port, and vice versa.