mirror of
https://github.com/gnss-sdr/gnss-sdr
synced 2025-11-26 12:04:55 +00:00
Make use of Doxygen grouping feature
Improve Modules page in generated HTML documentation
This commit is contained in:
@@ -32,6 +32,13 @@
|
||||
#include <map> // for map
|
||||
#include <string> // for string
|
||||
|
||||
/** \addtogroup PVT
|
||||
* Computation of Position, Velocity and Time from GNSS observables.
|
||||
* \{ */
|
||||
/** \addtogroup PVT_adapters pvt_adapters
|
||||
* Wrap GNU Radio PVT solvers with a PvtInterface
|
||||
* \{ */
|
||||
|
||||
class ConfigurationInterface;
|
||||
class Galileo_Almanac;
|
||||
class Galileo_Ephemeris;
|
||||
@@ -99,4 +106,6 @@ private:
|
||||
unsigned int out_streams_;
|
||||
};
|
||||
|
||||
#endif
|
||||
/** \} */
|
||||
/** \} */
|
||||
#endif // GNSS_SDR_RTKLIB_PVT_H
|
||||
|
||||
@@ -41,6 +41,13 @@
|
||||
#include <boost/shared_ptr.hpp>
|
||||
#endif
|
||||
|
||||
/** \addtogroup PVT
|
||||
* \{ */
|
||||
/** \addtogroup PVT_gnuradio_blocks pvt_gr_blocks
|
||||
* GNU Radio blocks for the computation of PVT solutions.
|
||||
* \{ */
|
||||
|
||||
|
||||
class Beidou_Dnav_Almanac;
|
||||
class Beidou_Dnav_Ephemeris;
|
||||
class Galileo_Almanac;
|
||||
@@ -270,4 +277,7 @@ private:
|
||||
bool d_rtcm_enabled;
|
||||
};
|
||||
|
||||
|
||||
/** \} */
|
||||
/** \} */
|
||||
#endif // GNSS_SDR_RTKLIB_PVT_GS_H
|
||||
|
||||
@@ -26,6 +26,12 @@
|
||||
#include <fstream>
|
||||
#include <string>
|
||||
|
||||
/** \addtogroup PVT
|
||||
* \{ */
|
||||
/** \addtogroup PVT_libs
|
||||
* \{ */
|
||||
|
||||
|
||||
class Pvt_Solution;
|
||||
|
||||
/*!
|
||||
@@ -49,4 +55,7 @@ private:
|
||||
bool first_pos;
|
||||
};
|
||||
|
||||
#endif
|
||||
|
||||
/** \} */
|
||||
/** \} */
|
||||
#endif // GNSS_SDR_GEOJSON_PRINTER_H
|
||||
|
||||
@@ -26,6 +26,12 @@
|
||||
#include <fstream>
|
||||
#include <string>
|
||||
|
||||
/** \addtogroup PVT
|
||||
* \{ */
|
||||
/** \addtogroup PVT_libs
|
||||
* \{ */
|
||||
|
||||
|
||||
class Pvt_Solution;
|
||||
|
||||
/*!
|
||||
@@ -50,4 +56,7 @@ private:
|
||||
bool positions_printed;
|
||||
};
|
||||
|
||||
#endif
|
||||
|
||||
/** \} */
|
||||
/** \} */
|
||||
#endif // GNSS_SDR_GPX_PRINTER_H
|
||||
|
||||
@@ -25,6 +25,12 @@
|
||||
#include <fstream> // for ofstream
|
||||
#include <string>
|
||||
|
||||
/** \addtogroup PVT
|
||||
* \{ */
|
||||
/** \addtogroup PVT_libs
|
||||
* \{ */
|
||||
|
||||
|
||||
class Pvt_Solution;
|
||||
|
||||
/*!
|
||||
@@ -52,4 +58,7 @@ private:
|
||||
bool positions_printed;
|
||||
};
|
||||
|
||||
#endif
|
||||
|
||||
/** \} */
|
||||
/** \} */
|
||||
#endif // GNSS_SDR_KML_PRINTER_H
|
||||
|
||||
@@ -23,6 +23,12 @@
|
||||
#include <boost/serialization/nvp.hpp>
|
||||
#include <cstdint>
|
||||
|
||||
/** \addtogroup PVT
|
||||
* \{ */
|
||||
/** \addtogroup PVT_libs
|
||||
* \{ */
|
||||
|
||||
|
||||
/*!
|
||||
* \brief This class contains parameters and outputs of the PVT block
|
||||
*/
|
||||
@@ -131,4 +137,7 @@ public:
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
/** \} */
|
||||
/** \} */
|
||||
#endif // GNSS_SDR_MONITOR_PVT_H
|
||||
|
||||
@@ -28,6 +28,12 @@
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
/** \addtogroup PVT
|
||||
* \{ */
|
||||
/** \addtogroup PVT_libs
|
||||
* \{ */
|
||||
|
||||
|
||||
#if USE_BOOST_ASIO_IO_CONTEXT
|
||||
using b_io_context = boost::asio::io_context;
|
||||
#else
|
||||
@@ -50,4 +56,6 @@ private:
|
||||
};
|
||||
|
||||
|
||||
/** \} */
|
||||
/** \} */
|
||||
#endif // GNSS_SDR_MONITOR_PVT_UDP_SINK_H
|
||||
|
||||
@@ -30,6 +30,12 @@
|
||||
#include <memory> // for shared_ptr
|
||||
#include <string> // for string
|
||||
|
||||
/** \addtogroup PVT
|
||||
* \{ */
|
||||
/** \addtogroup PVT_libs
|
||||
* \{ */
|
||||
|
||||
|
||||
class Rtklib_Solver;
|
||||
|
||||
/*!
|
||||
@@ -82,4 +88,7 @@ private:
|
||||
bool d_flag_nmea_output_file;
|
||||
};
|
||||
|
||||
#endif
|
||||
|
||||
/** \} */
|
||||
/** \} */
|
||||
#endif // GNSS_SDR_NMEA_PRINTER_H
|
||||
|
||||
@@ -24,6 +24,12 @@
|
||||
#include <map>
|
||||
#include <string>
|
||||
|
||||
/** \addtogroup PVT
|
||||
* \{ */
|
||||
/** \addtogroup PVT_libs
|
||||
* \{ */
|
||||
|
||||
|
||||
class Pvt_Conf
|
||||
{
|
||||
public:
|
||||
@@ -81,4 +87,7 @@ public:
|
||||
bool dump_mat;
|
||||
};
|
||||
|
||||
#endif
|
||||
|
||||
/** \} */
|
||||
/** \} */
|
||||
#endif // GNSS_SDR_PVT_CONF_H
|
||||
|
||||
@@ -25,6 +25,11 @@
|
||||
#include <array>
|
||||
#include <deque>
|
||||
|
||||
/** \addtogroup PVT
|
||||
* \{ */
|
||||
/** \addtogroup PVT_libs
|
||||
* \{ */
|
||||
|
||||
|
||||
/*!
|
||||
* \brief Base class for a PVT solution
|
||||
@@ -120,4 +125,7 @@ private:
|
||||
bool d_flag_averaging;
|
||||
};
|
||||
|
||||
#endif
|
||||
|
||||
/** \} */
|
||||
/** \} */
|
||||
#endif // GNSS_SDR_PVT_SOLUTION_H
|
||||
|
||||
@@ -49,6 +49,13 @@
|
||||
#include <sstream> // for stringstream
|
||||
#include <string> // for string
|
||||
|
||||
|
||||
/** \addtogroup PVT
|
||||
* \{ */
|
||||
/** \addtogroup PVT_libs
|
||||
* \{ */
|
||||
|
||||
|
||||
class Beidou_Dnav_Ephemeris;
|
||||
class Beidou_Dnav_Iono;
|
||||
class Beidou_Dnav_Utc_Model;
|
||||
@@ -906,4 +913,6 @@ inline std::string Rinex_Printer::asString(const X x) const
|
||||
}
|
||||
|
||||
|
||||
#endif
|
||||
/** \} */
|
||||
/** \} */
|
||||
#endif // GNSS_SDR_RINEX_PRINTER_H
|
||||
|
||||
@@ -48,6 +48,12 @@
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
|
||||
/** \addtogroup PVT
|
||||
* \{ */
|
||||
/** \addtogroup PVT_libs
|
||||
* \{ */
|
||||
|
||||
|
||||
#if USE_BOOST_ASIO_IO_CONTEXT
|
||||
using b_io_context = boost::asio::io_context;
|
||||
#else
|
||||
@@ -1466,4 +1472,7 @@ private:
|
||||
int32_t set_DF420(const Gnss_Synchro& gnss_synchro);
|
||||
};
|
||||
|
||||
#endif
|
||||
|
||||
/** \} */
|
||||
/** \} */
|
||||
#endif // GNSS_SDR_RTCM_H
|
||||
|
||||
@@ -29,6 +29,12 @@
|
||||
#include <memory> // std::shared_ptr
|
||||
#include <string>
|
||||
|
||||
/** \addtogroup PVT
|
||||
* \{ */
|
||||
/** \addtogroup PVT_libs
|
||||
* \{ */
|
||||
|
||||
|
||||
class Galileo_Ephemeris;
|
||||
class Glonass_Gnav_Ephemeris;
|
||||
class Glonass_Gnav_Utc_Model;
|
||||
@@ -161,4 +167,7 @@ private:
|
||||
bool d_rtcm_file_dump;
|
||||
};
|
||||
|
||||
#endif
|
||||
|
||||
/** \} */
|
||||
/** \} */
|
||||
#endif // GNSS_SDR_RTCM_PRINTER_H
|
||||
|
||||
@@ -62,6 +62,12 @@
|
||||
#include <map>
|
||||
#include <string>
|
||||
|
||||
/** \addtogroup PVT
|
||||
* \{ */
|
||||
/** \addtogroup PVT_libs pvt_libs
|
||||
* Library for the computation of PVT solutions.
|
||||
* \{ */
|
||||
|
||||
|
||||
/*!
|
||||
* \brief This class implements a PVT solution based on RTKLIB
|
||||
@@ -121,4 +127,7 @@ private:
|
||||
bool d_flag_dump_mat_enabled;
|
||||
};
|
||||
|
||||
|
||||
/** \} */
|
||||
/** \} */
|
||||
#endif // GNSS_SDR_RTKLIB_SOLVER_H
|
||||
|
||||
@@ -27,6 +27,12 @@
|
||||
#include <string>
|
||||
#include <utility>
|
||||
|
||||
/** \addtogroup PVT
|
||||
* \{ */
|
||||
/** \addtogroup PVT_libs
|
||||
* \{ */
|
||||
|
||||
|
||||
/*!
|
||||
* \brief This class implements serialization and deserialization of
|
||||
* Monitor_Pvt objects using Protocol Buffers.
|
||||
@@ -152,4 +158,7 @@ private:
|
||||
gnss_sdr::MonitorPvt monitor_{};
|
||||
};
|
||||
|
||||
|
||||
/** \} */
|
||||
/** \} */
|
||||
#endif // GNSS_SDR_SERDES_MONITOR_PVT_H
|
||||
|
||||
Reference in New Issue
Block a user