1
0
mirror of https://github.com/gnss-sdr/gnss-sdr synced 2025-11-18 16:15:21 +00:00

Make use of Doxygen grouping feature

Improve Modules page in generated HTML documentation
This commit is contained in:
Carles Fernandez
2020-11-01 13:37:19 +01:00
parent 73b909bac1
commit 287284261c
305 changed files with 2769 additions and 112 deletions

View File

@@ -37,6 +37,13 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_gnuradio_blocks signal_source_gr_blocks
* GNU Radio blocks for signal sources.
* \{ */
class Gr_Complex_Ip_Packet_Source : virtual public gr::sync_block
{
public:
@@ -108,4 +115,7 @@ private:
bool d_fifo_full;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GR_COMPLEX_IP_PACKET_SOURCE_H

View File

@@ -32,6 +32,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_gnuradio_blocks
* \{ */
class labsat23_source;
#if GNURADIO_USES_STD_POINTERS
@@ -84,4 +90,7 @@ private:
bool d_header_parsed;
};
/** \} */
/** \} */
#endif // GNSS_SDR_LABSAT23_SOURCE_H

View File

@@ -43,6 +43,13 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_gnuradio_blocks
* \{ */
class rtl_tcp_signal_source_c;
#if GNURADIO_USES_STD_POINTERS
@@ -124,4 +131,7 @@ private:
bool flip_iq_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_RTL_TCP_SIGNAL_SOURCE_C_H

View File

@@ -66,6 +66,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_gnuradio_blocks
* \{ */
class unpack_2bit_samples;
#if GNURADIO_USES_STD_POINTERS
@@ -115,4 +121,7 @@ private:
bool reverse_interleaving_;
};
/** \} */
/** \} */
#endif // GNSS_SDR_UNPACK_2BIT_SAMPLES_H

View File

@@ -31,6 +31,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_gnuradio_blocks
* \{ */
class unpack_byte_2bit_cpx_samples;
#if GNURADIO_USES_STD_POINTERS
@@ -58,4 +64,7 @@ private:
friend unpack_byte_2bit_cpx_samples_sptr make_unpack_byte_2bit_cpx_samples_sptr();
};
/** \} */
/** \} */
#endif // GNSS_SDR_UNPACK_BYTE_2BIT_CPX_SAMPLES_H

View File

@@ -27,6 +27,11 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_gnuradio_blocks
* \{ */
class unpack_byte_2bit_samples;
#if GNURADIO_USES_STD_POINTERS
@@ -54,4 +59,7 @@ private:
friend unpack_byte_2bit_samples_sptr make_unpack_byte_2bit_samples_sptr();
};
/** \} */
/** \} */
#endif // GNSS_SDR_UNPACK_BYTE_2BIT_SAMPLES_H

View File

@@ -24,6 +24,12 @@
#include <gnuradio/sync_interpolator.h>
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_gnuradio_blocks
* \{ */
class unpack_byte_4bit_samples;
using unpack_byte_4bit_samples_sptr = std::shared_ptr<unpack_byte_4bit_samples>;
@@ -47,4 +53,7 @@ private:
friend unpack_byte_4bit_samples_sptr make_unpack_byte_4bit_samples_sptr();
};
/** \} */
/** \} */
#endif // GNSS_SDR_UNPACK_BYTE_4BIT_SAMPLES_H

View File

@@ -27,6 +27,13 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_gnuradio_blocks
* \{ */
class unpack_intspir_1bit_samples;
#if GNURADIO_USES_STD_POINTERS
@@ -54,4 +61,7 @@ private:
friend unpack_intspir_1bit_samples_sptr make_unpack_intspir_1bit_samples_sptr();
};
/** \} */
/** \} */
#endif // GNSS_SDR_UNPACK_INTSPIR_1BIT_SAMPLES_H

View File

@@ -28,6 +28,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_gnuradio_blocks
* \{ */
class unpack_spir_gss6450_samples;
#if GNURADIO_USES_STD_POINTERS
@@ -54,4 +60,7 @@ private:
int samples_per_int;
};
/** \} */
/** \} */
#endif // GNSS_SDR_UNPACK_SPIR_GSS6450_SAMPLES_H