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.

19 files changed, 51 insertions, 2 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.
+ */
+
+/*! @} */
diff --git a/host/include/uhd/rfnoc/addsub_block_control.hpp b/host/include/uhd/rfnoc/addsub_block_control.hpp
index 7f73610af..f038c9919 100644
--- a/host/include/uhd/rfnoc/addsub_block_control.hpp
+++ b/host/include/uhd/rfnoc/addsub_block_control.hpp
@@ -13,6 +13,8 @@ namespace uhd { namespace rfnoc {
 
 /*! Add/Sub Block Control Class
  *
+ * \ingroup rfnoc_blocks
+ *
  * The Add/Sub RFNoC block takes in two streams of sc16-formatted data and
  * performs addition and subtraction on the data in the stream, creating two
  * output streams consisting of the sum and difference of the input streams.
diff --git a/host/include/uhd/rfnoc/block_control.hpp b/host/include/uhd/rfnoc/block_control.hpp
index 7b02c1e0f..43e0d5c05 100644
--- a/host/include/uhd/rfnoc/block_control.hpp
+++ b/host/include/uhd/rfnoc/block_control.hpp
@@ -12,6 +12,8 @@
 namespace uhd { namespace rfnoc {
 
 /*! A default block controller for blocks that can't be found in the registry
+ *
+ * \ingroup rfnoc_blocks
  */
 class UHD_API block_control : public noc_block_base
 {
diff --git a/host/include/uhd/rfnoc/ddc_block_control.hpp b/host/include/uhd/rfnoc/ddc_block_control.hpp
index 053b78c4c..c876d0f04 100644
--- a/host/include/uhd/rfnoc/ddc_block_control.hpp
+++ b/host/include/uhd/rfnoc/ddc_block_control.hpp
@@ -15,6 +15,8 @@ namespace uhd { namespace rfnoc {
 
 /*! DDC Block Control Class
  *
+ * \ingroup rfnoc_blocks
+ *
  * The DDC Block is a multi-channel digital downconverter (DDC) with built-in
  * frequency shift. The number of channels as well as the maximum decimation is
  * configurable in the FPGA, the block controller will read out registers to
diff --git a/host/include/uhd/rfnoc/dmafifo_block_control.hpp b/host/include/uhd/rfnoc/dmafifo_block_control.hpp
index 126751a2d..78f7097ab 100644
--- a/host/include/uhd/rfnoc/dmafifo_block_control.hpp
+++ b/host/include/uhd/rfnoc/dmafifo_block_control.hpp
@@ -12,6 +12,8 @@
 namespace uhd { namespace rfnoc {
 
 /*! DMA FIFO Block Control Class
+ *
+ * \ingroup rfnoc_blocks
  */
 class UHD_API dmafifo_block_control : public noc_block_base
 {
diff --git a/host/include/uhd/rfnoc/duc_block_control.hpp b/host/include/uhd/rfnoc/duc_block_control.hpp
index 7e398454d..cf5539392 100644
--- a/host/include/uhd/rfnoc/duc_block_control.hpp
+++ b/host/include/uhd/rfnoc/duc_block_control.hpp
@@ -16,6 +16,8 @@ namespace uhd { namespace rfnoc {
 
 /*! DUC Block Control Class
  *
+ * \ingroup rfnoc_blocks
+ *
  * The DUC Block is a multi-channel digital upconverter (DUC) with built-in
  * frequency shift. The number of channels as well as the maximum interpolation
  * is configurable in the FPGA, the block controller will read out registers to
diff --git a/host/include/uhd/rfnoc/fft_block_control.hpp b/host/include/uhd/rfnoc/fft_block_control.hpp
index 38ad70561..1352c82c6 100644
--- a/host/include/uhd/rfnoc/fft_block_control.hpp
+++ b/host/include/uhd/rfnoc/fft_block_control.hpp
@@ -24,6 +24,8 @@ static const std::string PROP_KEY_SHIFT_CONFIG = "shift_config";
 
 /*! FFT Block Control Class
  *
+ * \ingroup rfnoc_blocks
+ *
  * The FFT block is an RFNoC block that accepts signed complex 16-bit data
  * at its input and computes the forward or reverse FFT of the input data,
  * outputting signed complex 16-bit data at its output. The output data
diff --git a/host/include/uhd/rfnoc/fir_filter_block_control.hpp b/host/include/uhd/rfnoc/fir_filter_block_control.hpp
index d44a0b25a..99526e5ee 100644
--- a/host/include/uhd/rfnoc/fir_filter_block_control.hpp
+++ b/host/include/uhd/rfnoc/fir_filter_block_control.hpp
@@ -14,6 +14,8 @@ namespace uhd { namespace rfnoc {
 
 /*! FIR Filter Block Control Class
  *
+ * \ingroup rfnoc_blocks
+ *
  * The FIR Filter Block is a finite impulse response filter block for RFNoC.
  *
  * The RFNoC FIR block supports one input and output port of sc16 data
diff --git a/host/include/uhd/rfnoc/fosphor_block_control.hpp b/host/include/uhd/rfnoc/fosphor_block_control.hpp
index 965b733a7..750c8b503 100644
--- a/host/include/uhd/rfnoc/fosphor_block_control.hpp
+++ b/host/include/uhd/rfnoc/fosphor_block_control.hpp
@@ -19,8 +19,9 @@ enum class fosphor_waterfall_predivision_ratio {
     RATIO_1_256
 };
 
-/*!
- * Fosphor Control Class
+/*! Fosphor Control Class
+ *
+ * \ingroup rfnoc_blocks
  *
  * The Fosphor Block is an RFNoC block that accepts FFT data as signed
  * complex 16-bit data and produces two streams of eight-bit data, a
diff --git a/host/include/uhd/rfnoc/keep_one_in_n_block_control.hpp b/host/include/uhd/rfnoc/keep_one_in_n_block_control.hpp
index fc6f0511b..23c58474d 100644
--- a/host/include/uhd/rfnoc/keep_one_in_n_block_control.hpp
+++ b/host/include/uhd/rfnoc/keep_one_in_n_block_control.hpp
@@ -14,6 +14,8 @@ namespace uhd { namespace rfnoc {
 
 /*! Keep One in N Block Control Class
  *
+ * \ingroup rfnoc_blocks
+ *
  * The Keep One in N block has two modes: sample mode and packet mode.
  * In sample mode, the first sample is kept and then N-1 samples are dropped.
  * Packet mode is similar to sample mode, except a packet of samples is kept
diff --git a/host/include/uhd/rfnoc/logpwr_block_control.hpp b/host/include/uhd/rfnoc/logpwr_block_control.hpp
index 45b4b61a3..d3398c56f 100644
--- a/host/include/uhd/rfnoc/logpwr_block_control.hpp
+++ b/host/include/uhd/rfnoc/logpwr_block_control.hpp
@@ -13,6 +13,8 @@ namespace uhd { namespace rfnoc {
 
 /*! Log Power Block Control Class
  *
+ * \ingroup rfnoc_blocks
+ *
  * The Log Power Block is an RFNoC block that takes in a packet of signed
  * 16-bit complex samples and computes an estimate of 1024 * log2(i^2 + q^2),
  * putting the result in the upper 16 bits of each 32-bit output sample.
diff --git a/host/include/uhd/rfnoc/null_block_control.hpp b/host/include/uhd/rfnoc/null_block_control.hpp
index f78cb72f7..cb176f479 100644
--- a/host/include/uhd/rfnoc/null_block_control.hpp
+++ b/host/include/uhd/rfnoc/null_block_control.hpp
@@ -12,6 +12,10 @@
 
 namespace uhd { namespace rfnoc {
 
+/*! Null block: Bit bucket or -sink
+ *
+ * \ingroup rfnoc_blocks
+ */
 class UHD_API null_block_control : public noc_block_base
 {
 public:
diff --git a/host/include/uhd/rfnoc/radio_control.hpp b/host/include/uhd/rfnoc/radio_control.hpp
index 06f889a8a..ffa9b64fe 100644
--- a/host/include/uhd/rfnoc/radio_control.hpp
+++ b/host/include/uhd/rfnoc/radio_control.hpp
@@ -21,6 +21,8 @@
 namespace uhd { namespace rfnoc {
 
 /*! Parent class for radio block controllers
+ *
+ * \ingroup rfnoc_blocks
  */
 class radio_control : public noc_block_base,
                       public rf_control::core_iface,
diff --git a/host/include/uhd/rfnoc/replay_block_control.hpp b/host/include/uhd/rfnoc/replay_block_control.hpp
index a3f2ce90d..dc56d59e0 100644
--- a/host/include/uhd/rfnoc/replay_block_control.hpp
+++ b/host/include/uhd/rfnoc/replay_block_control.hpp
@@ -13,6 +13,8 @@ namespace uhd { namespace rfnoc {
 
 /*! Replay Block Control CLass
  *
+ * \ingroup rfnoc_blocks
+ *
  * The Replay block records data to memory and plays back data from memory.
  *
  * It is the responsibility of the user to manage the memory. Care must be taken to avoid
diff --git a/host/include/uhd/rfnoc/siggen_block_control.hpp b/host/include/uhd/rfnoc/siggen_block_control.hpp
index 319a1a605..86fd50cf3 100644
--- a/host/include/uhd/rfnoc/siggen_block_control.hpp
+++ b/host/include/uhd/rfnoc/siggen_block_control.hpp
@@ -17,6 +17,8 @@ enum class siggen_waveform { CONSTANT, SINE_WAVE, NOISE };
 
 /*! Siggen Control Class
  *
+ * \ingroup rfnoc_blocks
+ *
  * The Siggen Block is an RFNoC block that acts as a simple function
  * generating source block. The block supports three functions: generating a
  * constant value, generating a sinusoidal wave with a configurable amplitude
diff --git a/host/include/uhd/rfnoc/split_stream_block_control.hpp b/host/include/uhd/rfnoc/split_stream_block_control.hpp
index e6efc4100..5a4d96e04 100644
--- a/host/include/uhd/rfnoc/split_stream_block_control.hpp
+++ b/host/include/uhd/rfnoc/split_stream_block_control.hpp
@@ -13,6 +13,8 @@ namespace uhd { namespace rfnoc {
 
 /*! Split Stream Block Control Class
  *
+ * \ingroup rfnoc_blocks
+ *
  * The Split Stream Block is an RFNoC block that takes in a single CHDR
  * stream and duplicates it, creating a number of output streams for each
  * input stream. The number of streams is defined by the NUM_PORTS parameter
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.
diff --git a/host/include/uhd/rfnoc/vector_iir_block_control.hpp b/host/include/uhd/rfnoc/vector_iir_block_control.hpp
index 2c1cc7c0e..871dbeffe 100644
--- a/host/include/uhd/rfnoc/vector_iir_block_control.hpp
+++ b/host/include/uhd/rfnoc/vector_iir_block_control.hpp
@@ -13,6 +13,8 @@ namespace uhd { namespace rfnoc {
 
 /*! Vector IIR Block Control Class
  *
+ * \ingroup rfnoc_blocks
+ *
  * The Vector IIR Block is an RFNoC block that implements an infinite
  * impulse filter with a variable length delay line. The transfer
  * function is defined as follows:
diff --git a/host/include/uhd/rfnoc/window_block_control.hpp b/host/include/uhd/rfnoc/window_block_control.hpp
index 0ab6a6375..250f180ce 100644
--- a/host/include/uhd/rfnoc/window_block_control.hpp
+++ b/host/include/uhd/rfnoc/window_block_control.hpp
@@ -14,6 +14,8 @@ namespace uhd { namespace rfnoc {
 
 /*! Window Block Control Class
  *
+ * \ingroup rfnoc_blocks
+ *
  * The Window Block is a windowing block for RFNoC that is intended to be
  * used with the FFT block. The block can be configured with coefficients,
  * by which the samples in each input packet are multiplied before begin