1
0
mirror of https://github.com/gnss-sdr/gnss-sdr synced 2025-11-13 05:37:20 +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

@@ -26,6 +26,12 @@
#include <cstdint>
#include <string>
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_libs signal_source_libs
* Library with utilities for signal sources.
* \{ */
#define FIR_BUF_SIZE 8192
/* RX is input, TX is output */
@@ -135,4 +141,7 @@ bool disable_ad9361_rx_local();
bool disable_ad9361_rx_remote(const std::string &remote_host);
/** \} */
/** \} */
#endif // GNSS_SDR_AD9361_MANAGER_H

View File

@@ -29,6 +29,12 @@
#include <cstdint>
#include <string>
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_libs
* \{ */
/*!
* \brief Class that controls the switch in the FPGA, which connects the FPGA acquisition and multicorrelator modules to
* either the DMA or the Analog Front-End.
@@ -77,4 +83,7 @@ private:
int d_device_descriptor2; // driver descriptor corresponding to frequency band 2
};
/** \} */
/** \} */
#endif // GNSS_SDR_FPGA_DYNAMIC_BIT_SELECTION_H

View File

@@ -28,6 +28,12 @@
#include <string>
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_libs
* \{ */
/*!
* \brief Class that controls the switch in the FPGA, which connects the FPGA acquisition and multicorrelator modules to
* either the DMA or the Analog Front-End.
@@ -63,4 +69,7 @@ private:
int d_device_descriptor; // driver descriptor
};
/** \} */
/** \} */
#endif // GNSS_SDR_FPGA_SWITCH_H

View File

@@ -35,6 +35,12 @@
#include <boost/shared_ptr.hpp>
#endif
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_libs
* \{ */
class Gnss_Sdr_Valve;
#if GNURADIO_USES_STD_POINTERS
@@ -109,4 +115,7 @@ private:
bool d_open_valve;
};
/** \} */
/** \} */
#endif // GNSS_SDR_GNSS_SDR_VALVE_H

View File

@@ -24,6 +24,12 @@
#include <boost/asio/ip/tcp.hpp> // for tcp, tcp::socket
#include <boost/system/error_code.hpp> // for error_code
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_libs
* \{ */
/// Command IDs for configuration rtl_tcp
enum RTL_TCP_COMMAND
{
@@ -42,4 +48,7 @@ enum RTL_TCP_COMMAND
boost::system::error_code rtl_tcp_command(RTL_TCP_COMMAND id, unsigned param,
boost::asio::ip::tcp::socket &socket);
/** \} */
/** \} */
#endif // GNSS_SDR_RTL_TCP_COMMANDS_H

View File

@@ -24,6 +24,13 @@
#include <boost/asio/ip/tcp.hpp>
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_libs
* \{ */
/*!
* \brief This class represents the dongle information
* which is sent by rtl_tcp.
@@ -69,4 +76,6 @@ private:
};
/** \} */
/** \} */
#endif // GNSS_SDR_RTL_TCP_DONGLE_INFO_H