From 287284261cb04c471bffd3e3a35f20fe3a55c95a Mon Sep 17 00:00:00 2001 From: Carles Fernandez Date: Sun, 1 Nov 2020 13:37:19 +0100 Subject: [PATCH] Make use of Doxygen grouping feature Improve Modules page in generated HTML documentation --- docs/changelog.md | 2 ++ src/algorithms/PVT/adapters/rtklib_pvt.h | 11 ++++++++++- .../PVT/gnuradio_blocks/rtklib_pvt_gs.h | 10 ++++++++++ src/algorithms/PVT/libs/geojson_printer.h | 11 ++++++++++- src/algorithms/PVT/libs/gpx_printer.h | 11 ++++++++++- src/algorithms/PVT/libs/kml_printer.h | 11 ++++++++++- src/algorithms/PVT/libs/monitor_pvt.h | 9 +++++++++ src/algorithms/PVT/libs/monitor_pvt_udp_sink.h | 8 ++++++++ src/algorithms/PVT/libs/nmea_printer.h | 11 ++++++++++- src/algorithms/PVT/libs/pvt_conf.h | 11 ++++++++++- src/algorithms/PVT/libs/pvt_solution.h | 10 +++++++++- src/algorithms/PVT/libs/rinex_printer.h | 11 ++++++++++- src/algorithms/PVT/libs/rtcm.h | 11 ++++++++++- src/algorithms/PVT/libs/rtcm_printer.h | 11 ++++++++++- src/algorithms/PVT/libs/rtklib_solver.h | 9 +++++++++ src/algorithms/PVT/libs/serdes_monitor_pvt.h | 9 +++++++++ .../adapters/beidou_b1i_pcps_acquisition.h | 8 ++++++++ .../adapters/beidou_b3i_pcps_acquisition.h | 8 ++++++++ .../galileo_e1_pcps_8ms_ambiguous_acquisition.h | 9 +++++++++ .../galileo_e1_pcps_ambiguous_acquisition.h | 8 ++++++++ .../galileo_e1_pcps_ambiguous_acquisition_fpga.h | 8 ++++++++ ...alileo_e1_pcps_cccwsr_ambiguous_acquisition.h | 9 +++++++++ ...leo_e1_pcps_quicksync_ambiguous_acquisition.h | 8 ++++++++ .../galileo_e1_pcps_tong_ambiguous_acquisition.h | 9 +++++++++ .../galileo_e5a_noncoherent_iq_acquisition_caf.h | 9 +++++++++ .../adapters/galileo_e5a_pcps_acquisition.h | 9 +++++++++ .../adapters/galileo_e5a_pcps_acquisition_fpga.h | 9 +++++++++ .../adapters/galileo_e5b_pcps_acquisition.h | 9 +++++++++ .../adapters/galileo_e5b_pcps_acquisition_fpga.h | 9 +++++++++ .../adapters/glonass_l1_ca_pcps_acquisition.h | 9 +++++++++ .../adapters/glonass_l2_ca_pcps_acquisition.h | 9 +++++++++ .../adapters/gps_l1_ca_pcps_acquisition.h | 10 ++++++++++ .../gps_l1_ca_pcps_acquisition_fine_doppler.h | 9 +++++++++ .../adapters/gps_l1_ca_pcps_acquisition_fpga.h | 8 ++++++++ .../gps_l1_ca_pcps_assisted_acquisition.h | 9 +++++++++ .../adapters/gps_l1_ca_pcps_opencl_acquisition.h | 9 +++++++++ .../gps_l1_ca_pcps_quicksync_acquisition.h | 9 +++++++++ .../adapters/gps_l1_ca_pcps_tong_acquisition.h | 9 +++++++++ .../adapters/gps_l2_m_pcps_acquisition.h | 8 ++++++++ .../adapters/gps_l2_m_pcps_acquisition_fpga.h | 9 +++++++++ .../adapters/gps_l5i_pcps_acquisition.h | 8 ++++++++ .../adapters/gps_l5i_pcps_acquisition_fpga.h | 9 +++++++++ ...lileo_e5a_noncoherent_iq_acquisition_caf_cc.h | 9 +++++++++ .../galileo_pcps_8ms_acquisition_cc.h | 9 +++++++++ .../gnuradio_blocks/pcps_acquisition.h | 11 +++++++++++ .../pcps_acquisition_fine_doppler_cc.h | 11 ++++++++++- .../gnuradio_blocks/pcps_acquisition_fpga.h | 9 +++++++++ .../pcps_assisted_acquisition_cc.h | 9 +++++++++ .../gnuradio_blocks/pcps_cccwsr_acquisition_cc.h | 8 ++++++++ .../gnuradio_blocks/pcps_opencl_acquisition_cc.h | 11 ++++++++++- .../pcps_quicksync_acquisition_cc.h | 9 +++++++++ .../gnuradio_blocks/pcps_tong_acquisition_cc.h | 9 +++++++++ src/algorithms/acquisition/libs/acq_conf.h | 12 +++++++++++- .../acquisition/libs/fpga_acquisition.h | 9 +++++++++ src/algorithms/channel/adapters/channel.h | 15 ++++++++++++++- src/algorithms/channel/libs/channel_fsm.h | 9 +++++++++ .../channel/libs/channel_msg_receiver_cc.h | 9 +++++++++ .../adapters/array_signal_conditioner.h | 8 ++++++++ .../conditioner/adapters/signal_conditioner.h | 11 +++++++++++ .../data_type_adapter/adapters/byte_to_short.h | 13 ++++++++++++- .../data_type_adapter/adapters/ibyte_to_cbyte.h | 11 ++++++++++- .../adapters/ibyte_to_complex.h | 11 ++++++++++- .../data_type_adapter/adapters/ibyte_to_cshort.h | 10 +++++++++- .../adapters/ishort_to_complex.h | 11 ++++++++++- .../adapters/ishort_to_cshort.h | 10 +++++++++- .../interleaved_byte_to_complex_byte.h | 10 ++++++++++ .../interleaved_byte_to_complex_short.h | 9 +++++++++ .../interleaved_short_to_complex_short.h | 9 +++++++++ .../input_filter/adapters/beamformer_filter.h | 9 +++++++++ .../input_filter/adapters/fir_filter.h | 13 ++++++++++++- .../adapters/freq_xlating_fir_filter.h | 9 +++++++++ .../input_filter/adapters/notch_filter.h | 9 +++++++++ .../input_filter/adapters/notch_filter_lite.h | 9 +++++++++ .../adapters/pulse_blanking_filter.h | 9 +++++++++ .../input_filter/gnuradio_blocks/beamformer.h | 9 +++++++++ .../input_filter/gnuradio_blocks/notch_cc.h | 15 ++++++++++++--- .../input_filter/gnuradio_blocks/notch_lite_cc.h | 15 ++++++++++++--- .../gnuradio_blocks/pulse_blanking_cc.h | 16 +++++++++++++--- .../libs/beidou_b1i_signal_processing.h | 11 +++++++++++ .../libs/beidou_b3i_signal_processing.h | 8 ++++++++ src/algorithms/libs/byte_x2_to_complex_byte.h | 10 +++++++++- src/algorithms/libs/complex_byte_to_float_x2.h | 11 ++++++++++- .../libs/complex_float_to_complex_byte.h | 10 +++++++++- src/algorithms/libs/conjugate_cc.h | 11 ++++++++++- src/algorithms/libs/conjugate_ic.h | 11 ++++++++++- src/algorithms/libs/conjugate_sc.h | 11 ++++++++++- src/algorithms/libs/cshort_to_float_x2.h | 11 ++++++++++- .../libs/galileo_e1_signal_processing.h | 8 ++++++++ .../libs/galileo_e5_signal_processing.h | 9 +++++++++ src/algorithms/libs/geofunctions.h | 9 +++++++++ .../libs/glonass_l1_signal_processing.h | 9 +++++++++ .../libs/glonass_l2_signal_processing.h | 9 +++++++++ src/algorithms/libs/gnss_circular_deque.h | 9 +++++++++ src/algorithms/libs/gnss_sdr_create_directory.h | 11 ++++++++++- src/algorithms/libs/gnss_sdr_flags.h | 16 +++++++++++++--- src/algorithms/libs/gnss_sdr_make_unique.h | 9 +++++++++ src/algorithms/libs/gnss_signal_processing.h | 9 +++++++++ src/algorithms/libs/gps_l2c_signal.h | 9 +++++++++ src/algorithms/libs/gps_l5_signal.h | 8 ++++++++ src/algorithms/libs/gps_sdr_signal_processing.h | 9 +++++++++ src/algorithms/libs/item_type_helpers.h | 11 ++++++++++- src/algorithms/libs/pass_through.h | 10 +++++++++- src/algorithms/libs/rtklib/rtklib.h | 9 ++++++++- src/algorithms/libs/rtklib/rtklib_conversions.h | 9 +++++++++ src/algorithms/libs/rtklib/rtklib_rtkpos.h | 10 +++++++++- src/algorithms/libs/rtklib/rtklib_solution.h | 10 +++++++++- src/algorithms/libs/short_x2_to_cshort.h | 11 ++++++++++- .../observables/adapters/hybrid_observables.h | 9 +++++++++ .../gnuradio_blocks/hybrid_observables_gs.h | 8 ++++++++ src/algorithms/observables/libs/obs_conf.h | 10 +++++++++- .../adapters/direct_resampler_conditioner.h | 9 +++++++++ .../adapters/mmse_resampler_conditioner.h | 11 +++++++++++ .../direct_resampler_conditioner_cb.h | 10 ++++++++++ .../direct_resampler_conditioner_cc.h | 9 +++++++++ .../direct_resampler_conditioner_cs.h | 9 +++++++++ .../adapters/ad9361_fpga_signal_source.h | 10 ++++++++++ .../adapters/custom_udp_signal_source.h | 8 ++++++++ .../signal_source/adapters/file_signal_source.h | 11 +++++++++++ .../adapters/flexiband_signal_source.h | 9 +++++++++ .../adapters/fmcomms2_signal_source.h | 9 +++++++++ .../signal_source/adapters/gen_signal_source.h | 10 ++++++++++ .../signal_source/adapters/gn3s_signal_source.h | 8 ++++++++ .../adapters/labsat_signal_source.h | 8 ++++++++ .../adapters/multichannel_file_signal_source.h | 10 ++++++++++ .../adapters/nsr_file_signal_source.h | 8 ++++++++ .../adapters/osmosdr_signal_source.h | 8 ++++++++ .../adapters/plutosdr_signal_source.h | 8 ++++++++ .../adapters/raw_array_signal_source.h | 10 ++++++++++ .../adapters/rtl_tcp_signal_source.h | 9 +++++++++ .../adapters/spir_file_signal_source.h | 10 ++++++++++ .../adapters/spir_gss6450_file_signal_source.h | 9 +++++++++ .../adapters/two_bit_cpx_file_signal_source.h | 8 ++++++++ .../adapters/two_bit_packed_file_signal_source.h | 9 +++++++++ .../signal_source/adapters/uhd_signal_source.h | 8 ++++++++ .../gr_complex_ip_packet_source.h | 10 ++++++++++ .../gnuradio_blocks/labsat23_source.h | 9 +++++++++ .../gnuradio_blocks/rtl_tcp_signal_source_c.h | 10 ++++++++++ .../gnuradio_blocks/unpack_2bit_samples.h | 9 +++++++++ .../unpack_byte_2bit_cpx_samples.h | 9 +++++++++ .../gnuradio_blocks/unpack_byte_2bit_samples.h | 8 ++++++++ .../gnuradio_blocks/unpack_byte_4bit_samples.h | 9 +++++++++ .../unpack_intspir_1bit_samples.h | 10 ++++++++++ .../unpack_spir_gss6450_samples.h | 9 +++++++++ .../signal_source/libs/ad9361_manager.h | 9 +++++++++ .../libs/fpga_dynamic_bit_selection.h | 9 +++++++++ src/algorithms/signal_source/libs/fpga_switch.h | 9 +++++++++ .../signal_source/libs/gnss_sdr_valve.h | 9 +++++++++ .../signal_source/libs/rtl_tcp_commands.h | 9 +++++++++ .../signal_source/libs/rtl_tcp_dongle_info.h | 9 +++++++++ .../adapters/beidou_b1i_telemetry_decoder.h | 9 +++++++++ .../adapters/beidou_b3i_telemetry_decoder.h | 9 +++++++++ .../adapters/galileo_e1b_telemetry_decoder.h | 10 +++++++++- .../adapters/galileo_e5a_telemetry_decoder.h | 9 +++++++++ .../adapters/galileo_e5b_telemetry_decoder.h | 8 ++++++++ .../adapters/glonass_l1_ca_telemetry_decoder.h | 9 +++++++++ .../adapters/glonass_l2_ca_telemetry_decoder.h | 11 ++++++++++- .../adapters/gps_l1_ca_telemetry_decoder.h | 14 +++++++++++++- .../adapters/gps_l2c_telemetry_decoder.h | 12 +++++++++++- .../adapters/gps_l5_telemetry_decoder.h | 10 +++++++++- .../adapters/sbas_l1_telemetry_decoder.h | 9 ++++++++- .../beidou_b1i_telemetry_decoder_gs.h | 9 +++++++++ .../beidou_b3i_telemetry_decoder_gs.h | 10 ++++++++++ .../galileo_telemetry_decoder_gs.h | 9 +++++++++ .../glonass_l1_ca_telemetry_decoder_gs.h | 8 ++++++++ .../glonass_l2_ca_telemetry_decoder_gs.h | 9 +++++++++ .../gps_l1_ca_telemetry_decoder_gs.h | 10 ++++++++++ .../gps_l2c_telemetry_decoder_gs.h | 6 ++++++ .../gps_l5_telemetry_decoder_gs.h | 7 +++++++ .../sbas_l1_telemetry_decoder_gs.h | 9 +++++++++ .../telemetry_decoder/libs/convolutional.h | 11 ++++++++++- .../telemetry_decoder/libs/libswiftcnav/bits.c | 6 ------ .../telemetry_decoder/libs/libswiftcnav/bits.h | 10 ++++++++++ .../libs/libswiftcnav/cnav_msg.h | 6 +++--- .../telemetry_decoder/libs/libswiftcnav/edc.h | 11 ++++++++++- .../libs/libswiftcnav/swift_common.h | 11 +++++++---- .../telemetry_decoder/libs/viterbi_decoder.h | 9 +++++++++ .../adapters/beidou_b1i_dll_pll_tracking.h | 9 +++++++++ .../adapters/beidou_b3i_dll_pll_tracking.h | 9 +++++++++ .../adapters/galileo_e1_dll_pll_veml_tracking.h | 8 ++++++++ .../galileo_e1_dll_pll_veml_tracking_fpga.h | 7 +++++++ .../adapters/galileo_e1_tcp_connector_tracking.h | 8 ++++++++ .../adapters/galileo_e5a_dll_pll_tracking.h | 9 +++++++++ .../adapters/galileo_e5a_dll_pll_tracking_fpga.h | 9 +++++++++ .../adapters/galileo_e5b_dll_pll_tracking.h | 9 +++++++++ .../glonass_l1_ca_dll_pll_c_aid_tracking.h | 9 +++++++++ .../adapters/glonass_l1_ca_dll_pll_tracking.h | 9 +++++++++ .../glonass_l2_ca_dll_pll_c_aid_tracking.h | 9 +++++++++ .../adapters/glonass_l2_ca_dll_pll_tracking.h | 9 +++++++++ .../adapters/gps_l1_ca_dll_pll_tracking.h | 11 +++++++++++ .../adapters/gps_l1_ca_dll_pll_tracking_fpga.h | 9 +++++++++ .../adapters/gps_l1_ca_dll_pll_tracking_gpu.h | 8 ++++++++ .../tracking/adapters/gps_l1_ca_kf_tracking.h | 9 +++++++++ .../adapters/gps_l1_ca_tcp_connector_tracking.h | 8 ++++++++ .../adapters/gps_l2_m_dll_pll_tracking.h | 9 +++++++++ .../adapters/gps_l2_m_dll_pll_tracking_fpga.h | 9 +++++++++ .../tracking/adapters/gps_l5_dll_pll_tracking.h | 9 +++++++++ .../adapters/gps_l5_dll_pll_tracking_fpga.h | 9 +++++++++ .../gnuradio_blocks/dll_pll_veml_tracking.h | 10 ++++++++++ .../gnuradio_blocks/dll_pll_veml_tracking_fpga.h | 9 +++++++++ .../galileo_e1_tcp_connector_tracking_cc.h | 8 ++++++++ .../glonass_l1_ca_dll_pll_c_aid_tracking_cc.h | 8 ++++++++ .../glonass_l1_ca_dll_pll_c_aid_tracking_sc.h | 10 ++++++++++ .../glonass_l1_ca_dll_pll_tracking_cc.h | 10 ++++++++++ .../glonass_l2_ca_dll_pll_c_aid_tracking_cc.h | 9 +++++++++ .../glonass_l2_ca_dll_pll_c_aid_tracking_sc.h | 9 +++++++++ .../glonass_l2_ca_dll_pll_tracking_cc.h | 9 +++++++++ .../gps_l1_ca_dll_pll_tracking_gpu_cc.h | 9 +++++++++ .../gnuradio_blocks/gps_l1_ca_kf_tracking_cc.h | 9 +++++++++ .../gps_l1_ca_tcp_connector_tracking_cc.h | 8 ++++++++ .../tracking/libs/bayesian_estimation.h | 11 ++++++++++- .../tracking/libs/cpu_multicorrelator.h | 9 +++++++++ .../tracking/libs/cpu_multicorrelator_16sc.h | 7 +++++++ .../libs/cpu_multicorrelator_real_codes.h | 8 ++++++++ .../tracking/libs/cuda_multicorrelator.h | 8 ++++++++ src/algorithms/tracking/libs/dll_pll_conf.h | 11 ++++++++++- src/algorithms/tracking/libs/dll_pll_conf_fpga.h | 11 ++++++++++- .../tracking/libs/exponential_smoother.h | 9 +++++++++ .../tracking/libs/fpga_multicorrelator.h | 8 ++++++++ src/algorithms/tracking/libs/lock_detectors.h | 10 +++++++++- .../tracking/libs/nonlinear_tracking.h | 11 ++++++++++- src/algorithms/tracking/libs/tcp_communication.h | 9 +++++++++ src/algorithms/tracking/libs/tcp_packet_data.h | 9 +++++++++ .../tracking/libs/tracking_2nd_DLL_filter.h | 9 +++++++++ .../tracking/libs/tracking_2nd_PLL_filter.h | 9 +++++++++ .../tracking/libs/tracking_FLL_PLL_filter.h | 9 +++++++++ .../tracking/libs/tracking_discriminators.h | 11 ++++++++++- .../tracking/libs/tracking_loop_filter.h | 10 +++++++++- src/core/interfaces/acquisition_interface.h | 10 ++++++++++ src/core/interfaces/channel_interface.h | 9 +++++++++ src/core/interfaces/configuration_interface.h | 9 +++++++++ src/core/interfaces/gnss_block_interface.h | 8 ++++++++ src/core/interfaces/observables_interface.h | 9 +++++++++ src/core/interfaces/pvt_interface.h | 9 +++++++++ .../interfaces/telemetry_decoder_interface.h | 9 +++++++++ src/core/interfaces/tracking_interface.h | 9 +++++++++ src/core/libs/INIReader.h | 9 +++++++++ src/core/libs/channel_event.h | 9 +++++++++ src/core/libs/channel_status_msg_receiver.h | 9 +++++++++ src/core/libs/command_event.h | 9 +++++++++ src/core/libs/gnss_sdr_fpga_sample_counter.h | 9 +++++++++ src/core/libs/gnss_sdr_sample_counter.h | 10 ++++++++++ src/core/libs/gnss_sdr_supl_client.h | 9 +++++++++ src/core/libs/gnss_sdr_time_counter.h | 9 +++++++++ src/core/libs/ini.h | 9 ++++++++- src/core/libs/string_converter.h | 9 +++++++++ src/core/libs/supl/supl.h | 16 +++++++++++++--- src/core/monitor/gnss_synchro_monitor.h | 12 +++++++++++- src/core/monitor/gnss_synchro_udp_sink.h | 8 ++++++++ src/core/receiver/concurrent_map.h | 8 ++++++++ src/core/receiver/concurrent_queue.h | 9 +++++++++ src/core/receiver/control_thread.h | 10 ++++++++++ src/core/receiver/file_configuration.h | 9 +++++++++ src/core/receiver/gnss_block_factory.h | 8 ++++++++ src/core/receiver/gnss_flowgraph.h | 9 +++++++++ src/core/receiver/in_memory_configuration.h | 8 ++++++++ src/core/receiver/tcp_cmd_interface.h | 9 +++++++++ src/core/system_parameters/Beidou_B1I.h | 8 ++++++++ src/core/system_parameters/Beidou_B3I.h | 8 ++++++++ src/core/system_parameters/Beidou_DNAV.h | 8 ++++++++ src/core/system_parameters/GLONASS_L1_L2_CA.h | 8 ++++++++ src/core/system_parameters/GPS_CNAV.h | 7 +++++++ src/core/system_parameters/GPS_L1_CA.h | 8 ++++++++ src/core/system_parameters/GPS_L2C.h | 7 +++++++ src/core/system_parameters/GPS_L5.h | 8 ++++++++ src/core/system_parameters/Galileo_E1.h | 8 ++++++++ src/core/system_parameters/Galileo_E5a.h | 7 +++++++ src/core/system_parameters/Galileo_E5b.h | 7 +++++++ src/core/system_parameters/Galileo_FNAV.h | 9 +++++++++ src/core/system_parameters/Galileo_INAV.h | 8 ++++++++ src/core/system_parameters/MATH_CONSTANTS.h | 9 +++++++++ src/core/system_parameters/agnss_ref_location.h | 10 +++++++++- src/core/system_parameters/agnss_ref_time.h | 10 +++++++++- src/core/system_parameters/beidou_dnav_almanac.h | 10 +++++++++- .../system_parameters/beidou_dnav_ephemeris.h | 10 +++++++++- src/core/system_parameters/beidou_dnav_iono.h | 10 +++++++++- .../beidou_dnav_navigation_message.h | 10 +++++++++- .../system_parameters/beidou_dnav_utc_model.h | 10 +++++++++- src/core/system_parameters/display.h | 9 +++++++++ src/core/system_parameters/galileo_almanac.h | 11 ++++++++++- .../system_parameters/galileo_almanac_helper.h | 11 ++++++++++- src/core/system_parameters/galileo_ephemeris.h | 10 +++++++++- .../system_parameters/galileo_fnav_message.h | 9 +++++++++ .../system_parameters/galileo_inav_message.h | 8 ++++++++ src/core/system_parameters/galileo_iono.h | 11 ++++++++++- src/core/system_parameters/galileo_utc_model.h | 11 ++++++++++- .../system_parameters/glonass_gnav_almanac.h | 11 ++++++++++- .../system_parameters/glonass_gnav_ephemeris.h | 11 ++++++++++- .../glonass_gnav_navigation_message.h | 11 ++++++++++- .../system_parameters/glonass_gnav_utc_model.h | 11 ++++++++++- src/core/system_parameters/gnss_frequencies.h | 11 ++++++++++- src/core/system_parameters/gnss_obs_codes.h | 10 +++++++++- src/core/system_parameters/gnss_satellite.h | 11 ++++++++++- src/core/system_parameters/gnss_signal.h | 11 ++++++++++- src/core/system_parameters/gnss_synchro.h | 12 +++++++++++- src/core/system_parameters/gps_acq_assist.h | 11 ++++++++++- src/core/system_parameters/gps_almanac.h | 11 ++++++++++- src/core/system_parameters/gps_cnav_ephemeris.h | 10 +++++++++- src/core/system_parameters/gps_cnav_iono.h | 10 +++++++++- .../gps_cnav_navigation_message.h | 10 +++++++++- src/core/system_parameters/gps_cnav_utc_model.h | 11 ++++++++++- src/core/system_parameters/gps_ephemeris.h | 10 +++++++++- src/core/system_parameters/gps_iono.h | 10 +++++++++- .../system_parameters/gps_navigation_message.h | 10 +++++++++- src/core/system_parameters/gps_utc_model.h | 11 ++++++++++- src/core/system_parameters/sbas_ephemeris.h | 8 ++++++++ 305 files changed, 2769 insertions(+), 112 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 08de53693..e2cb6b2c1 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -64,6 +64,8 @@ SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades // for map #include // 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 diff --git a/src/algorithms/PVT/gnuradio_blocks/rtklib_pvt_gs.h b/src/algorithms/PVT/gnuradio_blocks/rtklib_pvt_gs.h index 34a82ec72..aba0efa74 100644 --- a/src/algorithms/PVT/gnuradio_blocks/rtklib_pvt_gs.h +++ b/src/algorithms/PVT/gnuradio_blocks/rtklib_pvt_gs.h @@ -41,6 +41,13 @@ #include #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 diff --git a/src/algorithms/PVT/libs/geojson_printer.h b/src/algorithms/PVT/libs/geojson_printer.h index 13bde93a0..f0f863caa 100644 --- a/src/algorithms/PVT/libs/geojson_printer.h +++ b/src/algorithms/PVT/libs/geojson_printer.h @@ -26,6 +26,12 @@ #include #include +/** \addtogroup PVT + * \{ */ +/** \addtogroup PVT_libs + * \{ */ + + class Pvt_Solution; /*! @@ -49,4 +55,7 @@ private: bool first_pos; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GEOJSON_PRINTER_H diff --git a/src/algorithms/PVT/libs/gpx_printer.h b/src/algorithms/PVT/libs/gpx_printer.h index 4a1fe4d9a..85d06b722 100644 --- a/src/algorithms/PVT/libs/gpx_printer.h +++ b/src/algorithms/PVT/libs/gpx_printer.h @@ -26,6 +26,12 @@ #include #include +/** \addtogroup PVT + * \{ */ +/** \addtogroup PVT_libs + * \{ */ + + class Pvt_Solution; /*! @@ -50,4 +56,7 @@ private: bool positions_printed; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GPX_PRINTER_H diff --git a/src/algorithms/PVT/libs/kml_printer.h b/src/algorithms/PVT/libs/kml_printer.h index 383344ae9..75e8b8032 100644 --- a/src/algorithms/PVT/libs/kml_printer.h +++ b/src/algorithms/PVT/libs/kml_printer.h @@ -25,6 +25,12 @@ #include // for ofstream #include +/** \addtogroup PVT + * \{ */ +/** \addtogroup PVT_libs + * \{ */ + + class Pvt_Solution; /*! @@ -52,4 +58,7 @@ private: bool positions_printed; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_KML_PRINTER_H diff --git a/src/algorithms/PVT/libs/monitor_pvt.h b/src/algorithms/PVT/libs/monitor_pvt.h index 9ee799d07..d9adb7dc2 100644 --- a/src/algorithms/PVT/libs/monitor_pvt.h +++ b/src/algorithms/PVT/libs/monitor_pvt.h @@ -23,6 +23,12 @@ #include #include +/** \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 diff --git a/src/algorithms/PVT/libs/monitor_pvt_udp_sink.h b/src/algorithms/PVT/libs/monitor_pvt_udp_sink.h index f1b66af07..73c868d15 100644 --- a/src/algorithms/PVT/libs/monitor_pvt_udp_sink.h +++ b/src/algorithms/PVT/libs/monitor_pvt_udp_sink.h @@ -28,6 +28,12 @@ #include #include +/** \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 diff --git a/src/algorithms/PVT/libs/nmea_printer.h b/src/algorithms/PVT/libs/nmea_printer.h index 981159be8..c8354ede7 100644 --- a/src/algorithms/PVT/libs/nmea_printer.h +++ b/src/algorithms/PVT/libs/nmea_printer.h @@ -30,6 +30,12 @@ #include // for shared_ptr #include // 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 diff --git a/src/algorithms/PVT/libs/pvt_conf.h b/src/algorithms/PVT/libs/pvt_conf.h index 307ca0000..27c6b12e5 100644 --- a/src/algorithms/PVT/libs/pvt_conf.h +++ b/src/algorithms/PVT/libs/pvt_conf.h @@ -24,6 +24,12 @@ #include #include +/** \addtogroup PVT + * \{ */ +/** \addtogroup PVT_libs + * \{ */ + + class Pvt_Conf { public: @@ -81,4 +87,7 @@ public: bool dump_mat; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_PVT_CONF_H diff --git a/src/algorithms/PVT/libs/pvt_solution.h b/src/algorithms/PVT/libs/pvt_solution.h index bdfc47b12..ed0fcc9b6 100644 --- a/src/algorithms/PVT/libs/pvt_solution.h +++ b/src/algorithms/PVT/libs/pvt_solution.h @@ -25,6 +25,11 @@ #include #include +/** \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 diff --git a/src/algorithms/PVT/libs/rinex_printer.h b/src/algorithms/PVT/libs/rinex_printer.h index 503857e6f..87789c585 100644 --- a/src/algorithms/PVT/libs/rinex_printer.h +++ b/src/algorithms/PVT/libs/rinex_printer.h @@ -49,6 +49,13 @@ #include // for stringstream #include // 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 diff --git a/src/algorithms/PVT/libs/rtcm.h b/src/algorithms/PVT/libs/rtcm.h index 08733de85..b64d3d015 100644 --- a/src/algorithms/PVT/libs/rtcm.h +++ b/src/algorithms/PVT/libs/rtcm.h @@ -48,6 +48,12 @@ #include #include +/** \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 diff --git a/src/algorithms/PVT/libs/rtcm_printer.h b/src/algorithms/PVT/libs/rtcm_printer.h index 8a5062713..badf23263 100644 --- a/src/algorithms/PVT/libs/rtcm_printer.h +++ b/src/algorithms/PVT/libs/rtcm_printer.h @@ -29,6 +29,12 @@ #include // std::shared_ptr #include +/** \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 diff --git a/src/algorithms/PVT/libs/rtklib_solver.h b/src/algorithms/PVT/libs/rtklib_solver.h index c863b0bc0..a0dc3aee6 100644 --- a/src/algorithms/PVT/libs/rtklib_solver.h +++ b/src/algorithms/PVT/libs/rtklib_solver.h @@ -62,6 +62,12 @@ #include #include +/** \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 diff --git a/src/algorithms/PVT/libs/serdes_monitor_pvt.h b/src/algorithms/PVT/libs/serdes_monitor_pvt.h index 8e6f147a1..9f5119231 100644 --- a/src/algorithms/PVT/libs/serdes_monitor_pvt.h +++ b/src/algorithms/PVT/libs/serdes_monitor_pvt.h @@ -27,6 +27,12 @@ #include #include +/** \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 diff --git a/src/algorithms/acquisition/adapters/beidou_b1i_pcps_acquisition.h b/src/algorithms/acquisition/adapters/beidou_b1i_pcps_acquisition.h index 26d157f0f..68accd67b 100644 --- a/src/algorithms/acquisition/adapters/beidou_b1i_pcps_acquisition.h +++ b/src/algorithms/acquisition/adapters/beidou_b1i_pcps_acquisition.h @@ -34,6 +34,11 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + class ConfigurationInterface; @@ -172,4 +177,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_BEIDOU_B1I_PCPS_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/beidou_b3i_pcps_acquisition.h b/src/algorithms/acquisition/adapters/beidou_b3i_pcps_acquisition.h index 858866eb6..f0440efb2 100644 --- a/src/algorithms/acquisition/adapters/beidou_b3i_pcps_acquisition.h +++ b/src/algorithms/acquisition/adapters/beidou_b3i_pcps_acquisition.h @@ -33,6 +33,11 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + class ConfigurationInterface; @@ -171,4 +176,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_BEIDOU_B3I_PCPS_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/galileo_e1_pcps_8ms_ambiguous_acquisition.h b/src/algorithms/acquisition/adapters/galileo_e1_pcps_8ms_ambiguous_acquisition.h index 409da222c..79e327c20 100644 --- a/src/algorithms/acquisition/adapters/galileo_e1_pcps_8ms_ambiguous_acquisition.h +++ b/src/algorithms/acquisition/adapters/galileo_e1_pcps_8ms_ambiguous_acquisition.h @@ -29,6 +29,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -165,4 +171,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E1_PCPS_8MS_AMBIGUOUS_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/galileo_e1_pcps_ambiguous_acquisition.h b/src/algorithms/acquisition/adapters/galileo_e1_pcps_ambiguous_acquisition.h index 598b5d4c7..59952f82b 100644 --- a/src/algorithms/acquisition/adapters/galileo_e1_pcps_ambiguous_acquisition.h +++ b/src/algorithms/acquisition/adapters/galileo_e1_pcps_ambiguous_acquisition.h @@ -31,6 +31,11 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + class ConfigurationInterface; @@ -179,4 +184,7 @@ private: bool acquire_pilot_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E1_PCPS_AMBIGUOUS_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/galileo_e1_pcps_ambiguous_acquisition_fpga.h b/src/algorithms/acquisition/adapters/galileo_e1_pcps_ambiguous_acquisition_fpga.h index 8f5e55bdf..b0416f5f4 100644 --- a/src/algorithms/acquisition/adapters/galileo_e1_pcps_ambiguous_acquisition_fpga.h +++ b/src/algorithms/acquisition/adapters/galileo_e1_pcps_ambiguous_acquisition_fpga.h @@ -29,6 +29,11 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + class ConfigurationInterface; @@ -201,4 +206,7 @@ private: bool acquire_pilot_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E1_PCPS_AMBIGUOUS_ACQUISITION_FPGA_H diff --git a/src/algorithms/acquisition/adapters/galileo_e1_pcps_cccwsr_ambiguous_acquisition.h b/src/algorithms/acquisition/adapters/galileo_e1_pcps_cccwsr_ambiguous_acquisition.h index 89e2420de..ba9df496c 100644 --- a/src/algorithms/acquisition/adapters/galileo_e1_pcps_cccwsr_ambiguous_acquisition.h +++ b/src/algorithms/acquisition/adapters/galileo_e1_pcps_cccwsr_ambiguous_acquisition.h @@ -29,6 +29,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -166,4 +172,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E1_PCPS_CCCWSR_AMBIGUOUS_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/galileo_e1_pcps_quicksync_ambiguous_acquisition.h b/src/algorithms/acquisition/adapters/galileo_e1_pcps_quicksync_ambiguous_acquisition.h index 5505c3340..e9db353d5 100644 --- a/src/algorithms/acquisition/adapters/galileo_e1_pcps_quicksync_ambiguous_acquisition.h +++ b/src/algorithms/acquisition/adapters/galileo_e1_pcps_quicksync_ambiguous_acquisition.h @@ -29,6 +29,11 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + class ConfigurationInterface; @@ -170,4 +175,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E1_PCPS_QUICKSYNC_AMBIGUOUS_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/galileo_e1_pcps_tong_ambiguous_acquisition.h b/src/algorithms/acquisition/adapters/galileo_e1_pcps_tong_ambiguous_acquisition.h index 438193763..85432c60a 100644 --- a/src/algorithms/acquisition/adapters/galileo_e1_pcps_tong_ambiguous_acquisition.h +++ b/src/algorithms/acquisition/adapters/galileo_e1_pcps_tong_ambiguous_acquisition.h @@ -29,6 +29,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -168,4 +174,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E1_PCPS_TONG_AMBIGUOUS_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/galileo_e5a_noncoherent_iq_acquisition_caf.h b/src/algorithms/acquisition/adapters/galileo_e5a_noncoherent_iq_acquisition_caf.h index 3d4a1539c..8e5edff31 100644 --- a/src/algorithms/acquisition/adapters/galileo_e5a_noncoherent_iq_acquisition_caf.h +++ b/src/algorithms/acquisition/adapters/galileo_e5a_noncoherent_iq_acquisition_caf.h @@ -34,6 +34,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; class GalileoE5aNoncoherentIQAcquisitionCaf : public AcquisitionInterface @@ -174,4 +180,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E5A_NONCOHERENT_IQ_ACQUISITION_CAF_H diff --git a/src/algorithms/acquisition/adapters/galileo_e5a_pcps_acquisition.h b/src/algorithms/acquisition/adapters/galileo_e5a_pcps_acquisition.h index a0c513bda..c54f70bf8 100644 --- a/src/algorithms/acquisition/adapters/galileo_e5a_pcps_acquisition.h +++ b/src/algorithms/acquisition/adapters/galileo_e5a_pcps_acquisition.h @@ -28,6 +28,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; class GalileoE5aPcpsAcquisition : public AcquisitionInterface @@ -168,4 +174,7 @@ private: bool acq_iq_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E5A_PCPS_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/galileo_e5a_pcps_acquisition_fpga.h b/src/algorithms/acquisition/adapters/galileo_e5a_pcps_acquisition_fpga.h index c1ccd7d47..8556a39d2 100644 --- a/src/algorithms/acquisition/adapters/galileo_e5a_pcps_acquisition_fpga.h +++ b/src/algorithms/acquisition/adapters/galileo_e5a_pcps_acquisition_fpga.h @@ -29,6 +29,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; @@ -210,4 +216,7 @@ private: bool acq_iq_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E5A_PCPS_ACQUISITION_FPGA_H diff --git a/src/algorithms/acquisition/adapters/galileo_e5b_pcps_acquisition.h b/src/algorithms/acquisition/adapters/galileo_e5b_pcps_acquisition.h index 55d75abb3..85e8f057b 100644 --- a/src/algorithms/acquisition/adapters/galileo_e5b_pcps_acquisition.h +++ b/src/algorithms/acquisition/adapters/galileo_e5b_pcps_acquisition.h @@ -30,6 +30,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; class GalileoE5bPcpsAcquisition : public AcquisitionInterface @@ -206,4 +212,7 @@ private: bool acq_iq_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E5B_PCPS_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/galileo_e5b_pcps_acquisition_fpga.h b/src/algorithms/acquisition/adapters/galileo_e5b_pcps_acquisition_fpga.h index 48220a8f3..73cf0e341 100644 --- a/src/algorithms/acquisition/adapters/galileo_e5b_pcps_acquisition_fpga.h +++ b/src/algorithms/acquisition/adapters/galileo_e5b_pcps_acquisition_fpga.h @@ -30,6 +30,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -211,4 +217,7 @@ private: bool acq_iq_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E5B_PCPS_ACQUISITION_FPGA_H diff --git a/src/algorithms/acquisition/adapters/glonass_l1_ca_pcps_acquisition.h b/src/algorithms/acquisition/adapters/glonass_l1_ca_pcps_acquisition.h index 8400b235f..5c46153cd 100644 --- a/src/algorithms/acquisition/adapters/glonass_l1_ca_pcps_acquisition.h +++ b/src/algorithms/acquisition/adapters/glonass_l1_ca_pcps_acquisition.h @@ -33,6 +33,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -169,4 +175,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L1_CA_PCPS_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/glonass_l2_ca_pcps_acquisition.h b/src/algorithms/acquisition/adapters/glonass_l2_ca_pcps_acquisition.h index 666dc47f2..3b66ce398 100644 --- a/src/algorithms/acquisition/adapters/glonass_l2_ca_pcps_acquisition.h +++ b/src/algorithms/acquisition/adapters/glonass_l2_ca_pcps_acquisition.h @@ -32,6 +32,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -168,4 +174,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L2_CA_PCPS_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition.h b/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition.h index d20f735ed..d669a7dd9 100644 --- a/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition.h +++ b/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition.h @@ -35,6 +35,13 @@ #include #include +/** \addtogroup Acquisition + * Classes for GNSS signal acquisition + * \{ */ +/** \addtogroup Acq_adapters acquisition_adapters + * Wrap GNU Radio acquisition blocks with an AcquisitionInterface + * \{ */ + class ConfigurationInterface; @@ -180,4 +187,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_PCPS_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition_fine_doppler.h b/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition_fine_doppler.h index e8b118d07..df6d63bdc 100644 --- a/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition_fine_doppler.h +++ b/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition_fine_doppler.h @@ -36,6 +36,12 @@ using pcps_acquisition_fine_doppler_cc_sptr = std::shared_ptr; #endif +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -172,4 +178,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_PCPS_ACQUISITION_FINE_DOPPLER_H diff --git a/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition_fpga.h b/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition_fpga.h index be3b743ae..62afda2b0 100644 --- a/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition_fpga.h +++ b/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition_fpga.h @@ -32,6 +32,11 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + class ConfigurationInterface; @@ -203,4 +208,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_PCPS_ACQUISITION_FPGA_H diff --git a/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_assisted_acquisition.h b/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_assisted_acquisition.h index e6a600830..112a844e1 100644 --- a/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_assisted_acquisition.h +++ b/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_assisted_acquisition.h @@ -30,6 +30,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -163,4 +169,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_PCPS_ASSISTED_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_opencl_acquisition.h b/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_opencl_acquisition.h index cb3ef9e33..8b37461e4 100644 --- a/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_opencl_acquisition.h +++ b/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_opencl_acquisition.h @@ -29,6 +29,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -173,4 +179,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_PCPS_OPENCL_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_quicksync_acquisition.h b/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_quicksync_acquisition.h index 46a368dbc..13c15a1ee 100644 --- a/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_quicksync_acquisition.h +++ b/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_quicksync_acquisition.h @@ -31,6 +31,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -175,4 +181,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_PCPS_QUICKSYNC_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_tong_acquisition.h b/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_tong_acquisition.h index 724ba074a..338d49c01 100644 --- a/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_tong_acquisition.h +++ b/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_tong_acquisition.h @@ -30,6 +30,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -170,4 +176,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_TONG_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/gps_l2_m_pcps_acquisition.h b/src/algorithms/acquisition/adapters/gps_l2_m_pcps_acquisition.h index 7224fdfbf..75467e905 100644 --- a/src/algorithms/acquisition/adapters/gps_l2_m_pcps_acquisition.h +++ b/src/algorithms/acquisition/adapters/gps_l2_m_pcps_acquisition.h @@ -32,6 +32,11 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + class ConfigurationInterface; @@ -178,4 +183,7 @@ private: unsigned int num_codes_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L2_M_PCPS_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/gps_l2_m_pcps_acquisition_fpga.h b/src/algorithms/acquisition/adapters/gps_l2_m_pcps_acquisition_fpga.h index 1ec410eaf..479fb17ae 100644 --- a/src/algorithms/acquisition/adapters/gps_l2_m_pcps_acquisition_fpga.h +++ b/src/algorithms/acquisition/adapters/gps_l2_m_pcps_acquisition_fpga.h @@ -31,6 +31,12 @@ #include // for string #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class Gnss_Synchro; class ConfigurationInterface; @@ -168,4 +174,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L2_M_PCPS_ACQUISITION_FPGA_H diff --git a/src/algorithms/acquisition/adapters/gps_l5i_pcps_acquisition.h b/src/algorithms/acquisition/adapters/gps_l5i_pcps_acquisition.h index f20fa48a8..fd7dd3c3a 100644 --- a/src/algorithms/acquisition/adapters/gps_l5i_pcps_acquisition.h +++ b/src/algorithms/acquisition/adapters/gps_l5i_pcps_acquisition.h @@ -32,6 +32,11 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + class ConfigurationInterface; @@ -178,4 +183,7 @@ private: unsigned int num_codes_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L5I_PCPS_ACQUISITION_H diff --git a/src/algorithms/acquisition/adapters/gps_l5i_pcps_acquisition_fpga.h b/src/algorithms/acquisition/adapters/gps_l5i_pcps_acquisition_fpga.h index fabefd164..481c40701 100644 --- a/src/algorithms/acquisition/adapters/gps_l5i_pcps_acquisition_fpga.h +++ b/src/algorithms/acquisition/adapters/gps_l5i_pcps_acquisition_fpga.h @@ -31,6 +31,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -206,4 +212,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L5I_PCPS_ACQUISITION_FPGA_H diff --git a/src/algorithms/acquisition/gnuradio_blocks/galileo_e5a_noncoherent_iq_acquisition_caf_cc.h b/src/algorithms/acquisition/gnuradio_blocks/galileo_e5a_noncoherent_iq_acquisition_caf_cc.h index cf9c1b966..836209821 100644 --- a/src/algorithms/acquisition/gnuradio_blocks/galileo_e5a_noncoherent_iq_acquisition_caf_cc.h +++ b/src/algorithms/acquisition/gnuradio_blocks/galileo_e5a_noncoherent_iq_acquisition_caf_cc.h @@ -42,6 +42,12 @@ #include #endif +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_gnuradio_blocks + * \{ */ + + class galileo_e5a_noncoherentIQ_acquisition_caf_cc; #if GNURADIO_USES_STD_POINTERS @@ -266,4 +272,7 @@ private: bool d_enable_monitor_output; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E5A_NONCOHERENT_IQ_ACQUISITION_CAF_CC_H diff --git a/src/algorithms/acquisition/gnuradio_blocks/galileo_pcps_8ms_acquisition_cc.h b/src/algorithms/acquisition/gnuradio_blocks/galileo_pcps_8ms_acquisition_cc.h index eacdffb25..fbbb473eb 100644 --- a/src/algorithms/acquisition/gnuradio_blocks/galileo_pcps_8ms_acquisition_cc.h +++ b/src/algorithms/acquisition/gnuradio_blocks/galileo_pcps_8ms_acquisition_cc.h @@ -36,6 +36,12 @@ #include #endif +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_gnuradio_blocks + * \{ */ + + class galileo_pcps_8ms_acquisition_cc; #if GNURADIO_USES_STD_POINTERS @@ -236,4 +242,7 @@ private: bool d_enable_monitor_output; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_PCPS_8MS_ACQUISITION_CC_H diff --git a/src/algorithms/acquisition/gnuradio_blocks/pcps_acquisition.h b/src/algorithms/acquisition/gnuradio_blocks/pcps_acquisition.h index c56adc6db..ef5fea02b 100644 --- a/src/algorithms/acquisition/gnuradio_blocks/pcps_acquisition.h +++ b/src/algorithms/acquisition/gnuradio_blocks/pcps_acquisition.h @@ -76,6 +76,14 @@ namespace own = gsl; #include #endif +/** \addtogroup Acquisition + * Classes for GNSS signal acquisition + * \{ */ +/** \addtogroup Acq_gnuradio_blocks acquisition_gr_blocks + * GNU Radio processing blocks for GNSS signal acquisition + * \{ */ + + class Gnss_Synchro; class pcps_acquisition; @@ -289,4 +297,7 @@ private: std::queue d_monitor_queue; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_PCPS_ACQUISITION_H diff --git a/src/algorithms/acquisition/gnuradio_blocks/pcps_acquisition_fine_doppler_cc.h b/src/algorithms/acquisition/gnuradio_blocks/pcps_acquisition_fine_doppler_cc.h index 74c7be8b8..3b70fbb37 100644 --- a/src/algorithms/acquisition/gnuradio_blocks/pcps_acquisition_fine_doppler_cc.h +++ b/src/algorithms/acquisition/gnuradio_blocks/pcps_acquisition_fine_doppler_cc.h @@ -60,6 +60,12 @@ #include #endif +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_gnuradio_blocks + * \{ */ + + class pcps_acquisition_fine_doppler_cc; #if GNURADIO_USES_STD_POINTERS @@ -246,4 +252,7 @@ private: bool d_dump; }; -#endif /* pcps_acquisition_fine_doppler_cc*/ + +/** \} */ +/** \} */ +#endif // GNSS_SDR_PCPS_ACQUISITION_FINE_DOPPLER_CC_H diff --git a/src/algorithms/acquisition/gnuradio_blocks/pcps_acquisition_fpga.h b/src/algorithms/acquisition/gnuradio_blocks/pcps_acquisition_fpga.h index 4cd3c15ff..267820dcd 100644 --- a/src/algorithms/acquisition/gnuradio_blocks/pcps_acquisition_fpga.h +++ b/src/algorithms/acquisition/gnuradio_blocks/pcps_acquisition_fpga.h @@ -37,6 +37,12 @@ #include // for shared_ptr #include // for string +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_gnuradio_blocks + * \{ */ + + class Gnss_Synchro; typedef struct @@ -230,4 +236,7 @@ private: bool d_make_2_steps; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_PCPS_ACQUISITION_FPGA_H diff --git a/src/algorithms/acquisition/gnuradio_blocks/pcps_assisted_acquisition_cc.h b/src/algorithms/acquisition/gnuradio_blocks/pcps_assisted_acquisition_cc.h index 30400d4ae..b066a25bf 100644 --- a/src/algorithms/acquisition/gnuradio_blocks/pcps_assisted_acquisition_cc.h +++ b/src/algorithms/acquisition/gnuradio_blocks/pcps_assisted_acquisition_cc.h @@ -52,6 +52,12 @@ #include #endif +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_gnuradio_blocks + * \{ */ + + class pcps_assisted_acquisition_cc; #if GNURADIO_USES_STD_POINTERS @@ -247,4 +253,7 @@ private: bool d_enable_monitor_output; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_PCPS_ASSISTED_ACQUISITION_CC_H diff --git a/src/algorithms/acquisition/gnuradio_blocks/pcps_cccwsr_acquisition_cc.h b/src/algorithms/acquisition/gnuradio_blocks/pcps_cccwsr_acquisition_cc.h index d802102da..7bbdc5c59 100644 --- a/src/algorithms/acquisition/gnuradio_blocks/pcps_cccwsr_acquisition_cc.h +++ b/src/algorithms/acquisition/gnuradio_blocks/pcps_cccwsr_acquisition_cc.h @@ -41,6 +41,11 @@ #include #endif +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_gnuradio_blocks + * \{ */ + class pcps_cccwsr_acquisition_cc; @@ -235,4 +240,7 @@ private: bool d_enable_monitor_output; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_PCPS_CCCWSR_ACQUISITION_CC_H diff --git a/src/algorithms/acquisition/gnuradio_blocks/pcps_opencl_acquisition_cc.h b/src/algorithms/acquisition/gnuradio_blocks/pcps_opencl_acquisition_cc.h index 9d20d8b28..698c1d672 100644 --- a/src/algorithms/acquisition/gnuradio_blocks/pcps_opencl_acquisition_cc.h +++ b/src/algorithms/acquisition/gnuradio_blocks/pcps_opencl_acquisition_cc.h @@ -58,6 +58,12 @@ #include #endif +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_gnuradio_blocks + * \{ */ + + class pcps_opencl_acquisition_cc; #if GNURADIO_USES_STD_POINTERS @@ -296,4 +302,7 @@ private: bool d_enable_monitor_output; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_PCPS_OPENCL_ACQUISITION_CC_H diff --git a/src/algorithms/acquisition/gnuradio_blocks/pcps_quicksync_acquisition_cc.h b/src/algorithms/acquisition/gnuradio_blocks/pcps_quicksync_acquisition_cc.h index 8c91e7e68..b44f6c8d6 100644 --- a/src/algorithms/acquisition/gnuradio_blocks/pcps_quicksync_acquisition_cc.h +++ b/src/algorithms/acquisition/gnuradio_blocks/pcps_quicksync_acquisition_cc.h @@ -58,6 +58,12 @@ #include #endif +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_gnuradio_blocks + * \{ */ + + class pcps_quicksync_acquisition_cc; #if GNURADIO_USES_STD_POINTERS @@ -267,4 +273,7 @@ private: bool d_enable_monitor_output; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_PCPS_QUICKSYNC_ACQUISITION_CC_H diff --git a/src/algorithms/acquisition/gnuradio_blocks/pcps_tong_acquisition_cc.h b/src/algorithms/acquisition/gnuradio_blocks/pcps_tong_acquisition_cc.h index f4251e461..4a0a6a37d 100644 --- a/src/algorithms/acquisition/gnuradio_blocks/pcps_tong_acquisition_cc.h +++ b/src/algorithms/acquisition/gnuradio_blocks/pcps_tong_acquisition_cc.h @@ -55,6 +55,12 @@ #include #endif +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup Acq_gnuradio_blocks + * \{ */ + + class pcps_tong_acquisition_cc; #if GNURADIO_USES_STD_POINTERS @@ -250,4 +256,7 @@ private: bool d_enable_monitor_output; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_PCPS_TONG_ACQUISITION_CC_H diff --git a/src/algorithms/acquisition/libs/acq_conf.h b/src/algorithms/acquisition/libs/acq_conf.h index b687725d6..7f716667b 100644 --- a/src/algorithms/acquisition/libs/acq_conf.h +++ b/src/algorithms/acquisition/libs/acq_conf.h @@ -25,6 +25,13 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup acquisition_libs acquisition_libs + * Library with utilities for GNSS signal acquisition + * \{ */ + + class Acq_Conf { public: @@ -75,4 +82,7 @@ private: void ConfigureAutomaticResampler(double opt_freq); }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_ACQ_CONF_H diff --git a/src/algorithms/acquisition/libs/fpga_acquisition.h b/src/algorithms/acquisition/libs/fpga_acquisition.h index b88a481ac..933cc4cf4 100644 --- a/src/algorithms/acquisition/libs/fpga_acquisition.h +++ b/src/algorithms/acquisition/libs/fpga_acquisition.h @@ -28,6 +28,12 @@ #include #include +/** \addtogroup Acquisition + * \{ */ +/** \addtogroup acquisition_libs + * \{ */ + + /*! * \brief Class that implements carrier wipe-off and correlators. */ @@ -169,4 +175,7 @@ private: uint32_t d_PRN; // PRN }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_FPGA_ACQUISITION_H diff --git a/src/algorithms/channel/adapters/channel.h b/src/algorithms/channel/adapters/channel.h index 05822c830..16502086c 100644 --- a/src/algorithms/channel/adapters/channel.h +++ b/src/algorithms/channel/adapters/channel.h @@ -38,6 +38,16 @@ #include #include +/** \addtogroup Channel + * Classes containing a GNSS channel. + * \{ */ +/** \addtogroup Channel_adapters channel_adapters + * Classes that wrap an AcquisitionInterface, + * a TrackingInterface and a TelemetryDecoderInterface, and handles + * their interaction. + * \{ */ + + class ConfigurationInterface; class AcquisitionInterface; class TrackingInterface; @@ -46,7 +56,7 @@ class TelemetryDecoderInterface; /*! * \brief This class represents a GNSS channel. It wraps an AcquisitionInterface, - * a Tracking Interface and a TelemetryDecoderInterface, and handles + * a TrackingInterface and a TelemetryDecoderInterface, and handles * their interaction through a Finite State Machine * */ @@ -104,4 +114,7 @@ private: bool flag_enable_fpga_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_CHANNEL_H diff --git a/src/algorithms/channel/libs/channel_fsm.h b/src/algorithms/channel/libs/channel_fsm.h index e09e680f7..0fa06981e 100644 --- a/src/algorithms/channel/libs/channel_fsm.h +++ b/src/algorithms/channel/libs/channel_fsm.h @@ -31,6 +31,12 @@ #include #include +/** \addtogroup Channel + * \{ */ +/** \addtogroup Channel_libs channel_libs + * Library with utilities for a GNSS Channel. + * \{ */ + /*! * \brief This class implements a State Machine for channel @@ -77,4 +83,7 @@ private: uint32_t state_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_CHANNEL_FSM_H diff --git a/src/algorithms/channel/libs/channel_msg_receiver_cc.h b/src/algorithms/channel/libs/channel_msg_receiver_cc.h index 14edd45c0..cf935da9b 100644 --- a/src/algorithms/channel/libs/channel_msg_receiver_cc.h +++ b/src/algorithms/channel/libs/channel_msg_receiver_cc.h @@ -29,6 +29,12 @@ #include #endif +/** \addtogroup Channel + * \{ */ +/** \addtogroup Channel_libs + * \{ */ + + class channel_msg_receiver_cc; #if GNURADIO_USES_STD_POINTERS @@ -55,4 +61,7 @@ private: bool d_repeat; // todo: change FSM to include repeat value }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_CHANNEL_MSG_RECEIVER_CC_H diff --git a/src/algorithms/conditioner/adapters/array_signal_conditioner.h b/src/algorithms/conditioner/adapters/array_signal_conditioner.h index 44f1c5a69..99006df9c 100644 --- a/src/algorithms/conditioner/adapters/array_signal_conditioner.h +++ b/src/algorithms/conditioner/adapters/array_signal_conditioner.h @@ -28,6 +28,11 @@ #include #include +/** \addtogroup Signal_Conditioner + * \{ */ +/** \addtogroup Signal_Conditioner_adapters + * \{ */ + class ConfigurationInterface; @@ -70,4 +75,7 @@ private: bool connected_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_SIGNAL_CONDITIONER_H diff --git a/src/algorithms/conditioner/adapters/signal_conditioner.h b/src/algorithms/conditioner/adapters/signal_conditioner.h index 42027abe7..0079b77b6 100644 --- a/src/algorithms/conditioner/adapters/signal_conditioner.h +++ b/src/algorithms/conditioner/adapters/signal_conditioner.h @@ -27,6 +27,14 @@ #include #include +/** \addtogroup Signal_Conditioner Signal Conditioner + * Signal Conditioner wrapper block + * \{ */ +/** \addtogroup Signal_Conditioner_adapters conditioner_adapters + * Wrap a Signal Conditioner with a GNSSBlockInterface + * \{ */ + + /*! * \brief This class wraps blocks to change data_type_adapter, input_filter and resampler * to be applied to the input flow of sampled signal. @@ -66,4 +74,7 @@ private: bool connected_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_SIGNAL_CONDITIONER_H diff --git a/src/algorithms/data_type_adapter/adapters/byte_to_short.h b/src/algorithms/data_type_adapter/adapters/byte_to_short.h index 93202fe58..e73e1b905 100644 --- a/src/algorithms/data_type_adapter/adapters/byte_to_short.h +++ b/src/algorithms/data_type_adapter/adapters/byte_to_short.h @@ -26,6 +26,14 @@ #include #include +/** \addtogroup Data_Type Data Type Adapters + * Classes for data type conversion + * \{ */ +/** \addtogroup Data_type_adapters data_type_adapters + * Wrap GNU Radio data tyope adapter blocks with a GNSSBlockInterface + * \{ */ + + class ConfigurationInterface; /*! @@ -74,4 +82,7 @@ private: bool dump_; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_BYTE_TO_SHORT_H diff --git a/src/algorithms/data_type_adapter/adapters/ibyte_to_cbyte.h b/src/algorithms/data_type_adapter/adapters/ibyte_to_cbyte.h index 349ea3aa2..afaa60f3f 100644 --- a/src/algorithms/data_type_adapter/adapters/ibyte_to_cbyte.h +++ b/src/algorithms/data_type_adapter/adapters/ibyte_to_cbyte.h @@ -28,6 +28,12 @@ #include #include +/** \addtogroup Data_Type + * \{ */ +/** \addtogroup Data_type_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -78,4 +84,7 @@ private: bool dump_; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_IBYTE_TO_CBYTE_H diff --git a/src/algorithms/data_type_adapter/adapters/ibyte_to_complex.h b/src/algorithms/data_type_adapter/adapters/ibyte_to_complex.h index 4c4e7c9c4..819c9338d 100644 --- a/src/algorithms/data_type_adapter/adapters/ibyte_to_complex.h +++ b/src/algorithms/data_type_adapter/adapters/ibyte_to_complex.h @@ -27,6 +27,12 @@ #include #include +/** \addtogroup Data_Type + * \{ */ +/** \addtogroup Data_type_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -77,4 +83,7 @@ private: bool dump_; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_IBYTE_TO_COMPLEX_H diff --git a/src/algorithms/data_type_adapter/adapters/ibyte_to_cshort.h b/src/algorithms/data_type_adapter/adapters/ibyte_to_cshort.h index ed2ce14c4..1dd1a8098 100644 --- a/src/algorithms/data_type_adapter/adapters/ibyte_to_cshort.h +++ b/src/algorithms/data_type_adapter/adapters/ibyte_to_cshort.h @@ -27,6 +27,11 @@ #include #include +/** \addtogroup Data_Type + * \{ */ +/** \addtogroup Data_type_adapters + * \{ */ + class ConfigurationInterface; @@ -78,4 +83,7 @@ private: bool dump_; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_IBYTE_TO_CSHORT_H diff --git a/src/algorithms/data_type_adapter/adapters/ishort_to_complex.h b/src/algorithms/data_type_adapter/adapters/ishort_to_complex.h index 90e2f4cb2..e2c49eded 100644 --- a/src/algorithms/data_type_adapter/adapters/ishort_to_complex.h +++ b/src/algorithms/data_type_adapter/adapters/ishort_to_complex.h @@ -27,6 +27,12 @@ #include #include +/** \addtogroup Data_Type + * \{ */ +/** \addtogroup Data_type_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -77,4 +83,7 @@ private: bool dump_; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_ISHORT_TO_COMPLEX_H diff --git a/src/algorithms/data_type_adapter/adapters/ishort_to_cshort.h b/src/algorithms/data_type_adapter/adapters/ishort_to_cshort.h index b9755ee3a..f719fc958 100644 --- a/src/algorithms/data_type_adapter/adapters/ishort_to_cshort.h +++ b/src/algorithms/data_type_adapter/adapters/ishort_to_cshort.h @@ -27,6 +27,11 @@ #include #include +/** \addtogroup Data_Type + * \{ */ +/** \addtogroup Data_type_adapters + * \{ */ + class ConfigurationInterface; @@ -78,4 +83,7 @@ private: bool dump_; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_ISHORT_TO_CSHORT_H diff --git a/src/algorithms/data_type_adapter/gnuradio_blocks/interleaved_byte_to_complex_byte.h b/src/algorithms/data_type_adapter/gnuradio_blocks/interleaved_byte_to_complex_byte.h index 6a6fd7daa..c40b79237 100644 --- a/src/algorithms/data_type_adapter/gnuradio_blocks/interleaved_byte_to_complex_byte.h +++ b/src/algorithms/data_type_adapter/gnuradio_blocks/interleaved_byte_to_complex_byte.h @@ -27,6 +27,13 @@ #include #endif +/** \addtogroup Data_Type + * \{ */ +/** \addtogroup data_type_gnuradio_blocks data_type_gr_blocks + * GNU Radio Blocks for data type conversion + * \{ */ + + class interleaved_byte_to_complex_byte; #if GNURADIO_USES_STD_POINTERS @@ -53,4 +60,7 @@ private: interleaved_byte_to_complex_byte(); }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_INTERLEAVED_BYTE_TO_COMPLEX_BYTE_H diff --git a/src/algorithms/data_type_adapter/gnuradio_blocks/interleaved_byte_to_complex_short.h b/src/algorithms/data_type_adapter/gnuradio_blocks/interleaved_byte_to_complex_short.h index 796d27e9e..489e95b0f 100644 --- a/src/algorithms/data_type_adapter/gnuradio_blocks/interleaved_byte_to_complex_short.h +++ b/src/algorithms/data_type_adapter/gnuradio_blocks/interleaved_byte_to_complex_short.h @@ -27,6 +27,12 @@ #include #endif +/** \addtogroup Data_Type + * \{ */ +/** \addtogroup data_type_gnuradio_blocks + * \{ */ + + class interleaved_byte_to_complex_short; #if GNURADIO_USES_STD_POINTERS @@ -53,4 +59,7 @@ private: interleaved_byte_to_complex_short(); }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_INTERLEAVED_BYTE_TO_COMPLEX_SHORT_H diff --git a/src/algorithms/data_type_adapter/gnuradio_blocks/interleaved_short_to_complex_short.h b/src/algorithms/data_type_adapter/gnuradio_blocks/interleaved_short_to_complex_short.h index a070eff74..7659c7316 100644 --- a/src/algorithms/data_type_adapter/gnuradio_blocks/interleaved_short_to_complex_short.h +++ b/src/algorithms/data_type_adapter/gnuradio_blocks/interleaved_short_to_complex_short.h @@ -27,6 +27,12 @@ #include #endif +/** \addtogroup Data_Type + * \{ */ +/** \addtogroup data_type_gnuradio_blocks + * \{ */ + + class interleaved_short_to_complex_short; #if GNURADIO_USES_STD_POINTERS @@ -53,4 +59,7 @@ private: interleaved_short_to_complex_short(); }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_INTERLEAVED_SHORT_TO_COMPLEX_SHORT_H diff --git a/src/algorithms/input_filter/adapters/beamformer_filter.h b/src/algorithms/input_filter/adapters/beamformer_filter.h index 6328dedf4..9297c4247 100644 --- a/src/algorithms/input_filter/adapters/beamformer_filter.h +++ b/src/algorithms/input_filter/adapters/beamformer_filter.h @@ -26,6 +26,12 @@ #include #include +/** \addtogroup Input_Filter + * \{ */ +/** \addtogroup Input_filter_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -75,4 +81,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_BEAMFORMER_FILTER_H diff --git a/src/algorithms/input_filter/adapters/fir_filter.h b/src/algorithms/input_filter/adapters/fir_filter.h index c6351b4ab..4bc2bce32 100644 --- a/src/algorithms/input_filter/adapters/fir_filter.h +++ b/src/algorithms/input_filter/adapters/fir_filter.h @@ -41,6 +41,14 @@ #include #include +/** \addtogroup Input_Filter Input Filter + * Classes for input signal filtering + * \{ */ +/** \addtogroup Input_filter_adapters input_filter_adapters + * Classes that wrap GNU Radio input filters with a GNSSBlockInterface + * \{ */ + + class ConfigurationInterface; /*! @@ -113,4 +121,7 @@ private: bool dump_; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_FIR_FILTER_H diff --git a/src/algorithms/input_filter/adapters/freq_xlating_fir_filter.h b/src/algorithms/input_filter/adapters/freq_xlating_fir_filter.h index f02e4dee6..18336bdab 100644 --- a/src/algorithms/input_filter/adapters/freq_xlating_fir_filter.h +++ b/src/algorithms/input_filter/adapters/freq_xlating_fir_filter.h @@ -38,6 +38,12 @@ #include #include +/** \addtogroup Input_Filter + * \{ */ +/** \addtogroup Input_filter_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -108,4 +114,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_FREQ_XLATING_FIR_FILTER_H diff --git a/src/algorithms/input_filter/adapters/notch_filter.h b/src/algorithms/input_filter/adapters/notch_filter.h index c0685e523..f87225bf3 100644 --- a/src/algorithms/input_filter/adapters/notch_filter.h +++ b/src/algorithms/input_filter/adapters/notch_filter.h @@ -27,6 +27,12 @@ #include #include +/** \addtogroup Input_Filter + * \{ */ +/** \addtogroup Input_filter_adapters + * \{ */ + + class ConfigurationInterface; class NotchFilter : public GNSSBlockInterface @@ -71,4 +77,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_NOTCH_FILTER_H diff --git a/src/algorithms/input_filter/adapters/notch_filter_lite.h b/src/algorithms/input_filter/adapters/notch_filter_lite.h index 49bec36e0..ca04f47ad 100644 --- a/src/algorithms/input_filter/adapters/notch_filter_lite.h +++ b/src/algorithms/input_filter/adapters/notch_filter_lite.h @@ -27,6 +27,12 @@ #include #include +/** \addtogroup Input_Filter + * \{ */ +/** \addtogroup Input_filter_adapters + * \{ */ + + class ConfigurationInterface; class NotchFilterLite : public GNSSBlockInterface @@ -71,4 +77,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_NOTCH_FILTER_LITE_H diff --git a/src/algorithms/input_filter/adapters/pulse_blanking_filter.h b/src/algorithms/input_filter/adapters/pulse_blanking_filter.h index 3ac33681d..b1b146a0d 100644 --- a/src/algorithms/input_filter/adapters/pulse_blanking_filter.h +++ b/src/algorithms/input_filter/adapters/pulse_blanking_filter.h @@ -31,6 +31,12 @@ #endif #include +/** \addtogroup Input_Filter + * \{ */ +/** \addtogroup Input_filter_adapters + * \{ */ + + class ConfigurationInterface; class PulseBlankingFilter : public GNSSBlockInterface @@ -78,4 +84,7 @@ private: bool xlat_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_PULSE_BLANKING_FILTER_H diff --git a/src/algorithms/input_filter/gnuradio_blocks/beamformer.h b/src/algorithms/input_filter/gnuradio_blocks/beamformer.h index cd1b803a6..9c95de96e 100644 --- a/src/algorithms/input_filter/gnuradio_blocks/beamformer.h +++ b/src/algorithms/input_filter/gnuradio_blocks/beamformer.h @@ -28,6 +28,12 @@ #include #endif +/** \addtogroup Input_Filter + * \{ */ +/** \addtogroup Input_filter_gnuradio_blocks + * \{ */ + + class beamformer; #if GNURADIO_USES_STD_POINTERS @@ -56,4 +62,7 @@ private: std::vector weight_vector = std::vector(GNSS_SDR_BEAMFORMER_CHANNELS, gr_complex(1.0, 0.0)); }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_BEAMFORMER_H diff --git a/src/algorithms/input_filter/gnuradio_blocks/notch_cc.h b/src/algorithms/input_filter/gnuradio_blocks/notch_cc.h index 23b2bc9eb..f2adb3c44 100644 --- a/src/algorithms/input_filter/gnuradio_blocks/notch_cc.h +++ b/src/algorithms/input_filter/gnuradio_blocks/notch_cc.h @@ -17,8 +17,8 @@ * ----------------------------------------------------------------------------- */ -#ifndef GNSS_SDR_NOTCH_H -#define GNSS_SDR_NOTCH_H +#ifndef GNSS_SDR_NOTCH_CC_H +#define GNSS_SDR_NOTCH_CC_H #if GNURADIO_USES_STD_POINTERS #else @@ -30,6 +30,12 @@ #include #include +/** \addtogroup Input_Filter + * \{ */ +/** \addtogroup Input_filter_gnuradio_blocks + * \{ */ + + class Notch; #if GNURADIO_USES_STD_POINTERS @@ -78,4 +84,7 @@ private: bool filter_state_; }; -#endif // GNSS_SDR_NOTCH_H + +/** \} */ +/** \} */ +#endif // GNSS_SDR_NOTCH_CC_H diff --git a/src/algorithms/input_filter/gnuradio_blocks/notch_lite_cc.h b/src/algorithms/input_filter/gnuradio_blocks/notch_lite_cc.h index 8faf54209..787518829 100644 --- a/src/algorithms/input_filter/gnuradio_blocks/notch_lite_cc.h +++ b/src/algorithms/input_filter/gnuradio_blocks/notch_lite_cc.h @@ -17,8 +17,8 @@ * ----------------------------------------------------------------------------- */ -#ifndef GNSS_SDR_NOTCH_LITE_H -#define GNSS_SDR_NOTCH_LITE_H +#ifndef GNSS_SDR_NOTCH_LITE_CC_H +#define GNSS_SDR_NOTCH_LITE_CC_H #if GNURADIO_USES_STD_POINTERS #else @@ -30,6 +30,12 @@ #include #include +/** \addtogroup Input_Filter + * \{ */ +/** \addtogroup Input_filter_gnuradio_blocks + * \{ */ + + class NotchLite; #if GNURADIO_USES_STD_POINTERS @@ -83,4 +89,7 @@ private: bool filter_state_; }; -#endif // GNSS_SDR_NOTCH_LITE_H + +/** \} */ +/** \} */ +#endif // GNSS_SDR_NOTCH_LITE_CC_H diff --git a/src/algorithms/input_filter/gnuradio_blocks/pulse_blanking_cc.h b/src/algorithms/input_filter/gnuradio_blocks/pulse_blanking_cc.h index f878ea40f..136570f80 100644 --- a/src/algorithms/input_filter/gnuradio_blocks/pulse_blanking_cc.h +++ b/src/algorithms/input_filter/gnuradio_blocks/pulse_blanking_cc.h @@ -17,8 +17,8 @@ * ----------------------------------------------------------------------------- */ -#ifndef GNSS_SDR_PULSE_BLANKING_H -#define GNSS_SDR_PULSE_BLANKING_H +#ifndef GNSS_SDR_PULSE_BLANKING_CC_H +#define GNSS_SDR_PULSE_BLANKING_CC_H #if GNURADIO_USES_STD_POINTERS #include @@ -29,6 +29,13 @@ #include // for volk_gnsssdr::vector #include +/** \addtogroup Input_Filter + * \{ */ +/** \addtogroup Input_filter_gnuradio_blocks input_filter_gr_blocks + * GNU Radio blocks implementing input filters, + * \{ */ + + class pulse_blanking_cc; #if GNURADIO_USES_STD_POINTERS @@ -66,4 +73,7 @@ private: bool last_filtered_; }; -#endif // GNSS_SDR_PULSE_BLANKING_H + +/** \} */ +/** \} */ +#endif // GNSS_SDR_PULSE_BLANKING_CC_H diff --git a/src/algorithms/libs/beidou_b1i_signal_processing.h b/src/algorithms/libs/beidou_b1i_signal_processing.h index cab99e53d..d0f01de4d 100644 --- a/src/algorithms/libs/beidou_b1i_signal_processing.h +++ b/src/algorithms/libs/beidou_b1i_signal_processing.h @@ -31,6 +31,14 @@ namespace own = std; namespace own = gsl; #endif +/** \addtogroup Algorithms_Library Algorithms Common Library + * Common utilities for the GNSS receiver. + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * Common utilities for GNSS algorithms. + * \{ */ + + //! Generates int32_t GPS L1 C/A code for the desired SV ID and code shift void beidou_b1i_code_gen_int(own::span _dest, int32_t _prn, uint32_t _chip_shift); @@ -46,4 +54,7 @@ void beidou_b1i_code_gen_complex_sampled(own::span> _dest, u //! Generates complex GPS L1 C/A code for the desired SV ID and code shift void beidou_b1i_code_gen_complex_sampled(own::span> _dest, uint32_t _prn, int32_t _fs, uint32_t _chip_shift); + +/** \} */ +/** \} */ #endif // GNSS_SDR_BEIDOU_B1I_SDR_SIGNAL_PROCESSING_H diff --git a/src/algorithms/libs/beidou_b3i_signal_processing.h b/src/algorithms/libs/beidou_b3i_signal_processing.h index d1f8b88c6..63298ca8b 100644 --- a/src/algorithms/libs/beidou_b3i_signal_processing.h +++ b/src/algorithms/libs/beidou_b3i_signal_processing.h @@ -31,6 +31,11 @@ namespace own = std; namespace own = gsl; #endif +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + //! Generates int BeiDou B3I code for the desired SV ID and code shift void beidou_b3i_code_gen_int(own::span _dest, int32_t _prn, uint32_t _chip_shift); @@ -47,4 +52,7 @@ void beidou_b3i_code_gen_complex_sampled(own::span> _dest, u //! Generates complex BeiDou B3I code for the desired SV ID and code shift void beidou_b3i_code_gen_complex_sampled(own::span> _dest, uint32_t _prn, int _fs, uint32_t _chip_shift); + +/** \} */ +/** \} */ #endif // GNSS_SDR_BEIDOU_B3I_SIGNAL_PROCESSING_H diff --git a/src/algorithms/libs/byte_x2_to_complex_byte.h b/src/algorithms/libs/byte_x2_to_complex_byte.h index 5f28dede2..c68a2757f 100644 --- a/src/algorithms/libs/byte_x2_to_complex_byte.h +++ b/src/algorithms/libs/byte_x2_to_complex_byte.h @@ -29,6 +29,11 @@ #include #include // for gr_vector_const_void_star +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + class byte_x2_to_complex_byte; #if GNURADIO_USES_STD_POINTERS @@ -56,4 +61,7 @@ private: byte_x2_to_complex_byte(); }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_BYTE_X2_TO_COMPLEX_BYTE_Hs diff --git a/src/algorithms/libs/complex_byte_to_float_x2.h b/src/algorithms/libs/complex_byte_to_float_x2.h index 3aa8a695e..84df317d7 100644 --- a/src/algorithms/libs/complex_byte_to_float_x2.h +++ b/src/algorithms/libs/complex_byte_to_float_x2.h @@ -30,6 +30,12 @@ #include #include // for gr_vector_const_void_star +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + class complex_byte_to_float_x2; #if GNURADIO_USES_STD_POINTERS @@ -56,4 +62,7 @@ private: complex_byte_to_float_x2(); }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_COMPLEX_BYTE_TO_FLOAT_X2_H diff --git a/src/algorithms/libs/complex_float_to_complex_byte.h b/src/algorithms/libs/complex_float_to_complex_byte.h index 10be35991..44bb352ab 100644 --- a/src/algorithms/libs/complex_float_to_complex_byte.h +++ b/src/algorithms/libs/complex_float_to_complex_byte.h @@ -29,6 +29,11 @@ #include #include // for gr_vector_const_void_star +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + class complex_float_to_complex_byte; @@ -55,4 +60,7 @@ private: complex_float_to_complex_byte(); }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_COMPLEX_FLOAT_TO_COMPLEX_BYTE_H diff --git a/src/algorithms/libs/conjugate_cc.h b/src/algorithms/libs/conjugate_cc.h index 402831a88..eb44d68f9 100644 --- a/src/algorithms/libs/conjugate_cc.h +++ b/src/algorithms/libs/conjugate_cc.h @@ -29,6 +29,12 @@ #include #include // for gr_vector_const_void_star +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + class conjugate_cc; #if GNURADIO_USES_STD_POINTERS @@ -55,4 +61,7 @@ private: conjugate_cc(); }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_CONJUGATE_CC_H diff --git a/src/algorithms/libs/conjugate_ic.h b/src/algorithms/libs/conjugate_ic.h index 8b5b1d30c..a29825fe3 100644 --- a/src/algorithms/libs/conjugate_ic.h +++ b/src/algorithms/libs/conjugate_ic.h @@ -29,6 +29,12 @@ #include #endif +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + class conjugate_ic; #if GNURADIO_USES_STD_POINTERS @@ -55,4 +61,7 @@ private: conjugate_ic(); }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_CONJUGATE_IC_H diff --git a/src/algorithms/libs/conjugate_sc.h b/src/algorithms/libs/conjugate_sc.h index fbd185744..ea7d80b26 100644 --- a/src/algorithms/libs/conjugate_sc.h +++ b/src/algorithms/libs/conjugate_sc.h @@ -29,6 +29,12 @@ #include #include // for gr_vector_const_void_star +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + class conjugate_sc; #if GNURADIO_USES_STD_POINTERS @@ -55,4 +61,7 @@ private: conjugate_sc(); }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_CONJUGATE_SC_H diff --git a/src/algorithms/libs/cshort_to_float_x2.h b/src/algorithms/libs/cshort_to_float_x2.h index 826989c2a..5346984a2 100644 --- a/src/algorithms/libs/cshort_to_float_x2.h +++ b/src/algorithms/libs/cshort_to_float_x2.h @@ -30,6 +30,12 @@ #include #include // for gr_vector_const_void_star +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + class cshort_to_float_x2; #if GNURADIO_USES_STD_POINTERS @@ -56,4 +62,7 @@ private: cshort_to_float_x2(); }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_CSHORT_TO_FLOAT_X2_H diff --git a/src/algorithms/libs/galileo_e1_signal_processing.h b/src/algorithms/libs/galileo_e1_signal_processing.h index e809bfec8..5a2132406 100644 --- a/src/algorithms/libs/galileo_e1_signal_processing.h +++ b/src/algorithms/libs/galileo_e1_signal_processing.h @@ -32,6 +32,11 @@ namespace own = std; namespace own = gsl; #endif +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + /*! * \brief This function generates Galileo E1 code (can select E1B or E1C sinboc). @@ -71,4 +76,7 @@ void galileo_e1_code_gen_complex_sampled(own::span> _dest, c void galileo_e1_code_gen_complex_sampled(own::span> _dest, const std::array& _Signal, bool _cboc, uint32_t _prn, int32_t _fs, uint32_t _chip_shift); + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E1_SIGNAL_PROCESSING_H diff --git a/src/algorithms/libs/galileo_e5_signal_processing.h b/src/algorithms/libs/galileo_e5_signal_processing.h index 6f40b303d..850a80421 100644 --- a/src/algorithms/libs/galileo_e5_signal_processing.h +++ b/src/algorithms/libs/galileo_e5_signal_processing.h @@ -35,6 +35,12 @@ namespace own = std; namespace own = gsl; #endif +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + /*! * \brief Generates Galileo E5a code at 1 sample/chip */ @@ -72,4 +78,7 @@ void galileo_e5_b_code_gen_complex_sampled(own::span> _dest, int32_t _fs, uint32_t _chip_shift); + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E5_SIGNAL_PROCESSING_H diff --git a/src/algorithms/libs/geofunctions.h b/src/algorithms/libs/geofunctions.h index 375e9d70a..0334cc845 100644 --- a/src/algorithms/libs/geofunctions.h +++ b/src/algorithms/libs/geofunctions.h @@ -28,6 +28,12 @@ #include +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + arma::mat Skew_symmetric(const arma::vec &a); //!< Calculates skew-symmetric matrix double WGS84_g0(double Lat_rad); @@ -175,4 +181,7 @@ double clsin(const arma::colvec &ar, int degree, double argument); */ void clksin(const arma::colvec &ar, int degree, double arg_real, double arg_imag, double *re, double *im); + +/** \} */ +/** \} */ #endif // GNSS_SDR_GEOFUNCTIONS_H diff --git a/src/algorithms/libs/glonass_l1_signal_processing.h b/src/algorithms/libs/glonass_l1_signal_processing.h index ac79bc6ad..798c1cc64 100644 --- a/src/algorithms/libs/glonass_l1_signal_processing.h +++ b/src/algorithms/libs/glonass_l1_signal_processing.h @@ -31,6 +31,12 @@ namespace own = std; namespace own = gsl; #endif +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + //! Generates complex GLONASS L1 C/A code for the desired SV ID and code shift, and sampled to specific sampling frequency void glonass_l1_ca_code_gen_complex(own::span> _dest, uint32_t _chip_shift); @@ -40,4 +46,7 @@ void glonass_l1_ca_code_gen_complex_sampled(own::span> _dest //! Generates complex GLONASS L1 C/A code for the desired SV ID and code shift void glonass_l1_ca_code_gen_complex_sampled(own::span> _dest, int32_t _fs, uint32_t _chip_shift); + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_SDR_SIGNAL_PROCESSING_H diff --git a/src/algorithms/libs/glonass_l2_signal_processing.h b/src/algorithms/libs/glonass_l2_signal_processing.h index 212101c28..0f00bbb55 100644 --- a/src/algorithms/libs/glonass_l2_signal_processing.h +++ b/src/algorithms/libs/glonass_l2_signal_processing.h @@ -31,6 +31,12 @@ namespace own = std; namespace own = gsl; #endif +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + //! Generates complex GLONASS L2 C/A code for the desired SV ID and code shift, and sampled to specific sampling frequency void glonass_l2_ca_code_gen_complex(own::span> _dest, uint32_t _chip_shift); @@ -40,4 +46,7 @@ void glonass_l2_ca_code_gen_complex_sampled(own::span> _dest //! Generates complex GLONASS L2 C/A code for the desired SV ID and code shift void glonass_l2_ca_code_gen_complex_sampled(own::span> _dest, int32_t _fs, uint32_t _chip_shift); + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L2_SIGNAL_PROCESSING_H diff --git a/src/algorithms/libs/gnss_circular_deque.h b/src/algorithms/libs/gnss_circular_deque.h index fe840d4ba..052b23f60 100644 --- a/src/algorithms/libs/gnss_circular_deque.h +++ b/src/algorithms/libs/gnss_circular_deque.h @@ -24,6 +24,12 @@ #include #include +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + template class Gnss_circular_deque { @@ -136,4 +142,7 @@ void Gnss_circular_deque::push_back(unsigned int ch, const T& new_data) d_data[ch].push_back(new_data); } + +/** \} */ +/** \} */ #endif // GNSS_SDR_CIRCULAR_DEQUE_H diff --git a/src/algorithms/libs/gnss_sdr_create_directory.h b/src/algorithms/libs/gnss_sdr_create_directory.h index d7e6dedc8..cc34be184 100644 --- a/src/algorithms/libs/gnss_sdr_create_directory.h +++ b/src/algorithms/libs/gnss_sdr_create_directory.h @@ -23,6 +23,15 @@ #include +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + bool gnss_sdr_create_directory(const std::string& foldername); -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GNSS_SDR_CREATE_DIRECTORY_H diff --git a/src/algorithms/libs/gnss_sdr_flags.h b/src/algorithms/libs/gnss_sdr_flags.h index c227f8f5d..736e9f6ad 100644 --- a/src/algorithms/libs/gnss_sdr_flags.h +++ b/src/algorithms/libs/gnss_sdr_flags.h @@ -18,13 +18,20 @@ * ----------------------------------------------------------------------------- */ -#ifndef GNSS_SDR_FLAGS_H -#define GNSS_SDR_FLAGS_H +#ifndef GNSS_SDR_GNSS_SDR_FLAGS_H +#define GNSS_SDR_GNSS_SDR_FLAGS_H #include #include +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Gflags gnss_sdr_flags + * Library for command-line handling. + * \{ */ + + DECLARE_string(c); //!< Path to the configuration file. DECLARE_string(config_file); //!< Path to the configuration file. @@ -56,4 +63,7 @@ const int32_t DEFAULT_CARRIER_SMOOTHING_FACTOR = 200; DECLARE_string(RINEX_version); //!< If defined, specifies the RINEX version (2.11 or 3.02). Overrides the configuration file. DECLARE_string(RINEX_name); //!< If defined, specifies the RINEX files base name -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GNSS_SDR_FLAGS_H diff --git a/src/algorithms/libs/gnss_sdr_make_unique.h b/src/algorithms/libs/gnss_sdr_make_unique.h index 1295af120..785c2eb4f 100644 --- a/src/algorithms/libs/gnss_sdr_make_unique.h +++ b/src/algorithms/libs/gnss_sdr_make_unique.h @@ -31,6 +31,12 @@ #include #include +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + namespace std { template @@ -73,4 +79,7 @@ make_unique(Args&&...) = delete; #endif // __cplusplus == 201103L + +/** \} */ +/** \} */ #endif // GNSS_SDR_GNSS_SDR_MAKE_UNIQUE_H diff --git a/src/algorithms/libs/gnss_signal_processing.h b/src/algorithms/libs/gnss_signal_processing.h index e797a6398..4a677699a 100644 --- a/src/algorithms/libs/gnss_signal_processing.h +++ b/src/algorithms/libs/gnss_signal_processing.h @@ -33,6 +33,12 @@ namespace own = std; namespace own = gsl; #endif +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + /*! * \brief This function generates a complex exponential in _dest. * @@ -66,4 +72,7 @@ void resampler(const own::span _from, own::span _dest, void resampler(own::span> _from, own::span> _dest, float _fs_in, float _fs_out); + +/** \} */ +/** \} */ #endif // GNSS_SDR_GNSS_SIGNAL_PROCESSING_H diff --git a/src/algorithms/libs/gps_l2c_signal.h b/src/algorithms/libs/gps_l2c_signal.h index e14749031..96b3c2cd2 100644 --- a/src/algorithms/libs/gps_l2c_signal.h +++ b/src/algorithms/libs/gps_l2c_signal.h @@ -31,6 +31,12 @@ namespace own = std; namespace own = gsl; #endif +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + //! Generates complex GPS L2C M code for the desired SV ID void gps_l2c_m_code_gen_complex(own::span> _dest, uint32_t _prn); void gps_l2c_m_code_gen_float(own::span _dest, uint32_t _prn); @@ -38,4 +44,7 @@ void gps_l2c_m_code_gen_float(own::span _dest, uint32_t _prn); //! Generates complex GPS L2C M code for the desired SV ID, and sampled to specific sampling frequency void gps_l2c_m_code_gen_complex_sampled(own::span> _dest, uint32_t _prn, int32_t _fs); + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L2C_SIGNAL_H diff --git a/src/algorithms/libs/gps_l5_signal.h b/src/algorithms/libs/gps_l5_signal.h index 8e4b351aa..78d08dd64 100644 --- a/src/algorithms/libs/gps_l5_signal.h +++ b/src/algorithms/libs/gps_l5_signal.h @@ -31,6 +31,12 @@ namespace own = std; namespace own = gsl; #endif +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + //! Generates complex GPS L5I code for the desired SV ID void gps_l5i_code_gen_complex(own::span> _dest, uint32_t _prn); @@ -50,4 +56,6 @@ void gps_l5i_code_gen_complex_sampled(own::span> _dest, uint void gps_l5q_code_gen_complex_sampled(own::span> _dest, uint32_t _prn, int32_t _fs); +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L5_SIGNAL_H diff --git a/src/algorithms/libs/gps_sdr_signal_processing.h b/src/algorithms/libs/gps_sdr_signal_processing.h index 5168b95ab..aa630b7b1 100644 --- a/src/algorithms/libs/gps_sdr_signal_processing.h +++ b/src/algorithms/libs/gps_sdr_signal_processing.h @@ -31,6 +31,12 @@ namespace own = std; namespace own = gsl; #endif +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + //! Generates int GPS L1 C/A code for the desired SV ID and code shift void gps_l1_ca_code_gen_int(own::span _dest, int32_t _prn, uint32_t _chip_shift); @@ -46,4 +52,7 @@ void gps_l1_ca_code_gen_complex_sampled(own::span> _dest, ui //! Generates complex GPS L1 C/A code for the desired SV ID and code shift void gps_l1_ca_code_gen_complex_sampled(own::span> _dest, uint32_t _prn, int32_t _fs, uint32_t _chip_shift); + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_SDR_SIGNAL_PROCESSING_H diff --git a/src/algorithms/libs/item_type_helpers.h b/src/algorithms/libs/item_type_helpers.h index c4e89197d..1e0f25a50 100644 --- a/src/algorithms/libs/item_type_helpers.h +++ b/src/algorithms/libs/item_type_helpers.h @@ -28,6 +28,12 @@ #include #include +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + using item_type_converter_t = std::function; /*! @@ -76,4 +82,7 @@ bool item_type_is_complex(const std::string &item_type); item_type_converter_t make_vector_converter(const std::string &input_type, const std::string &output_type); -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_ITEM_TYPE_HELPERS_H diff --git a/src/algorithms/libs/pass_through.h b/src/algorithms/libs/pass_through.h index efdb9c122..6679e95b0 100644 --- a/src/algorithms/libs/pass_through.h +++ b/src/algorithms/libs/pass_through.h @@ -31,6 +31,11 @@ #include #include +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + class ConfigurationInterface; @@ -52,7 +57,7 @@ public: return role_; } - //! returns "Pass_Through" + //! Returns "Pass_Through" inline std::string implementation() override { return "Pass_Through"; @@ -86,4 +91,7 @@ private: bool inverted_spectrum; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_PASS_THROUGH_H diff --git a/src/algorithms/libs/rtklib/rtklib.h b/src/algorithms/libs/rtklib/rtklib.h index f098fd183..9db2b161e 100644 --- a/src/algorithms/libs/rtklib/rtklib.h +++ b/src/algorithms/libs/rtklib/rtklib.h @@ -45,6 +45,12 @@ #include #include +/** \addtogroup PVT + * \{ */ +/** \addtogroup RTKLIB_Library algorithms_libs_rtklib + * Our version of the RTKLIB core library (see http://www.rtklib.com/) + * \{ */ + /* macros --------------------------------------------------------------------*/ @@ -1308,5 +1314,6 @@ const int STRFMT_NMEA = 19; /* stream format: NMEA 0183 */ const int MAXSTRRTK = 8; /* max number of stream in RTK server */ - +/** \} */ +/** \} */ #endif // GNSS_SDR_RTKLIB_H diff --git a/src/algorithms/libs/rtklib/rtklib_conversions.h b/src/algorithms/libs/rtklib/rtklib_conversions.h index 538969c08..a956cb74b 100644 --- a/src/algorithms/libs/rtklib/rtklib_conversions.h +++ b/src/algorithms/libs/rtklib/rtklib_conversions.h @@ -22,6 +22,12 @@ #include "rtklib.h" +/** \addtogroup PVT + * \{ */ +/** \addtogroup RTKLIB_Library + * \{ */ + + class Beidou_Dnav_Ephemeris; class Galileo_Almanac; class Galileo_Ephemeris; @@ -49,4 +55,7 @@ geph_t eph_to_rtklib(const Glonass_Gnav_Ephemeris& glonass_gnav_eph, const Glona obsd_t insert_obs_to_rtklib(obsd_t& rtklib_obs, const Gnss_Synchro& gnss_synchro, int week, int band, bool pre_2009_file = false); + +/** \} */ +/** \} */ #endif // GNSS_SDR_RTKLIB_CONVERSIONS_H diff --git a/src/algorithms/libs/rtklib/rtklib_rtkpos.h b/src/algorithms/libs/rtklib/rtklib_rtkpos.h index 894d55fc7..d99149455 100644 --- a/src/algorithms/libs/rtklib/rtklib_rtkpos.h +++ b/src/algorithms/libs/rtklib/rtklib_rtkpos.h @@ -37,6 +37,12 @@ #include "rtklib.h" #include "rtklib_rtkcmn.h" +/** \addtogroup PVT + * \{ */ +/** \addtogroup RTKLIB_Library + * \{ */ + + /* constants/macros ----------------------------------------------------------*/ const double VAR_POS = std::pow(30.0, 2.0); /* initial variance of receiver pos (m^2) */ const double VAR_VEL = std::pow(10.0, 2.0); /* initial variance of receiver vel ((m/s)^2) */ @@ -171,4 +177,6 @@ void rtkfree(rtk_t *rtk); int rtkpos(rtk_t *rtk, const obsd_t *obs, int n, const nav_t *nav); -#endif +/** \} */ +/** \} */ +#endif // GNSS_SDR_RTKLIB_RKTPOS_H diff --git a/src/algorithms/libs/rtklib/rtklib_solution.h b/src/algorithms/libs/rtklib/rtklib_solution.h index 99c166fc6..c7f6c074a 100644 --- a/src/algorithms/libs/rtklib/rtklib_solution.h +++ b/src/algorithms/libs/rtklib/rtklib_solution.h @@ -34,6 +34,12 @@ #include "rtklib.h" +/** \addtogroup PVT + * \{ */ +/** \addtogroup RTKLIB_Library + * \{ */ + + #define COMMENTH "%" /* comment line indicator for solution */ #define MSG_DISCONN "$_DISCONNECT\r\n" /* disconnect message */ @@ -157,4 +163,6 @@ void outsolex(FILE *fp, const sol_t *sol, const ssat_t *ssat, const solopt_t *opt); -#endif +/** \} */ +/** \} */ +#endif // GNSS_SDR_RTKLIB_SOLUTION_H diff --git a/src/algorithms/libs/short_x2_to_cshort.h b/src/algorithms/libs/short_x2_to_cshort.h index 3fca87f4c..51e136c48 100644 --- a/src/algorithms/libs/short_x2_to_cshort.h +++ b/src/algorithms/libs/short_x2_to_cshort.h @@ -29,6 +29,12 @@ #include #include // for gr_vector_const_void_star +/** \addtogroup Algorithms_Library + * \{ */ +/** \addtogroup Algorithm_libs algorithms_libs + * \{ */ + + class short_x2_to_cshort; #if GNURADIO_USES_STD_POINTERS @@ -54,4 +60,7 @@ private: short_x2_to_cshort(); }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_SHORT_X2_TO_CSHORT_H diff --git a/src/algorithms/observables/adapters/hybrid_observables.h b/src/algorithms/observables/adapters/hybrid_observables.h index 0e4a49d2d..4834d5812 100644 --- a/src/algorithms/observables/adapters/hybrid_observables.h +++ b/src/algorithms/observables/adapters/hybrid_observables.h @@ -31,6 +31,13 @@ #include #include +/** \addtogroup Observables + * Classes for the computation of GNSS observables + * \{ */ +/** \addtogroup Observables_adapters obs_adapters + * Wrap GNU Radio observables blocks with an ObservablesInterface + * \{ */ + class ConfigurationInterface; /*! @@ -83,4 +90,6 @@ private: bool dump_mat_; }; +/** \} */ +/** \} */ #endif diff --git a/src/algorithms/observables/gnuradio_blocks/hybrid_observables_gs.h b/src/algorithms/observables/gnuradio_blocks/hybrid_observables_gs.h index 92d93b1a3..1703d36cd 100644 --- a/src/algorithms/observables/gnuradio_blocks/hybrid_observables_gs.h +++ b/src/algorithms/observables/gnuradio_blocks/hybrid_observables_gs.h @@ -40,6 +40,12 @@ #include #endif +/** \addtogroup Observables + * \{ */ +/** \addtogroup Observables_gnuradio_blocks obs_gr_blocks + * GNU Radio blocks for the computation of GNSS observables + * \{ */ + class Gnss_Synchro; class hybrid_observables_gs; @@ -124,4 +130,6 @@ private: bool d_dump_mat; }; +/** \} */ +/** \} */ #endif // GNSS_SDR_HYBRID_OBSERVABLES_GS_H diff --git a/src/algorithms/observables/libs/obs_conf.h b/src/algorithms/observables/libs/obs_conf.h index 01873e74c..d21a99fba 100644 --- a/src/algorithms/observables/libs/obs_conf.h +++ b/src/algorithms/observables/libs/obs_conf.h @@ -24,6 +24,12 @@ #include #include +/** \addtogroup Observables + * \{ */ +/** \addtogroup Observables_libs observables_libs + * Utilities for GNSS observables configuration. + * \{ */ + class Obs_Conf { public: @@ -38,4 +44,6 @@ public: bool dump_mat; }; -#endif +/** \} */ +/** \} */ +#endif // GNSS_SDR_OBS_CONF_H diff --git a/src/algorithms/resampler/adapters/direct_resampler_conditioner.h b/src/algorithms/resampler/adapters/direct_resampler_conditioner.h index 0a6995582..789577272 100644 --- a/src/algorithms/resampler/adapters/direct_resampler_conditioner.h +++ b/src/algorithms/resampler/adapters/direct_resampler_conditioner.h @@ -26,6 +26,12 @@ #include #include +/** \addtogroup Resampler + * \{ */ +/** \addtogroup Resampler_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -76,4 +82,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_DIRECT_RESAMPLER_CONDITIONER_H diff --git a/src/algorithms/resampler/adapters/mmse_resampler_conditioner.h b/src/algorithms/resampler/adapters/mmse_resampler_conditioner.h index a979d7f7d..13a09b87d 100644 --- a/src/algorithms/resampler/adapters/mmse_resampler_conditioner.h +++ b/src/algorithms/resampler/adapters/mmse_resampler_conditioner.h @@ -34,6 +34,14 @@ #include #include +/** \addtogroup Resampler + * Classes for input signal resampling + * \{ */ +/** \addtogroup Resampler_adapters resampler_adapters + * Classes that wrap GNU Radio resampler blocks with a GNSSBlockInterface + * \{ */ + + class ConfigurationInterface; /*! @@ -88,4 +96,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_FRACTIONAL_RESAMPLER_CONDITIONER_H diff --git a/src/algorithms/resampler/gnuradio_blocks/direct_resampler_conditioner_cb.h b/src/algorithms/resampler/gnuradio_blocks/direct_resampler_conditioner_cb.h index 221bcf4f3..c93ef57d6 100644 --- a/src/algorithms/resampler/gnuradio_blocks/direct_resampler_conditioner_cb.h +++ b/src/algorithms/resampler/gnuradio_blocks/direct_resampler_conditioner_cb.h @@ -30,6 +30,13 @@ #include #endif +/** \addtogroup Resampler + * \{ */ +/** \addtogroup Resampler_gnuradio_blocks + * GNU Radio blocks for input signal resampling + * \{ */ + + class direct_resampler_conditioner_cb; #if GNURADIO_USES_STD_POINTERS @@ -84,4 +91,7 @@ private: uint32_t d_phase_step; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_DIRECT_RESAMPLER_CONDITIONER_CB_H diff --git a/src/algorithms/resampler/gnuradio_blocks/direct_resampler_conditioner_cc.h b/src/algorithms/resampler/gnuradio_blocks/direct_resampler_conditioner_cc.h index 689ac87f4..f4e46d457 100644 --- a/src/algorithms/resampler/gnuradio_blocks/direct_resampler_conditioner_cc.h +++ b/src/algorithms/resampler/gnuradio_blocks/direct_resampler_conditioner_cc.h @@ -36,6 +36,12 @@ #include #endif +/** \addtogroup Resampler + * \{ */ +/** \addtogroup Resampler_gnuradio_blocks resampler_gr_blocks + * \{ */ + + class direct_resampler_conditioner_cc; #if GNURADIO_USES_STD_POINTERS @@ -89,4 +95,7 @@ private: uint32_t d_phase_step; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_DIRECT_RESAMPLER_CONDITIONER_CC_H diff --git a/src/algorithms/resampler/gnuradio_blocks/direct_resampler_conditioner_cs.h b/src/algorithms/resampler/gnuradio_blocks/direct_resampler_conditioner_cs.h index f1e272300..5784a65ea 100644 --- a/src/algorithms/resampler/gnuradio_blocks/direct_resampler_conditioner_cs.h +++ b/src/algorithms/resampler/gnuradio_blocks/direct_resampler_conditioner_cs.h @@ -30,6 +30,12 @@ #include #endif +/** \addtogroup Resampler + * \{ */ +/** \addtogroup Resampler_gnuradio_blocks + * \{ */ + + class direct_resampler_conditioner_cs; #if GNURADIO_USES_STD_POINTERS using direct_resampler_conditioner_cs_sptr = std::shared_ptr; @@ -83,4 +89,7 @@ private: uint32_t d_phase_step; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_DIRECT_RESAMPLER_CONDITIONER_CS_H diff --git a/src/algorithms/signal_source/adapters/ad9361_fpga_signal_source.h b/src/algorithms/signal_source/adapters/ad9361_fpga_signal_source.h index dbd556b23..f6a594508 100644 --- a/src/algorithms/signal_source/adapters/ad9361_fpga_signal_source.h +++ b/src/algorithms/signal_source/adapters/ad9361_fpga_signal_source.h @@ -32,6 +32,13 @@ #include #include + +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + + class ConfigurationInterface; class Ad9361FpgaSignalSource : public GNSSBlockInterface @@ -132,4 +139,7 @@ private: bool rf_shutdown_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_AD9361_FPGA_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/custom_udp_signal_source.h b/src/algorithms/signal_source/adapters/custom_udp_signal_source.h index 65581213b..0c4455ecd 100644 --- a/src/algorithms/signal_source/adapters/custom_udp_signal_source.h +++ b/src/algorithms/signal_source/adapters/custom_udp_signal_source.h @@ -36,6 +36,11 @@ #include #endif +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + class ConfigurationInterface; @@ -101,4 +106,7 @@ private: bool IQ_swap_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_CUSTOM_UDP_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/file_signal_source.h b/src/algorithms/signal_source/adapters/file_signal_source.h index 3248361d1..3245c4db4 100644 --- a/src/algorithms/signal_source/adapters/file_signal_source.h +++ b/src/algorithms/signal_source/adapters/file_signal_source.h @@ -39,6 +39,14 @@ #include #endif +/** \addtogroup Signal_Source Signal Source + * Classes for Signal Source management. + * \{ */ +/** \addtogroup Signal_Source_adapters signal_source_adapters + * Classes that wrap GNU Radio signal sources with a GNSSBlockInterface + * \{ */ + + class ConfigurationInterface; /*! @@ -129,4 +137,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_FILE_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/flexiband_signal_source.h b/src/algorithms/signal_source/adapters/flexiband_signal_source.h index 134c32e17..79729eb9c 100644 --- a/src/algorithms/signal_source/adapters/flexiband_signal_source.h +++ b/src/algorithms/signal_source/adapters/flexiband_signal_source.h @@ -36,6 +36,12 @@ #include +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -102,4 +108,7 @@ private: bool flag_read_file; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_FLEXIBAND_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/fmcomms2_signal_source.h b/src/algorithms/signal_source/adapters/fmcomms2_signal_source.h index bc2e625ec..519582096 100644 --- a/src/algorithms/signal_source/adapters/fmcomms2_signal_source.h +++ b/src/algorithms/signal_source/adapters/fmcomms2_signal_source.h @@ -40,6 +40,12 @@ #include #endif +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + + class ConfigurationInterface; class Fmcomms2SignalSource : public GNSSBlockInterface @@ -132,4 +138,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_FMCOMMS2_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/gen_signal_source.h b/src/algorithms/signal_source/adapters/gen_signal_source.h index bd7b00fea..16ae3543f 100644 --- a/src/algorithms/signal_source/adapters/gen_signal_source.h +++ b/src/algorithms/signal_source/adapters/gen_signal_source.h @@ -29,6 +29,13 @@ #include #include + +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + + /*! * \brief This class wraps blocks that generates synthesized GNSS signal and * filters the signal. @@ -62,4 +69,7 @@ private: bool connected_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GEN_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/gn3s_signal_source.h b/src/algorithms/signal_source/adapters/gn3s_signal_source.h index 59e8751f9..dafb7e412 100644 --- a/src/algorithms/signal_source/adapters/gn3s_signal_source.h +++ b/src/algorithms/signal_source/adapters/gn3s_signal_source.h @@ -30,6 +30,11 @@ #include #include +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + class ConfigurationInterface; @@ -81,4 +86,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GN3S_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/labsat_signal_source.h b/src/algorithms/signal_source/adapters/labsat_signal_source.h index e66fb62bf..57a17fd45 100644 --- a/src/algorithms/signal_source/adapters/labsat_signal_source.h +++ b/src/algorithms/signal_source/adapters/labsat_signal_source.h @@ -30,6 +30,12 @@ #include #include +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -86,4 +92,6 @@ private: bool dump_; }; +/** \} */ +/** \} */ #endif // GNSS_SDR_LABSAT_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/multichannel_file_signal_source.h b/src/algorithms/signal_source/adapters/multichannel_file_signal_source.h index 2f17ee35f..4fc2e5131 100644 --- a/src/algorithms/signal_source/adapters/multichannel_file_signal_source.h +++ b/src/algorithms/signal_source/adapters/multichannel_file_signal_source.h @@ -40,6 +40,13 @@ #include #endif + +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -126,4 +133,7 @@ private: bool enable_throttle_control_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_MULTICHANNEL_FILE_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/nsr_file_signal_source.h b/src/algorithms/signal_source/adapters/nsr_file_signal_source.h index 81a45dd2d..3ef2624db 100644 --- a/src/algorithms/signal_source/adapters/nsr_file_signal_source.h +++ b/src/algorithms/signal_source/adapters/nsr_file_signal_source.h @@ -39,6 +39,11 @@ #include #endif +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + class ConfigurationInterface; /*! @@ -126,4 +131,7 @@ private: bool enable_throttle_control_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_NSR_FILE_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/osmosdr_signal_source.h b/src/algorithms/signal_source/adapters/osmosdr_signal_source.h index d960c6289..1daa122f4 100644 --- a/src/algorithms/signal_source/adapters/osmosdr_signal_source.h +++ b/src/algorithms/signal_source/adapters/osmosdr_signal_source.h @@ -36,6 +36,11 @@ #include #endif +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + class ConfigurationInterface; /*! @@ -109,4 +114,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_OSMOSDR_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/plutosdr_signal_source.h b/src/algorithms/signal_source/adapters/plutosdr_signal_source.h index 31a1a1e57..4c5de55a7 100644 --- a/src/algorithms/signal_source/adapters/plutosdr_signal_source.h +++ b/src/algorithms/signal_source/adapters/plutosdr_signal_source.h @@ -39,6 +39,11 @@ #include #endif +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + class ConfigurationInterface; @@ -114,4 +119,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_PLUTOSDR_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/raw_array_signal_source.h b/src/algorithms/signal_source/adapters/raw_array_signal_source.h index 5af66da6c..ea7c69c3d 100644 --- a/src/algorithms/signal_source/adapters/raw_array_signal_source.h +++ b/src/algorithms/signal_source/adapters/raw_array_signal_source.h @@ -30,6 +30,13 @@ #include #include + +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -81,4 +88,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_RAW_ARRAY_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/rtl_tcp_signal_source.h b/src/algorithms/signal_source/adapters/rtl_tcp_signal_source.h index 6993746a7..21641283e 100644 --- a/src/algorithms/signal_source/adapters/rtl_tcp_signal_source.h +++ b/src/algorithms/signal_source/adapters/rtl_tcp_signal_source.h @@ -37,6 +37,12 @@ #endif +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -111,4 +117,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_RTL_TCP_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/spir_file_signal_source.h b/src/algorithms/signal_source/adapters/spir_file_signal_source.h index ed56a509d..cefd7c4df 100644 --- a/src/algorithms/signal_source/adapters/spir_file_signal_source.h +++ b/src/algorithms/signal_source/adapters/spir_file_signal_source.h @@ -37,6 +37,13 @@ #include #endif + +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -129,4 +136,7 @@ private: bool enable_throttle_control_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_SPIR_FILE_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/spir_gss6450_file_signal_source.h b/src/algorithms/signal_source/adapters/spir_gss6450_file_signal_source.h index 1d51575e9..b1812f486 100644 --- a/src/algorithms/signal_source/adapters/spir_gss6450_file_signal_source.h +++ b/src/algorithms/signal_source/adapters/spir_gss6450_file_signal_source.h @@ -43,6 +43,12 @@ #endif +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -133,4 +139,7 @@ private: bool endian_swap_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_SPIR_GSS6450_FILE_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/two_bit_cpx_file_signal_source.h b/src/algorithms/signal_source/adapters/two_bit_cpx_file_signal_source.h index dac739062..6e2b5327a 100644 --- a/src/algorithms/signal_source/adapters/two_bit_cpx_file_signal_source.h +++ b/src/algorithms/signal_source/adapters/two_bit_cpx_file_signal_source.h @@ -40,6 +40,11 @@ #include #endif +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + class ConfigurationInterface; @@ -131,4 +136,7 @@ private: bool enable_throttle_control_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_TWO_BIT_CPX_FILE_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/two_bit_packed_file_signal_source.h b/src/algorithms/signal_source/adapters/two_bit_packed_file_signal_source.h index 5d36aebdc..0fc029b32 100644 --- a/src/algorithms/signal_source/adapters/two_bit_packed_file_signal_source.h +++ b/src/algorithms/signal_source/adapters/two_bit_packed_file_signal_source.h @@ -42,6 +42,12 @@ #endif +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -155,4 +161,7 @@ private: bool enable_throttle_control_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_TWO_BIT_CPX_FILE_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/adapters/uhd_signal_source.h b/src/algorithms/signal_source/adapters/uhd_signal_source.h index a7a5a0362..aa0a59ce2 100644 --- a/src/algorithms/signal_source/adapters/uhd_signal_source.h +++ b/src/algorithms/signal_source/adapters/uhd_signal_source.h @@ -36,6 +36,11 @@ #endif +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_adapters + * \{ */ + class ConfigurationInterface; /*! @@ -104,4 +109,7 @@ private: unsigned int out_stream_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_UHD_SIGNAL_SOURCE_H diff --git a/src/algorithms/signal_source/gnuradio_blocks/gr_complex_ip_packet_source.h b/src/algorithms/signal_source/gnuradio_blocks/gr_complex_ip_packet_source.h index 760ae869f..37ad0b16f 100644 --- a/src/algorithms/signal_source/gnuradio_blocks/gr_complex_ip_packet_source.h +++ b/src/algorithms/signal_source/gnuradio_blocks/gr_complex_ip_packet_source.h @@ -37,6 +37,13 @@ #include #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 diff --git a/src/algorithms/signal_source/gnuradio_blocks/labsat23_source.h b/src/algorithms/signal_source/gnuradio_blocks/labsat23_source.h index 6f3754ebf..7522f4f2a 100644 --- a/src/algorithms/signal_source/gnuradio_blocks/labsat23_source.h +++ b/src/algorithms/signal_source/gnuradio_blocks/labsat23_source.h @@ -32,6 +32,12 @@ #include #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 diff --git a/src/algorithms/signal_source/gnuradio_blocks/rtl_tcp_signal_source_c.h b/src/algorithms/signal_source/gnuradio_blocks/rtl_tcp_signal_source_c.h index 85253499d..acdd0d129 100644 --- a/src/algorithms/signal_source/gnuradio_blocks/rtl_tcp_signal_source_c.h +++ b/src/algorithms/signal_source/gnuradio_blocks/rtl_tcp_signal_source_c.h @@ -43,6 +43,13 @@ #include #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 diff --git a/src/algorithms/signal_source/gnuradio_blocks/unpack_2bit_samples.h b/src/algorithms/signal_source/gnuradio_blocks/unpack_2bit_samples.h index f6dfac24e..5bac6ad03 100644 --- a/src/algorithms/signal_source/gnuradio_blocks/unpack_2bit_samples.h +++ b/src/algorithms/signal_source/gnuradio_blocks/unpack_2bit_samples.h @@ -66,6 +66,12 @@ #include #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 diff --git a/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_2bit_cpx_samples.h b/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_2bit_cpx_samples.h index 6aee70dc6..b3ab27b2a 100644 --- a/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_2bit_cpx_samples.h +++ b/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_2bit_cpx_samples.h @@ -31,6 +31,12 @@ #include #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 diff --git a/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_2bit_samples.h b/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_2bit_samples.h index 04fbb47e1..6af8a5b33 100644 --- a/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_2bit_samples.h +++ b/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_2bit_samples.h @@ -27,6 +27,11 @@ #include #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 diff --git a/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_4bit_samples.h b/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_4bit_samples.h index 8e3500bab..ad22d9a1a 100644 --- a/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_4bit_samples.h +++ b/src/algorithms/signal_source/gnuradio_blocks/unpack_byte_4bit_samples.h @@ -24,6 +24,12 @@ #include +/** \addtogroup Signal_Source + * \{ */ +/** \addtogroup Signal_Source_gnuradio_blocks + * \{ */ + + class unpack_byte_4bit_samples; using unpack_byte_4bit_samples_sptr = std::shared_ptr; @@ -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 diff --git a/src/algorithms/signal_source/gnuradio_blocks/unpack_intspir_1bit_samples.h b/src/algorithms/signal_source/gnuradio_blocks/unpack_intspir_1bit_samples.h index 25b58482f..d70b00fbc 100644 --- a/src/algorithms/signal_source/gnuradio_blocks/unpack_intspir_1bit_samples.h +++ b/src/algorithms/signal_source/gnuradio_blocks/unpack_intspir_1bit_samples.h @@ -27,6 +27,13 @@ #include #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 diff --git a/src/algorithms/signal_source/gnuradio_blocks/unpack_spir_gss6450_samples.h b/src/algorithms/signal_source/gnuradio_blocks/unpack_spir_gss6450_samples.h index 1f9432790..ff9941af7 100644 --- a/src/algorithms/signal_source/gnuradio_blocks/unpack_spir_gss6450_samples.h +++ b/src/algorithms/signal_source/gnuradio_blocks/unpack_spir_gss6450_samples.h @@ -28,6 +28,12 @@ #include #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 diff --git a/src/algorithms/signal_source/libs/ad9361_manager.h b/src/algorithms/signal_source/libs/ad9361_manager.h index d0ebc55d1..bcd05e5c0 100644 --- a/src/algorithms/signal_source/libs/ad9361_manager.h +++ b/src/algorithms/signal_source/libs/ad9361_manager.h @@ -26,6 +26,12 @@ #include #include +/** \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 diff --git a/src/algorithms/signal_source/libs/fpga_dynamic_bit_selection.h b/src/algorithms/signal_source/libs/fpga_dynamic_bit_selection.h index eeb1b7704..538671aa2 100644 --- a/src/algorithms/signal_source/libs/fpga_dynamic_bit_selection.h +++ b/src/algorithms/signal_source/libs/fpga_dynamic_bit_selection.h @@ -29,6 +29,12 @@ #include #include +/** \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 diff --git a/src/algorithms/signal_source/libs/fpga_switch.h b/src/algorithms/signal_source/libs/fpga_switch.h index d53e2f6f8..d272f0a10 100644 --- a/src/algorithms/signal_source/libs/fpga_switch.h +++ b/src/algorithms/signal_source/libs/fpga_switch.h @@ -28,6 +28,12 @@ #include +/** \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 diff --git a/src/algorithms/signal_source/libs/gnss_sdr_valve.h b/src/algorithms/signal_source/libs/gnss_sdr_valve.h index 5b3bd7f20..029daf2a7 100644 --- a/src/algorithms/signal_source/libs/gnss_sdr_valve.h +++ b/src/algorithms/signal_source/libs/gnss_sdr_valve.h @@ -35,6 +35,12 @@ #include #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 diff --git a/src/algorithms/signal_source/libs/rtl_tcp_commands.h b/src/algorithms/signal_source/libs/rtl_tcp_commands.h index b411c41cd..7b6811a15 100644 --- a/src/algorithms/signal_source/libs/rtl_tcp_commands.h +++ b/src/algorithms/signal_source/libs/rtl_tcp_commands.h @@ -24,6 +24,12 @@ #include // for tcp, tcp::socket #include // 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 diff --git a/src/algorithms/signal_source/libs/rtl_tcp_dongle_info.h b/src/algorithms/signal_source/libs/rtl_tcp_dongle_info.h index 9dbff4f62..0ef5f03c8 100644 --- a/src/algorithms/signal_source/libs/rtl_tcp_dongle_info.h +++ b/src/algorithms/signal_source/libs/rtl_tcp_dongle_info.h @@ -24,6 +24,13 @@ #include + +/** \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 diff --git a/src/algorithms/telemetry_decoder/adapters/beidou_b1i_telemetry_decoder.h b/src/algorithms/telemetry_decoder/adapters/beidou_b1i_telemetry_decoder.h index b45bbf9a3..c287d3677 100644 --- a/src/algorithms/telemetry_decoder/adapters/beidou_b1i_telemetry_decoder.h +++ b/src/algorithms/telemetry_decoder/adapters/beidou_b1i_telemetry_decoder.h @@ -31,6 +31,12 @@ #include // for size_t #include +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -88,4 +94,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif diff --git a/src/algorithms/telemetry_decoder/adapters/beidou_b3i_telemetry_decoder.h b/src/algorithms/telemetry_decoder/adapters/beidou_b3i_telemetry_decoder.h index b7438b1fb..998b1512e 100644 --- a/src/algorithms/telemetry_decoder/adapters/beidou_b3i_telemetry_decoder.h +++ b/src/algorithms/telemetry_decoder/adapters/beidou_b3i_telemetry_decoder.h @@ -29,6 +29,13 @@ #include // for size_t #include + +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -82,4 +89,6 @@ private: bool dump_; }; +/** \} */ +/** \} */ #endif diff --git a/src/algorithms/telemetry_decoder/adapters/galileo_e1b_telemetry_decoder.h b/src/algorithms/telemetry_decoder/adapters/galileo_e1b_telemetry_decoder.h index afe9fd71e..f2881b7e5 100644 --- a/src/algorithms/telemetry_decoder/adapters/galileo_e1b_telemetry_decoder.h +++ b/src/algorithms/telemetry_decoder/adapters/galileo_e1b_telemetry_decoder.h @@ -32,6 +32,11 @@ #include // for size_t #include +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_adapters + * \{ */ + class ConfigurationInterface; @@ -92,4 +97,7 @@ private: bool dump_; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GALILEO_E1B_TELEMETRY_DECODER_H diff --git a/src/algorithms/telemetry_decoder/adapters/galileo_e5a_telemetry_decoder.h b/src/algorithms/telemetry_decoder/adapters/galileo_e5a_telemetry_decoder.h index d74b4ff89..c1445c62d 100644 --- a/src/algorithms/telemetry_decoder/adapters/galileo_e5a_telemetry_decoder.h +++ b/src/algorithms/telemetry_decoder/adapters/galileo_e5a_telemetry_decoder.h @@ -34,6 +34,12 @@ #include // for size_t #include +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -93,4 +99,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E5A_TELEMETRY_DECODER_H diff --git a/src/algorithms/telemetry_decoder/adapters/galileo_e5b_telemetry_decoder.h b/src/algorithms/telemetry_decoder/adapters/galileo_e5b_telemetry_decoder.h index ab3889714..1cb358f49 100644 --- a/src/algorithms/telemetry_decoder/adapters/galileo_e5b_telemetry_decoder.h +++ b/src/algorithms/telemetry_decoder/adapters/galileo_e5b_telemetry_decoder.h @@ -32,6 +32,11 @@ #include // for size_t #include +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_adapters + * \{ */ + class ConfigurationInterface; @@ -107,4 +112,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E5B_TELEMETRY_DECODER_H diff --git a/src/algorithms/telemetry_decoder/adapters/glonass_l1_ca_telemetry_decoder.h b/src/algorithms/telemetry_decoder/adapters/glonass_l1_ca_telemetry_decoder.h index b6b54d7a2..42283657a 100644 --- a/src/algorithms/telemetry_decoder/adapters/glonass_l1_ca_telemetry_decoder.h +++ b/src/algorithms/telemetry_decoder/adapters/glonass_l1_ca_telemetry_decoder.h @@ -31,6 +31,12 @@ #include // for size_t #include +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -87,4 +93,7 @@ private: bool dump_; }; + +/** \} */ +/** \} */ #endif diff --git a/src/algorithms/telemetry_decoder/adapters/glonass_l2_ca_telemetry_decoder.h b/src/algorithms/telemetry_decoder/adapters/glonass_l2_ca_telemetry_decoder.h index c008f82d6..5471c6f84 100644 --- a/src/algorithms/telemetry_decoder/adapters/glonass_l2_ca_telemetry_decoder.h +++ b/src/algorithms/telemetry_decoder/adapters/glonass_l2_ca_telemetry_decoder.h @@ -30,6 +30,12 @@ #include // for size_t #include +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -86,4 +92,7 @@ private: bool dump_; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GLONASS_L2_CA_TELEMETRY_DECODER_H diff --git a/src/algorithms/telemetry_decoder/adapters/gps_l1_ca_telemetry_decoder.h b/src/algorithms/telemetry_decoder/adapters/gps_l1_ca_telemetry_decoder.h index 2a7898a8c..8ca2b3220 100644 --- a/src/algorithms/telemetry_decoder/adapters/gps_l1_ca_telemetry_decoder.h +++ b/src/algorithms/telemetry_decoder/adapters/gps_l1_ca_telemetry_decoder.h @@ -30,6 +30,15 @@ #include // for size_t #include +/** \addtogroup Telemetry_Decoder Telemetry Decoder + * Classes for the decoding of GNSS Navigation messages. + * \{ */ +/** \addtogroup Telemetry_Decoder_adapters telemetry_decoder_adapters + * Wrap GNU Radio blocs for the decoding of GNSS Navigation messages with a + * TelemetryDecoderInterface + * \{ */ + + class ConfigurationInterface; /*! @@ -87,4 +96,7 @@ private: bool dump_; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GPS_L1_CA_TELEMETRY_DECODER_H diff --git a/src/algorithms/telemetry_decoder/adapters/gps_l2c_telemetry_decoder.h b/src/algorithms/telemetry_decoder/adapters/gps_l2c_telemetry_decoder.h index f56a2b920..5d3b0d527 100644 --- a/src/algorithms/telemetry_decoder/adapters/gps_l2c_telemetry_decoder.h +++ b/src/algorithms/telemetry_decoder/adapters/gps_l2c_telemetry_decoder.h @@ -30,6 +30,13 @@ #include // for size_t #include + +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -87,4 +94,7 @@ private: bool dump_; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GPS_L2C_TELEMETRY_DECODER_H diff --git a/src/algorithms/telemetry_decoder/adapters/gps_l5_telemetry_decoder.h b/src/algorithms/telemetry_decoder/adapters/gps_l5_telemetry_decoder.h index 63cfa9986..12343841c 100644 --- a/src/algorithms/telemetry_decoder/adapters/gps_l5_telemetry_decoder.h +++ b/src/algorithms/telemetry_decoder/adapters/gps_l5_telemetry_decoder.h @@ -31,6 +31,11 @@ #include // for size_t #include +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_adapters + * \{ */ + class ConfigurationInterface; @@ -89,4 +94,7 @@ private: bool dump_; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GPS_L5_TELEMETRY_DECODER_H diff --git a/src/algorithms/telemetry_decoder/adapters/sbas_l1_telemetry_decoder.h b/src/algorithms/telemetry_decoder/adapters/sbas_l1_telemetry_decoder.h index 8f4c66e8b..fd31ea9cf 100644 --- a/src/algorithms/telemetry_decoder/adapters/sbas_l1_telemetry_decoder.h +++ b/src/algorithms/telemetry_decoder/adapters/sbas_l1_telemetry_decoder.h @@ -31,6 +31,10 @@ #include // for size_t #include +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_adapters + * \{ */ class ConfigurationInterface; @@ -91,4 +95,7 @@ private: bool dump_; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_SBAS_L1_TELEMETRY_DECODER_H diff --git a/src/algorithms/telemetry_decoder/gnuradio_blocks/beidou_b1i_telemetry_decoder_gs.h b/src/algorithms/telemetry_decoder/gnuradio_blocks/beidou_b1i_telemetry_decoder_gs.h index 56938df96..0aba2e6c4 100644 --- a/src/algorithms/telemetry_decoder/gnuradio_blocks/beidou_b1i_telemetry_decoder_gs.h +++ b/src/algorithms/telemetry_decoder/gnuradio_blocks/beidou_b1i_telemetry_decoder_gs.h @@ -39,6 +39,12 @@ #endif +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_gnuradio_blocks + * \{ */ + + class beidou_b1i_telemetry_decoder_gs; #if GNURADIO_USES_STD_POINTERS @@ -124,4 +130,7 @@ private: bool d_dump; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_BEIDOU_B1I_TELEMETRY_DECODER_GS_H diff --git a/src/algorithms/telemetry_decoder/gnuradio_blocks/beidou_b3i_telemetry_decoder_gs.h b/src/algorithms/telemetry_decoder/gnuradio_blocks/beidou_b3i_telemetry_decoder_gs.h index f99f81c91..a4ca3dcff 100644 --- a/src/algorithms/telemetry_decoder/gnuradio_blocks/beidou_b3i_telemetry_decoder_gs.h +++ b/src/algorithms/telemetry_decoder/gnuradio_blocks/beidou_b3i_telemetry_decoder_gs.h @@ -35,6 +35,13 @@ #include #endif + +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_gnuradio_blocks + * \{ */ + + class beidou_b3i_telemetry_decoder_gs; #if GNURADIO_USES_STD_POINTERS @@ -120,4 +127,7 @@ private: bool d_dump; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_BEIDOU_B3I_TELEMETRY_DECODER_GS_H diff --git a/src/algorithms/telemetry_decoder/gnuradio_blocks/galileo_telemetry_decoder_gs.h b/src/algorithms/telemetry_decoder/gnuradio_blocks/galileo_telemetry_decoder_gs.h index 31d367b57..424da3eb2 100644 --- a/src/algorithms/telemetry_decoder/gnuradio_blocks/galileo_telemetry_decoder_gs.h +++ b/src/algorithms/telemetry_decoder/gnuradio_blocks/galileo_telemetry_decoder_gs.h @@ -41,6 +41,12 @@ #include #endif +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_gnuradio_blocks + * \{ */ + + class galileo_telemetry_decoder_gs; #if GNURADIO_USES_STD_POINTERS @@ -142,4 +148,7 @@ private: bool d_dump; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_TELEMETRY_DECODER_GS_H diff --git a/src/algorithms/telemetry_decoder/gnuradio_blocks/glonass_l1_ca_telemetry_decoder_gs.h b/src/algorithms/telemetry_decoder/gnuradio_blocks/glonass_l1_ca_telemetry_decoder_gs.h index 857e8c0f4..412911b2d 100644 --- a/src/algorithms/telemetry_decoder/gnuradio_blocks/glonass_l1_ca_telemetry_decoder_gs.h +++ b/src/algorithms/telemetry_decoder/gnuradio_blocks/glonass_l1_ca_telemetry_decoder_gs.h @@ -39,6 +39,11 @@ #include #endif +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_gnuradio_blocks + * \{ */ + class glonass_l1_ca_telemetry_decoder_gs; @@ -123,4 +128,7 @@ private: bool d_dump; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L1_CA_TELEMETRY_DECODER_GS_H diff --git a/src/algorithms/telemetry_decoder/gnuradio_blocks/glonass_l2_ca_telemetry_decoder_gs.h b/src/algorithms/telemetry_decoder/gnuradio_blocks/glonass_l2_ca_telemetry_decoder_gs.h index e343a5485..4753bd2fb 100644 --- a/src/algorithms/telemetry_decoder/gnuradio_blocks/glonass_l2_ca_telemetry_decoder_gs.h +++ b/src/algorithms/telemetry_decoder/gnuradio_blocks/glonass_l2_ca_telemetry_decoder_gs.h @@ -38,6 +38,12 @@ #include #endif +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_gnuradio_blocks + * \{ */ + + class glonass_l2_ca_telemetry_decoder_gs; #if GNURADIO_USES_STD_POINTERS @@ -116,4 +122,7 @@ private: bool d_dump; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L2_CA_TELEMETRY_DECODER_GS_H diff --git a/src/algorithms/telemetry_decoder/gnuradio_blocks/gps_l1_ca_telemetry_decoder_gs.h b/src/algorithms/telemetry_decoder/gnuradio_blocks/gps_l1_ca_telemetry_decoder_gs.h index 7525496fe..f1bd92277 100644 --- a/src/algorithms/telemetry_decoder/gnuradio_blocks/gps_l1_ca_telemetry_decoder_gs.h +++ b/src/algorithms/telemetry_decoder/gnuradio_blocks/gps_l1_ca_telemetry_decoder_gs.h @@ -37,6 +37,13 @@ #include #endif +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_gnuradio_blocks telemetry_decoder_gr_blocks + * GNU Radio blocks for the demodulation of GNSS navigation messages. + * \{ */ + + class gps_l1_ca_telemetry_decoder_gs; #if GNURADIO_USES_STD_POINTERS @@ -113,4 +120,7 @@ private: bool d_dump; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_TELEMETRY_DECODER_GS_H diff --git a/src/algorithms/telemetry_decoder/gnuradio_blocks/gps_l2c_telemetry_decoder_gs.h b/src/algorithms/telemetry_decoder/gnuradio_blocks/gps_l2c_telemetry_decoder_gs.h index 4b5435379..424c3726f 100644 --- a/src/algorithms/telemetry_decoder/gnuradio_blocks/gps_l2c_telemetry_decoder_gs.h +++ b/src/algorithms/telemetry_decoder/gnuradio_blocks/gps_l2c_telemetry_decoder_gs.h @@ -38,6 +38,10 @@ extern "C" #include "cnav_msg.h" } +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_gnuradio_blocks + * \{ */ class gps_l2c_telemetry_decoder_gs; @@ -103,4 +107,6 @@ private: }; +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L2C_TELEMETRY_DECODER_GS_H diff --git a/src/algorithms/telemetry_decoder/gnuradio_blocks/gps_l5_telemetry_decoder_gs.h b/src/algorithms/telemetry_decoder/gnuradio_blocks/gps_l5_telemetry_decoder_gs.h index a9cc5db5a..fcd73f334 100644 --- a/src/algorithms/telemetry_decoder/gnuradio_blocks/gps_l5_telemetry_decoder_gs.h +++ b/src/algorithms/telemetry_decoder/gnuradio_blocks/gps_l5_telemetry_decoder_gs.h @@ -41,6 +41,11 @@ extern "C" } +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_gnuradio_blocks + * \{ */ + class gps_l5_telemetry_decoder_gs; #if GNURADIO_USES_STD_POINTERS @@ -99,4 +104,6 @@ private: }; +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L5_TELEMETRY_DECODER_GS_H diff --git a/src/algorithms/telemetry_decoder/gnuradio_blocks/sbas_l1_telemetry_decoder_gs.h b/src/algorithms/telemetry_decoder/gnuradio_blocks/sbas_l1_telemetry_decoder_gs.h index 93c19e08f..d1741ba40 100644 --- a/src/algorithms/telemetry_decoder/gnuradio_blocks/sbas_l1_telemetry_decoder_gs.h +++ b/src/algorithms/telemetry_decoder/gnuradio_blocks/sbas_l1_telemetry_decoder_gs.h @@ -38,6 +38,12 @@ #include #endif +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_gnuradio_blocks + * \{ */ + + class Viterbi_Decoder; class sbas_l1_telemetry_decoder_gs; @@ -166,4 +172,7 @@ private: } d_crc_verifier; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_SBAS_L1_TELEMETRY_DECODER_GS_H diff --git a/src/algorithms/telemetry_decoder/libs/convolutional.h b/src/algorithms/telemetry_decoder/libs/convolutional.h index 316d53da4..603fa979c 100644 --- a/src/algorithms/telemetry_decoder/libs/convolutional.h +++ b/src/algorithms/telemetry_decoder/libs/convolutional.h @@ -41,6 +41,13 @@ #include #include +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_libs + * Utilities for the decoding of GNSS navigation messages. + * \{ */ + + /* define constants used throughout the library */ const float MAXLOG = 1e7; /* Define infinity */ @@ -269,4 +276,6 @@ inline void Viterbi(int output_u_int[], } -#endif +/** \} */ +/** \} */ +#endif // GNSS_SDR_CONVOLUTIONAL_H diff --git a/src/algorithms/telemetry_decoder/libs/libswiftcnav/bits.c b/src/algorithms/telemetry_decoder/libs/libswiftcnav/bits.c index 7667ae666..67ba0d488 100644 --- a/src/algorithms/telemetry_decoder/libs/libswiftcnav/bits.c +++ b/src/algorithms/telemetry_decoder/libs/libswiftcnav/bits.c @@ -27,10 +27,6 @@ static const uint8_t BITN[16] = {0, 1, 1, 2, 1, 2, 2, 3, 1, 2, 2, 3, 2, 3, 3, 4}; -/** \defgroup bits Bit Utils - * Bit field packing, unpacking and utility functions. - * \{ */ - /** Computes the parity of a 32-bit word. * * References: @@ -301,5 +297,3 @@ uint8_t count_bits_u8(uint8_t v, uint8_t bv) } return bv == 1 ? r : 8 - r; } - -/** \} */ diff --git a/src/algorithms/telemetry_decoder/libs/libswiftcnav/bits.h b/src/algorithms/telemetry_decoder/libs/libswiftcnav/bits.h index 58968758a..f861f44a6 100644 --- a/src/algorithms/telemetry_decoder/libs/libswiftcnav/bits.h +++ b/src/algorithms/telemetry_decoder/libs/libswiftcnav/bits.h @@ -26,6 +26,13 @@ #include "swift_common.h" +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_libswiftcnav telemetry_decoder_libswiftcnav + * Utilities for CNAV message decoding by Swift Navigation Inc. + * \{ */ + + uint8_t parity(uint32_t x); uint32_t getbitu(const uint8_t *buff, uint32_t pos, uint8_t len); int32_t getbits(const uint8_t *buff, uint32_t pos, uint8_t len); @@ -39,4 +46,7 @@ uint8_t count_bits_u32(uint32_t v, uint8_t bv); uint8_t count_bits_u16(uint16_t v, uint8_t bv); uint8_t count_bits_u8(uint8_t v, uint8_t bv); + +/** \} */ +/** \} */ #endif /* GNSS_SDR_BITS_H_ */ diff --git a/src/algorithms/telemetry_decoder/libs/libswiftcnav/cnav_msg.h b/src/algorithms/telemetry_decoder/libs/libswiftcnav/cnav_msg.h index 5310fa7e6..6be609101 100644 --- a/src/algorithms/telemetry_decoder/libs/libswiftcnav/cnav_msg.h +++ b/src/algorithms/telemetry_decoder/libs/libswiftcnav/cnav_msg.h @@ -32,11 +32,12 @@ #include #include -/** \addtogroup GPS_L2 +/** \addtogroup Telemetry_Decoder * \{ */ -/** \addtogroup gps_cnav_decoder +/** \addtogroup Telemetry_Decoder_libswiftcnav * \{ */ + /** Size of the Viterbi decoder history. */ #define GPS_L2_V27_HISTORY_LENGTH_BITS 64 /** Bits to accumulate before decoding starts. */ @@ -108,5 +109,4 @@ bool cnav_msg_decoder_add_symbol(cnav_msg_decoder_t *dec, /** \} */ /** \} */ - #endif /* GNSS_SDR_CNAV_MSG_H_ */ diff --git a/src/algorithms/telemetry_decoder/libs/libswiftcnav/edc.h b/src/algorithms/telemetry_decoder/libs/libswiftcnav/edc.h index 493bcd6c4..224e33484 100644 --- a/src/algorithms/telemetry_decoder/libs/libswiftcnav/edc.h +++ b/src/algorithms/telemetry_decoder/libs/libswiftcnav/edc.h @@ -27,7 +27,16 @@ #include "swift_common.h" +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_libswiftcnav + * \{ */ + + uint32_t crc24q(const uint8_t *buf, uint32_t len, uint32_t crc); uint32_t crc24q_bits(uint32_t crc, const uint8_t *buf, uint32_t n_bits, bool invert); -#endif /* GNSS_SDR_EDC_H_ */ + +/** \} */ +/** \} */ +#endif /* GNSS_SDR_EDC_H */ diff --git a/src/algorithms/telemetry_decoder/libs/libswiftcnav/swift_common.h b/src/algorithms/telemetry_decoder/libs/libswiftcnav/swift_common.h index a150c1098..f7546120a 100644 --- a/src/algorithms/telemetry_decoder/libs/libswiftcnav/swift_common.h +++ b/src/algorithms/telemetry_decoder/libs/libswiftcnav/swift_common.h @@ -27,9 +27,11 @@ #ifndef GNSS_SDR_SWIFT_COMMON_H #define GNSS_SDR_SWIFT_COMMON_H -/** \defgroup common Common definitions - * Common definitions used throughout the library. +/** \addtogroup Telemetry_Decoder * \{ */ +/** \addtogroup Telemetry_Decoder_libswiftcnav + * \{ */ + #define ABS(x) ((x) < 0 ? -(x) : (x)) #define MIN(x, y) (((x) < (y)) ? (x) : (y)) @@ -40,6 +42,7 @@ #include #include -/** \} */ -#endif /* GNSS_SDR_SWIFT_COMMON_H_ */ +/** \} */ +/** \} */ +#endif /* GNSS_SDR_SWIFT_COMMON_H */ diff --git a/src/algorithms/telemetry_decoder/libs/viterbi_decoder.h b/src/algorithms/telemetry_decoder/libs/viterbi_decoder.h index 960a4907c..1871394ac 100644 --- a/src/algorithms/telemetry_decoder/libs/viterbi_decoder.h +++ b/src/algorithms/telemetry_decoder/libs/viterbi_decoder.h @@ -25,6 +25,12 @@ #include #include +/** \addtogroup Telemetry_Decoder + * \{ */ +/** \addtogroup Telemetry_Decoder_libs telemetry_decoder_libs + * \{ */ + + /*! * \brief Class that implements a Viterbi decoder */ @@ -114,4 +120,7 @@ private: bool d_trellis_state_is_initialised; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_VITERBI_DECODER_H diff --git a/src/algorithms/tracking/adapters/beidou_b1i_dll_pll_tracking.h b/src/algorithms/tracking/adapters/beidou_b1i_dll_pll_tracking.h index e7d8be140..d6de574bb 100644 --- a/src/algorithms/tracking/adapters/beidou_b1i_dll_pll_tracking.h +++ b/src/algorithms/tracking/adapters/beidou_b1i_dll_pll_tracking.h @@ -30,6 +30,12 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -93,4 +99,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_BEIDOU_B1I_DLL_PLL_TRACKING_H diff --git a/src/algorithms/tracking/adapters/beidou_b3i_dll_pll_tracking.h b/src/algorithms/tracking/adapters/beidou_b3i_dll_pll_tracking.h index 8a325f51b..3b8435a7f 100644 --- a/src/algorithms/tracking/adapters/beidou_b3i_dll_pll_tracking.h +++ b/src/algorithms/tracking/adapters/beidou_b3i_dll_pll_tracking.h @@ -30,6 +30,12 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -93,4 +99,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_BEIDOU_B3I_DLL_PLL_TRACKING_H diff --git a/src/algorithms/tracking/adapters/galileo_e1_dll_pll_veml_tracking.h b/src/algorithms/tracking/adapters/galileo_e1_dll_pll_veml_tracking.h index b4c0443a5..dbdaf781d 100644 --- a/src/algorithms/tracking/adapters/galileo_e1_dll_pll_veml_tracking.h +++ b/src/algorithms/tracking/adapters/galileo_e1_dll_pll_veml_tracking.h @@ -30,6 +30,11 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + class ConfigurationInterface; @@ -97,4 +102,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E1_DLL_PLL_VEML_TRACKING_H diff --git a/src/algorithms/tracking/adapters/galileo_e1_dll_pll_veml_tracking_fpga.h b/src/algorithms/tracking/adapters/galileo_e1_dll_pll_veml_tracking_fpga.h index ed1b66393..7a1c453a3 100644 --- a/src/algorithms/tracking/adapters/galileo_e1_dll_pll_veml_tracking_fpga.h +++ b/src/algorithms/tracking/adapters/galileo_e1_dll_pll_veml_tracking_fpga.h @@ -30,6 +30,11 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + class ConfigurationInterface; @@ -137,4 +142,6 @@ private: }; +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E1_DLL_PLL_VEML_TRACKING_FPGA_H diff --git a/src/algorithms/tracking/adapters/galileo_e1_tcp_connector_tracking.h b/src/algorithms/tracking/adapters/galileo_e1_tcp_connector_tracking.h index d5f25368e..c76f262e8 100644 --- a/src/algorithms/tracking/adapters/galileo_e1_tcp_connector_tracking.h +++ b/src/algorithms/tracking/adapters/galileo_e1_tcp_connector_tracking.h @@ -32,6 +32,11 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + class ConfigurationInterface; @@ -97,4 +102,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E1_TCP_CONNECTOR_TRACKING_H diff --git a/src/algorithms/tracking/adapters/galileo_e5a_dll_pll_tracking.h b/src/algorithms/tracking/adapters/galileo_e5a_dll_pll_tracking.h index 6b6d8c24a..134e227f7 100644 --- a/src/algorithms/tracking/adapters/galileo_e5a_dll_pll_tracking.h +++ b/src/algorithms/tracking/adapters/galileo_e5a_dll_pll_tracking.h @@ -30,6 +30,12 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -94,4 +100,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E5A_DLL_PLL_TRACKING_H diff --git a/src/algorithms/tracking/adapters/galileo_e5a_dll_pll_tracking_fpga.h b/src/algorithms/tracking/adapters/galileo_e5a_dll_pll_tracking_fpga.h index 9a83638e1..5fbbc8998 100644 --- a/src/algorithms/tracking/adapters/galileo_e5a_dll_pll_tracking_fpga.h +++ b/src/algorithms/tracking/adapters/galileo_e5a_dll_pll_tracking_fpga.h @@ -25,6 +25,12 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -129,4 +135,7 @@ private: bool d_track_pilot; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E5A_DLL_PLL_TRACKING_FPGA_H diff --git a/src/algorithms/tracking/adapters/galileo_e5b_dll_pll_tracking.h b/src/algorithms/tracking/adapters/galileo_e5b_dll_pll_tracking.h index 2b43c6266..b910e19cb 100644 --- a/src/algorithms/tracking/adapters/galileo_e5b_dll_pll_tracking.h +++ b/src/algorithms/tracking/adapters/galileo_e5b_dll_pll_tracking.h @@ -31,6 +31,12 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -110,4 +116,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E5B_DLL_PLL_TRACKING_H diff --git a/src/algorithms/tracking/adapters/glonass_l1_ca_dll_pll_c_aid_tracking.h b/src/algorithms/tracking/adapters/glonass_l1_ca_dll_pll_c_aid_tracking.h index 38f7cddbd..89dc6d169 100644 --- a/src/algorithms/tracking/adapters/glonass_l1_ca_dll_pll_c_aid_tracking.h +++ b/src/algorithms/tracking/adapters/glonass_l1_ca_dll_pll_c_aid_tracking.h @@ -34,6 +34,12 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -99,4 +105,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L1_CA_DLL_PLL_C_AID_TRACKING_H diff --git a/src/algorithms/tracking/adapters/glonass_l1_ca_dll_pll_tracking.h b/src/algorithms/tracking/adapters/glonass_l1_ca_dll_pll_tracking.h index 4a1ff8833..b8278e3a2 100644 --- a/src/algorithms/tracking/adapters/glonass_l1_ca_dll_pll_tracking.h +++ b/src/algorithms/tracking/adapters/glonass_l1_ca_dll_pll_tracking.h @@ -32,6 +32,12 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -96,4 +102,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L1_CA_DLL_PLL_TRACKING_H diff --git a/src/algorithms/tracking/adapters/glonass_l2_ca_dll_pll_c_aid_tracking.h b/src/algorithms/tracking/adapters/glonass_l2_ca_dll_pll_c_aid_tracking.h index d290d69bd..acd62580b 100644 --- a/src/algorithms/tracking/adapters/glonass_l2_ca_dll_pll_c_aid_tracking.h +++ b/src/algorithms/tracking/adapters/glonass_l2_ca_dll_pll_c_aid_tracking.h @@ -32,6 +32,12 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -98,4 +104,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L2_CA_DLL_PLL_C_AID_TRACKING_H diff --git a/src/algorithms/tracking/adapters/glonass_l2_ca_dll_pll_tracking.h b/src/algorithms/tracking/adapters/glonass_l2_ca_dll_pll_tracking.h index 3ecd9d832..2e5a726d6 100644 --- a/src/algorithms/tracking/adapters/glonass_l2_ca_dll_pll_tracking.h +++ b/src/algorithms/tracking/adapters/glonass_l2_ca_dll_pll_tracking.h @@ -31,6 +31,12 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -95,4 +101,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L2_CA_DLL_PLL_TRACKING_H diff --git a/src/algorithms/tracking/adapters/gps_l1_ca_dll_pll_tracking.h b/src/algorithms/tracking/adapters/gps_l1_ca_dll_pll_tracking.h index 4fe01ebc9..eb67be0f5 100644 --- a/src/algorithms/tracking/adapters/gps_l1_ca_dll_pll_tracking.h +++ b/src/algorithms/tracking/adapters/gps_l1_ca_dll_pll_tracking.h @@ -31,6 +31,14 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * Classes for GNSS signal tracking. + * \{ */ +/** \addtogroup Tracking_adapters tracking_adapters + * Wrap GNU Radio blocks for GNSS signal tracking with a TrackingInterface + * \{ */ + + class ConfigurationInterface; /*! @@ -95,4 +103,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_DLL_PLL_TRACKING_H diff --git a/src/algorithms/tracking/adapters/gps_l1_ca_dll_pll_tracking_fpga.h b/src/algorithms/tracking/adapters/gps_l1_ca_dll_pll_tracking_fpga.h index 2051d4be3..a9d3b6f1c 100644 --- a/src/algorithms/tracking/adapters/gps_l1_ca_dll_pll_tracking_fpga.h +++ b/src/algorithms/tracking/adapters/gps_l1_ca_dll_pll_tracking_fpga.h @@ -30,6 +30,12 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -133,4 +139,7 @@ private: int32_t* d_ca_codes; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_DLL_PLL_TRACKING_FPGA_H diff --git a/src/algorithms/tracking/adapters/gps_l1_ca_dll_pll_tracking_gpu.h b/src/algorithms/tracking/adapters/gps_l1_ca_dll_pll_tracking_gpu.h index 5e8824cac..167a760b5 100644 --- a/src/algorithms/tracking/adapters/gps_l1_ca_dll_pll_tracking_gpu.h +++ b/src/algorithms/tracking/adapters/gps_l1_ca_dll_pll_tracking_gpu.h @@ -30,6 +30,11 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + class ConfigurationInterface; @@ -95,4 +100,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_DLL_PLL_TRACKING_GPU_H diff --git a/src/algorithms/tracking/adapters/gps_l1_ca_kf_tracking.h b/src/algorithms/tracking/adapters/gps_l1_ca_kf_tracking.h index 02fb242b2..03a99550d 100644 --- a/src/algorithms/tracking/adapters/gps_l1_ca_kf_tracking.h +++ b/src/algorithms/tracking/adapters/gps_l1_ca_kf_tracking.h @@ -33,6 +33,12 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -97,4 +103,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_KF_TRACKING_H diff --git a/src/algorithms/tracking/adapters/gps_l1_ca_tcp_connector_tracking.h b/src/algorithms/tracking/adapters/gps_l1_ca_tcp_connector_tracking.h index 10429d4b4..0febc6039 100644 --- a/src/algorithms/tracking/adapters/gps_l1_ca_tcp_connector_tracking.h +++ b/src/algorithms/tracking/adapters/gps_l1_ca_tcp_connector_tracking.h @@ -31,6 +31,11 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + class ConfigurationInterface; @@ -96,4 +101,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_TCP_CONNECTOR_TRACKING_H diff --git a/src/algorithms/tracking/adapters/gps_l2_m_dll_pll_tracking.h b/src/algorithms/tracking/adapters/gps_l2_m_dll_pll_tracking.h index 7fa5077f8..fd89824fc 100644 --- a/src/algorithms/tracking/adapters/gps_l2_m_dll_pll_tracking.h +++ b/src/algorithms/tracking/adapters/gps_l2_m_dll_pll_tracking.h @@ -31,6 +31,12 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -95,4 +101,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L2_M_DLL_PLL_TRACKING_H diff --git a/src/algorithms/tracking/adapters/gps_l2_m_dll_pll_tracking_fpga.h b/src/algorithms/tracking/adapters/gps_l2_m_dll_pll_tracking_fpga.h index 6ed195af8..36172fb63 100644 --- a/src/algorithms/tracking/adapters/gps_l2_m_dll_pll_tracking_fpga.h +++ b/src/algorithms/tracking/adapters/gps_l2_m_dll_pll_tracking_fpga.h @@ -32,6 +32,12 @@ #include #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + + class Gnss_Synchro; class ConfigurationInterface; @@ -98,4 +104,7 @@ private: int* d_ca_codes; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L2_M_DLL_PLL_TRACKING_FPGA_H diff --git a/src/algorithms/tracking/adapters/gps_l5_dll_pll_tracking.h b/src/algorithms/tracking/adapters/gps_l5_dll_pll_tracking.h index 6c7413bd4..ed159f973 100644 --- a/src/algorithms/tracking/adapters/gps_l5_dll_pll_tracking.h +++ b/src/algorithms/tracking/adapters/gps_l5_dll_pll_tracking.h @@ -30,6 +30,12 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -94,4 +100,7 @@ private: unsigned int out_streams_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L5_DLL_PLL_TRACKING_H diff --git a/src/algorithms/tracking/adapters/gps_l5_dll_pll_tracking_fpga.h b/src/algorithms/tracking/adapters/gps_l5_dll_pll_tracking_fpga.h index 15e04f52f..66bb8def3 100644 --- a/src/algorithms/tracking/adapters/gps_l5_dll_pll_tracking_fpga.h +++ b/src/algorithms/tracking/adapters/gps_l5_dll_pll_tracking_fpga.h @@ -31,6 +31,12 @@ #include "tracking_interface.h" #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_adapters + * \{ */ + + class ConfigurationInterface; /*! @@ -136,4 +142,7 @@ private: int32_t* d_data_codes; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L5_DLL_PLL_TRACKING_FPGA_H diff --git a/src/algorithms/tracking/gnuradio_blocks/dll_pll_veml_tracking.h b/src/algorithms/tracking/gnuradio_blocks/dll_pll_veml_tracking.h index 23fd429fb..c38040806 100644 --- a/src/algorithms/tracking/gnuradio_blocks/dll_pll_veml_tracking.h +++ b/src/algorithms/tracking/gnuradio_blocks/dll_pll_veml_tracking.h @@ -44,6 +44,13 @@ #include #endif +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_gnuradio_blocks tracking_gr_blocks + * GNU Radio blocks for GNSS signal tracking. + * \{ */ + + class Gnss_Synchro; class dll_pll_veml_tracking; @@ -205,4 +212,7 @@ private: bool d_enable_extended_integration; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_DLL_PLL_VEML_TRACKING_H diff --git a/src/algorithms/tracking/gnuradio_blocks/dll_pll_veml_tracking_fpga.h b/src/algorithms/tracking/gnuradio_blocks/dll_pll_veml_tracking_fpga.h index 4c3c4a4d0..276f48ab7 100644 --- a/src/algorithms/tracking/gnuradio_blocks/dll_pll_veml_tracking_fpga.h +++ b/src/algorithms/tracking/gnuradio_blocks/dll_pll_veml_tracking_fpga.h @@ -43,6 +43,12 @@ #include #endif +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_gnuradio_blocks + * \{ */ + + class Fpga_Multicorrelator_8sc; class Gnss_Synchro; class dll_pll_veml_tracking_fpga; @@ -246,4 +252,7 @@ private: bool d_sc_demodulate_enabled; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_DLL_PLL_VEML_TRACKING_FPGA_H diff --git a/src/algorithms/tracking/gnuradio_blocks/galileo_e1_tcp_connector_tracking_cc.h b/src/algorithms/tracking/gnuradio_blocks/galileo_e1_tcp_connector_tracking_cc.h index fe6c20ff7..7d8571798 100644 --- a/src/algorithms/tracking/gnuradio_blocks/galileo_e1_tcp_connector_tracking_cc.h +++ b/src/algorithms/tracking/gnuradio_blocks/galileo_e1_tcp_connector_tracking_cc.h @@ -42,6 +42,11 @@ #include #endif +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_gnuradio_blocks + * \{ */ + class Galileo_E1_Tcp_Connector_Tracking_cc; @@ -182,4 +187,7 @@ private: std::string sys; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E1_TCP_CONNECTOR_TRACKING_CC_H diff --git a/src/algorithms/tracking/gnuradio_blocks/glonass_l1_ca_dll_pll_c_aid_tracking_cc.h b/src/algorithms/tracking/gnuradio_blocks/glonass_l1_ca_dll_pll_c_aid_tracking_cc.h index 3c40b7ebe..f6776b95a 100644 --- a/src/algorithms/tracking/gnuradio_blocks/glonass_l1_ca_dll_pll_c_aid_tracking_cc.h +++ b/src/algorithms/tracking/gnuradio_blocks/glonass_l1_ca_dll_pll_c_aid_tracking_cc.h @@ -46,6 +46,11 @@ #include #endif +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_gnuradio_blocks + * \{ */ + class glonass_l1_ca_dll_pll_c_aid_tracking_cc; @@ -205,4 +210,7 @@ private: bool d_dump; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L1_CA_DLL_PLL_C_AID_TRACKING_CC_H diff --git a/src/algorithms/tracking/gnuradio_blocks/glonass_l1_ca_dll_pll_c_aid_tracking_sc.h b/src/algorithms/tracking/gnuradio_blocks/glonass_l1_ca_dll_pll_c_aid_tracking_sc.h index b3e77bded..1d38892f6 100644 --- a/src/algorithms/tracking/gnuradio_blocks/glonass_l1_ca_dll_pll_c_aid_tracking_sc.h +++ b/src/algorithms/tracking/gnuradio_blocks/glonass_l1_ca_dll_pll_c_aid_tracking_sc.h @@ -46,6 +46,13 @@ #include #endif + +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_gnuradio_blocks + * \{ */ + + class glonass_l1_ca_dll_pll_c_aid_tracking_sc; #if GNURADIO_USES_STD_POINTERS @@ -204,4 +211,7 @@ private: bool d_dump; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L1_CA_DLL_PLL_C_AID_TRACKING_SC_H diff --git a/src/algorithms/tracking/gnuradio_blocks/glonass_l1_ca_dll_pll_tracking_cc.h b/src/algorithms/tracking/gnuradio_blocks/glonass_l1_ca_dll_pll_tracking_cc.h index 35ff25fe8..978f37f3a 100644 --- a/src/algorithms/tracking/gnuradio_blocks/glonass_l1_ca_dll_pll_tracking_cc.h +++ b/src/algorithms/tracking/gnuradio_blocks/glonass_l1_ca_dll_pll_tracking_cc.h @@ -43,6 +43,13 @@ #include #endif + +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_gnuradio_blocks + * \{ */ + + class Glonass_L1_Ca_Dll_Pll_Tracking_cc; #if GNURADIO_USES_STD_POINTERS @@ -171,4 +178,7 @@ private: bool d_dump; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L1_CA_DLL_PLL_TRACKING_CC_H diff --git a/src/algorithms/tracking/gnuradio_blocks/glonass_l2_ca_dll_pll_c_aid_tracking_cc.h b/src/algorithms/tracking/gnuradio_blocks/glonass_l2_ca_dll_pll_c_aid_tracking_cc.h index 3689aa939..926f1005c 100644 --- a/src/algorithms/tracking/gnuradio_blocks/glonass_l2_ca_dll_pll_c_aid_tracking_cc.h +++ b/src/algorithms/tracking/gnuradio_blocks/glonass_l2_ca_dll_pll_c_aid_tracking_cc.h @@ -43,6 +43,12 @@ #include #endif +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_gnuradio_blocks + * \{ */ + + class glonass_l2_ca_dll_pll_c_aid_tracking_cc; #if GNURADIO_USES_STD_POINTERS @@ -201,4 +207,7 @@ private: bool d_dump; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L1_CA_DLL_PLL_C_AID_TRACKING_CC_H diff --git a/src/algorithms/tracking/gnuradio_blocks/glonass_l2_ca_dll_pll_c_aid_tracking_sc.h b/src/algorithms/tracking/gnuradio_blocks/glonass_l2_ca_dll_pll_c_aid_tracking_sc.h index 4ffa51183..82f876af4 100644 --- a/src/algorithms/tracking/gnuradio_blocks/glonass_l2_ca_dll_pll_c_aid_tracking_sc.h +++ b/src/algorithms/tracking/gnuradio_blocks/glonass_l2_ca_dll_pll_c_aid_tracking_sc.h @@ -43,6 +43,12 @@ #include #endif +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_gnuradio_blocks + * \{ */ + + class glonass_l2_ca_dll_pll_c_aid_tracking_sc; #if GNURADIO_USES_STD_POINTERS @@ -201,4 +207,7 @@ private: bool d_dump; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L2_CA_DLL_PLL_C_AID_TRACKING_SC_H diff --git a/src/algorithms/tracking/gnuradio_blocks/glonass_l2_ca_dll_pll_tracking_cc.h b/src/algorithms/tracking/gnuradio_blocks/glonass_l2_ca_dll_pll_tracking_cc.h index fbb5b5eec..9e0f30b68 100644 --- a/src/algorithms/tracking/gnuradio_blocks/glonass_l2_ca_dll_pll_tracking_cc.h +++ b/src/algorithms/tracking/gnuradio_blocks/glonass_l2_ca_dll_pll_tracking_cc.h @@ -41,6 +41,12 @@ #include #endif +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_gnuradio_blocks + * \{ */ + + class Glonass_L2_Ca_Dll_Pll_Tracking_cc; #if GNURADIO_USES_STD_POINTERS @@ -169,4 +175,7 @@ private: bool d_dump; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L2_CA_DLL_PLL_TRACKING_CC_H diff --git a/src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_dll_pll_tracking_gpu_cc.h b/src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_dll_pll_tracking_gpu_cc.h index bdb9b2925..e759aa7bd 100644 --- a/src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_dll_pll_tracking_gpu_cc.h +++ b/src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_dll_pll_tracking_gpu_cc.h @@ -40,6 +40,12 @@ #include #endif +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_gnuradio_blocks + * \{ */ + + class Gps_L1_Ca_Dll_Pll_Tracking_GPU_cc; #if GNURADIO_USES_STD_POINTERS @@ -174,4 +180,7 @@ private: bool d_dump; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_DLL_PLL_TRACKING_GPU_CC_H diff --git a/src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_kf_tracking_cc.h b/src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_kf_tracking_cc.h index 26f768874..6bd4d0f57 100644 --- a/src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_kf_tracking_cc.h +++ b/src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_kf_tracking_cc.h @@ -50,6 +50,12 @@ #include #endif +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_gnuradio_blocks + * \{ */ + + class Gps_L1_Ca_Kf_Tracking_cc; #if GNURADIO_USES_STD_POINTERS @@ -221,4 +227,7 @@ private: int32_t save_matfile(); }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_KF_TRACKING_CC_H diff --git a/src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_tcp_connector_tracking_cc.h b/src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_tcp_connector_tracking_cc.h index 3b4468523..329b2629c 100644 --- a/src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_tcp_connector_tracking_cc.h +++ b/src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_tcp_connector_tracking_cc.h @@ -40,6 +40,11 @@ #include #endif +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_gnuradio_blocks + * \{ */ + class Gps_L1_Ca_Tcp_Connector_Tracking_cc; @@ -158,4 +163,7 @@ private: bool d_dump; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_TCP_CONNECTOR_TRACKING_CC_H diff --git a/src/algorithms/tracking/libs/bayesian_estimation.h b/src/algorithms/tracking/libs/bayesian_estimation.h index cb0602fc2..5b683e524 100644 --- a/src/algorithms/tracking/libs/bayesian_estimation.h +++ b/src/algorithms/tracking/libs/bayesian_estimation.h @@ -41,6 +41,12 @@ #include #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + + /*! \brief Bayesian_estimator is an estimator of noise characteristics (i.e. mean, covariance) * * Bayesian_estimator is an estimator which performs estimation of noise characteristics from @@ -79,4 +85,7 @@ private: int nu_prior; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_BAYESIAN_ESTIMATION_H diff --git a/src/algorithms/tracking/libs/cpu_multicorrelator.h b/src/algorithms/tracking/libs/cpu_multicorrelator.h index bf3a55878..4926f0ec7 100644 --- a/src/algorithms/tracking/libs/cpu_multicorrelator.h +++ b/src/algorithms/tracking/libs/cpu_multicorrelator.h @@ -27,6 +27,13 @@ #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs tracking_libs + * Utitilies for GNSS signal tracking. + * \{ */ + + /*! * \brief Class that implements carrier wipe-off and correlators. */ @@ -54,4 +61,6 @@ private: }; +/** \} */ +/** \} */ #endif // GNSS_SDR_CPU_MULTICORRELATOR_H diff --git a/src/algorithms/tracking/libs/cpu_multicorrelator_16sc.h b/src/algorithms/tracking/libs/cpu_multicorrelator_16sc.h index 6bddde613..b413a366d 100644 --- a/src/algorithms/tracking/libs/cpu_multicorrelator_16sc.h +++ b/src/algorithms/tracking/libs/cpu_multicorrelator_16sc.h @@ -26,6 +26,11 @@ #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + /*! * \brief Class that implements carrier wipe-off and correlators. @@ -54,4 +59,6 @@ private: }; +/** \} */ +/** \} */ #endif // GNSS_SDR_CPU_MULTICORRELATOR_H diff --git a/src/algorithms/tracking/libs/cpu_multicorrelator_real_codes.h b/src/algorithms/tracking/libs/cpu_multicorrelator_real_codes.h index 0b4081f0f..e99cb16dc 100644 --- a/src/algorithms/tracking/libs/cpu_multicorrelator_real_codes.h +++ b/src/algorithms/tracking/libs/cpu_multicorrelator_real_codes.h @@ -28,6 +28,12 @@ #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + + /*! * \brief Class that implements carrier wipe-off and correlators. */ @@ -58,4 +64,6 @@ private: }; +/** \} */ +/** \} */ #endif // GNSS_SDR_CPU_MULTICORRELATOR_REAL_CODES_H diff --git a/src/algorithms/tracking/libs/cuda_multicorrelator.h b/src/algorithms/tracking/libs/cuda_multicorrelator.h index 28bfb69db..9b2fdf4ff 100644 --- a/src/algorithms/tracking/libs/cuda_multicorrelator.h +++ b/src/algorithms/tracking/libs/cuda_multicorrelator.h @@ -37,6 +37,12 @@ #include #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + + // GPU new internal data types for complex numbers struct GPU_Complex @@ -158,4 +164,6 @@ private: }; +/** \} */ +/** \} */ #endif // GNSS_SDR_CUDA_MULTICORRELATOR_H diff --git a/src/algorithms/tracking/libs/dll_pll_conf.h b/src/algorithms/tracking/libs/dll_pll_conf.h index efe5b7e4d..56795a991 100644 --- a/src/algorithms/tracking/libs/dll_pll_conf.h +++ b/src/algorithms/tracking/libs/dll_pll_conf.h @@ -26,6 +26,12 @@ #include #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + + class Dll_Pll_Conf { public: @@ -79,4 +85,7 @@ public: bool dump_mat; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_DLL_PLL_CONF_H diff --git a/src/algorithms/tracking/libs/dll_pll_conf_fpga.h b/src/algorithms/tracking/libs/dll_pll_conf_fpga.h index e4211f883..8599580eb 100644 --- a/src/algorithms/tracking/libs/dll_pll_conf_fpga.h +++ b/src/algorithms/tracking/libs/dll_pll_conf_fpga.h @@ -28,6 +28,12 @@ #include #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + + class Dll_Pll_Conf_Fpga { public: @@ -98,4 +104,7 @@ public: bool dump_mat; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_DLL_PLL_CONF_FPGA_H diff --git a/src/algorithms/tracking/libs/exponential_smoother.h b/src/algorithms/tracking/libs/exponential_smoother.h index d54190272..af6083cde 100644 --- a/src/algorithms/tracking/libs/exponential_smoother.h +++ b/src/algorithms/tracking/libs/exponential_smoother.h @@ -25,6 +25,12 @@ #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + + /*! \brief * Class that implements a first-order exponential smoother. * @@ -62,4 +68,7 @@ private: bool initializing_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_EXPONENTIAL_SMOOTHER_H diff --git a/src/algorithms/tracking/libs/fpga_multicorrelator.h b/src/algorithms/tracking/libs/fpga_multicorrelator.h index 36a746ccd..716d2f29c 100644 --- a/src/algorithms/tracking/libs/fpga_multicorrelator.h +++ b/src/algorithms/tracking/libs/fpga_multicorrelator.h @@ -31,6 +31,11 @@ #include #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + /*! * \brief Class that implements carrier wipe-off and correlators. @@ -259,4 +264,7 @@ private: bool d_secondary_code_enabled; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_FPGA_MULTICORRELATOR_H diff --git a/src/algorithms/tracking/libs/lock_detectors.h b/src/algorithms/tracking/libs/lock_detectors.h index baa52cf2c..b951384b7 100644 --- a/src/algorithms/tracking/libs/lock_detectors.h +++ b/src/algorithms/tracking/libs/lock_detectors.h @@ -39,6 +39,11 @@ #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + /*! \brief cn0_svn_estimator is a Carrier-to-Noise (CN0) estimator * based on the Signal-to-Noise Variance (SNV) estimator @@ -105,4 +110,7 @@ float cn0_m2m4_estimator(const gr_complex* Prompt_buffer, int length, float coh_ */ float carrier_lock_detector(gr_complex* Prompt_buffer, int length); -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_LOCK_DETECTORS_H diff --git a/src/algorithms/tracking/libs/nonlinear_tracking.h b/src/algorithms/tracking/libs/nonlinear_tracking.h index d0f13c3a6..abc49289e 100644 --- a/src/algorithms/tracking/libs/nonlinear_tracking.h +++ b/src/algorithms/tracking/libs/nonlinear_tracking.h @@ -39,6 +39,12 @@ #include #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + + // Abstract model function class ModelFunction { @@ -106,4 +112,7 @@ private: arma::mat P_x_est; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_NONLINEAR_TRACKING_H diff --git a/src/algorithms/tracking/libs/tcp_communication.h b/src/algorithms/tracking/libs/tcp_communication.h index e5cfcb7e5..88211a579 100644 --- a/src/algorithms/tracking/libs/tcp_communication.h +++ b/src/algorithms/tracking/libs/tcp_communication.h @@ -25,6 +25,12 @@ #include #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + + #if USE_BOOST_ASIO_IO_CONTEXT using b_io_context = boost::asio::io_context; #else @@ -54,4 +60,7 @@ private: boost::asio::ip::tcp::socket tcp_socket_; }; + +/** \} */ +/** \} */ #endif diff --git a/src/algorithms/tracking/libs/tcp_packet_data.h b/src/algorithms/tracking/libs/tcp_packet_data.h index 321f9057f..f012931cf 100644 --- a/src/algorithms/tracking/libs/tcp_packet_data.h +++ b/src/algorithms/tracking/libs/tcp_packet_data.h @@ -21,6 +21,12 @@ #ifndef GNSS_SDR_TCP_PACKET_DATA_H #define GNSS_SDR_TCP_PACKET_DATA_H +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + + /*! * \brief Class that implements a TCP data packet */ @@ -34,4 +40,7 @@ public: float proc_pack_carrier_doppler_hz; }; + +/** \} */ +/** \} */ #endif diff --git a/src/algorithms/tracking/libs/tracking_2nd_DLL_filter.h b/src/algorithms/tracking/libs/tracking_2nd_DLL_filter.h index c72d165c5..ae992516a 100644 --- a/src/algorithms/tracking/libs/tracking_2nd_DLL_filter.h +++ b/src/algorithms/tracking/libs/tracking_2nd_DLL_filter.h @@ -26,6 +26,12 @@ #ifndef GNSS_SDR_TRACKING_2ND_DLL_FILTER_H #define GNSS_SDR_TRACKING_2ND_DLL_FILTER_H +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + + /*! * \brief This class implements a 2nd order DLL filter for code tracking loop. * @@ -59,4 +65,7 @@ private: float d_old_code_nco = 0.0; }; + +/** \} */ +/** \} */ #endif diff --git a/src/algorithms/tracking/libs/tracking_2nd_PLL_filter.h b/src/algorithms/tracking/libs/tracking_2nd_PLL_filter.h index 2a3f90543..1a4240391 100644 --- a/src/algorithms/tracking/libs/tracking_2nd_PLL_filter.h +++ b/src/algorithms/tracking/libs/tracking_2nd_PLL_filter.h @@ -26,6 +26,12 @@ #ifndef GNSS_SDR_TRACKING_2ND_PLL_FILTER_H #define GNSS_SDR_TRACKING_2ND_PLL_FILTER_H +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + + /*! * \brief This class implements a 2nd order PLL filter for carrier tracking loop. * @@ -57,4 +63,7 @@ private: float d_old_carr_nco = 0.0; }; + +/** \} */ +/** \} */ #endif diff --git a/src/algorithms/tracking/libs/tracking_FLL_PLL_filter.h b/src/algorithms/tracking/libs/tracking_FLL_PLL_filter.h index 2334d1685..cc42a9ccf 100644 --- a/src/algorithms/tracking/libs/tracking_FLL_PLL_filter.h +++ b/src/algorithms/tracking/libs/tracking_FLL_PLL_filter.h @@ -20,6 +20,12 @@ #ifndef GNSS_SDR_TRACKING_FLL_PLL_FILTER_H #define GNSS_SDR_TRACKING_FLL_PLL_FILTER_H +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + + /*! * \brief This class implements a hybrid FLL and PLL filter for tracking carrier loop */ @@ -47,4 +53,7 @@ private: int d_order; }; + +/** \} */ +/** \} */ #endif diff --git a/src/algorithms/tracking/libs/tracking_discriminators.h b/src/algorithms/tracking/libs/tracking_discriminators.h index 4d911db71..834d511fc 100644 --- a/src/algorithms/tracking/libs/tracking_discriminators.h +++ b/src/algorithms/tracking/libs/tracking_discriminators.h @@ -30,6 +30,12 @@ #include #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + + /*! brief FLL four quadrant arctan discriminator * * FLL four quadrant arctan discriminator: @@ -192,4 +198,7 @@ double CosBocCorrelationFunction(double offset_in_chips) } } -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_TRACKING_DISCRIMINATORS_H diff --git a/src/algorithms/tracking/libs/tracking_loop_filter.h b/src/algorithms/tracking/libs/tracking_loop_filter.h index 3e9f66e35..2b9748617 100644 --- a/src/algorithms/tracking/libs/tracking_loop_filter.h +++ b/src/algorithms/tracking/libs/tracking_loop_filter.h @@ -25,6 +25,11 @@ #include +/** \addtogroup Tracking + * \{ */ +/** \addtogroup Tracking_libs + * \{ */ + /*! * \brief This class implements a generic 1st, 2nd or 3rd order loop filter @@ -86,4 +91,7 @@ private: bool d_include_last_integrator; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_TRACKING_LOOP_FILTER_H diff --git a/src/core/interfaces/acquisition_interface.h b/src/core/interfaces/acquisition_interface.h index 1187236e4..ac3c3de0b 100644 --- a/src/core/interfaces/acquisition_interface.h +++ b/src/core/interfaces/acquisition_interface.h @@ -31,6 +31,13 @@ #include "gnss_synchro.h" #include +/** \addtogroup Core + * \{ */ +/** \addtogroup GNSS_Block_Interfaces GNSS block interfaces + * GNSS block interfaces. + * \{ */ + + template class Concurrent_Queue; @@ -65,4 +72,7 @@ public: virtual void set_resampler_latency(uint32_t latency_samples) = 0; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_ACQUISITION_INTERFACE */ diff --git a/src/core/interfaces/channel_interface.h b/src/core/interfaces/channel_interface.h index ff11ffaec..68cf43774 100644 --- a/src/core/interfaces/channel_interface.h +++ b/src/core/interfaces/channel_interface.h @@ -29,6 +29,12 @@ #include "gnss_block_interface.h" #include "gnss_signal.h" +/** \addtogroup Core + * \{ */ +/** \addtogroup GNSS_Block_Interfaces + * \{ */ + + /*! * \brief This abstract class represents an interface to a channel GNSS block. * @@ -53,4 +59,7 @@ public: virtual void set_signal(const Gnss_Signal&) = 0; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_CHANNEL_INTERFACE_H diff --git a/src/core/interfaces/configuration_interface.h b/src/core/interfaces/configuration_interface.h index 562988275..7d28f4454 100644 --- a/src/core/interfaces/configuration_interface.h +++ b/src/core/interfaces/configuration_interface.h @@ -27,6 +27,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup GNSS_Block_Interfaces + * \{ */ + + /*! * \brief This abstract class represents an interface to configuration parameters. * @@ -55,4 +61,7 @@ public: virtual void set_property(std::string property_name, std::string value) = 0; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_CONFIGURATION_INTERFACE_H diff --git a/src/core/interfaces/gnss_block_interface.h b/src/core/interfaces/gnss_block_interface.h index c8585f65e..6bcbfa9e2 100644 --- a/src/core/interfaces/gnss_block_interface.h +++ b/src/core/interfaces/gnss_block_interface.h @@ -30,6 +30,11 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup GNSS_Block_Interfaces + * \{ */ + /*! * \brief This abstract class represents an interface to GNSS blocks. @@ -75,4 +80,7 @@ public: virtual void start(){}; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GNSS_BLOCK_INTERFACE_H diff --git a/src/core/interfaces/observables_interface.h b/src/core/interfaces/observables_interface.h index 9da017118..c326bda0a 100644 --- a/src/core/interfaces/observables_interface.h +++ b/src/core/interfaces/observables_interface.h @@ -28,6 +28,12 @@ #include "gnss_block_interface.h" +/** \addtogroup Core + * \{ */ +/** \addtogroup GNSS_Block_Interfaces + * \{ */ + + /*! * \brief This abstract class represents an interface to an observables block. * @@ -43,4 +49,7 @@ public: virtual void reset() = 0; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_OBSERVABLES_INTERFACE_H diff --git a/src/core/interfaces/pvt_interface.h b/src/core/interfaces/pvt_interface.h index d8805ef4c..d5dfc8806 100644 --- a/src/core/interfaces/pvt_interface.h +++ b/src/core/interfaces/pvt_interface.h @@ -33,6 +33,12 @@ #include "gps_ephemeris.h" #include +/** \addtogroup Core + * \{ */ +/** \addtogroup GNSS_Block_Interfaces + * \{ */ + + /*! * \brief This class represents an interface to a PVT block. * @@ -60,4 +66,7 @@ public: time_t* UTC_time) = 0; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_PVT_INTERFACE_H diff --git a/src/core/interfaces/telemetry_decoder_interface.h b/src/core/interfaces/telemetry_decoder_interface.h index 8ea705b3f..e044f7198 100644 --- a/src/core/interfaces/telemetry_decoder_interface.h +++ b/src/core/interfaces/telemetry_decoder_interface.h @@ -29,6 +29,12 @@ #include "gnss_block_interface.h" #include "gnss_satellite.h" +/** \addtogroup Core + * \{ */ +/** \addtogroup GNSS_Block_Interfaces + * \{ */ + + /*! * \brief This abstract class represents an interface to a navigation GNSS block. * @@ -45,4 +51,7 @@ public: virtual void set_channel(int channel) = 0; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_TELEMETRY_DECODER_INTERFACE_H diff --git a/src/core/interfaces/tracking_interface.h b/src/core/interfaces/tracking_interface.h index b9558ec87..e94a2aff4 100644 --- a/src/core/interfaces/tracking_interface.h +++ b/src/core/interfaces/tracking_interface.h @@ -29,6 +29,12 @@ #include "gnss_block_interface.h" #include "gnss_synchro.h" +/** \addtogroup Core + * \{ */ +/** \addtogroup GNSS_Block_Interfaces + * \{ */ + + template class Concurrent_Queue; @@ -50,4 +56,7 @@ public: virtual void set_channel(unsigned int channel) = 0; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_TRACKING_INTERFACE_H diff --git a/src/core/libs/INIReader.h b/src/core/libs/INIReader.h index 8a1646edd..afc65976b 100644 --- a/src/core/libs/INIReader.h +++ b/src/core/libs/INIReader.h @@ -32,6 +32,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver_Library + * \{ */ + + /*! * \brief Read an INI file into easy-to-access name/value pairs. (Note that I've gone * for simplicity here rather than speed, but it should be pretty decent.) @@ -61,4 +67,7 @@ private: int _error; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_INIREADER_H diff --git a/src/core/libs/channel_event.h b/src/core/libs/channel_event.h index 394b7664d..f03b23cdd 100644 --- a/src/core/libs/channel_event.h +++ b/src/core/libs/channel_event.h @@ -22,6 +22,12 @@ #include +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver_Library core_libs + * \{ */ + + class Channel_Event; using channel_event_sptr = std::shared_ptr; @@ -39,4 +45,7 @@ private: Channel_Event(int channel_id_, int event_type_); }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_CHANNEL_EVENT_H diff --git a/src/core/libs/channel_status_msg_receiver.h b/src/core/libs/channel_status_msg_receiver.h index 9b3c31935..dcb9a86fa 100644 --- a/src/core/libs/channel_status_msg_receiver.h +++ b/src/core/libs/channel_status_msg_receiver.h @@ -32,6 +32,12 @@ #include #endif +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver_Library + * \{ */ + + class channel_status_msg_receiver; #if GNURADIO_USES_STD_POINTERS @@ -68,4 +74,7 @@ private: std::map> d_channel_status_map; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_CHANNEL_STATUS_MSG_RECEIVER_CC_H diff --git a/src/core/libs/command_event.h b/src/core/libs/command_event.h index 50dbe564b..2cc77ed84 100644 --- a/src/core/libs/command_event.h +++ b/src/core/libs/command_event.h @@ -22,6 +22,12 @@ #include +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver_Library + * \{ */ + + class Command_Event; using command_event_sptr = std::shared_ptr; @@ -39,4 +45,7 @@ private: Command_Event(int command_id_, int event_type_); }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_COMMAND_EVENT_H diff --git a/src/core/libs/gnss_sdr_fpga_sample_counter.h b/src/core/libs/gnss_sdr_fpga_sample_counter.h index 100e287a5..7e4824e77 100644 --- a/src/core/libs/gnss_sdr_fpga_sample_counter.h +++ b/src/core/libs/gnss_sdr_fpga_sample_counter.h @@ -32,6 +32,12 @@ #include #endif +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver_Library + * \{ */ + + class gnss_sdr_fpga_sample_counter; #if GNURADIO_USES_STD_POINTERS @@ -90,4 +96,7 @@ private: bool is_open; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GNSS_SDR_FPGA_SAMPLE_COUNTER_H diff --git a/src/core/libs/gnss_sdr_sample_counter.h b/src/core/libs/gnss_sdr_sample_counter.h index 8321c7e20..87a3af17b 100644 --- a/src/core/libs/gnss_sdr_sample_counter.h +++ b/src/core/libs/gnss_sdr_sample_counter.h @@ -31,6 +31,13 @@ #include #endif +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver_Library + * Utilities for the core GNSS receiver. + * \{ */ + + class gnss_sdr_sample_counter; #if GNURADIO_USES_STD_POINTERS @@ -78,4 +85,7 @@ private: bool flag_enable_send_msg; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GNSS_SDR_SAMPLE_COUNTER_H diff --git a/src/core/libs/gnss_sdr_supl_client.h b/src/core/libs/gnss_sdr_supl_client.h index 7c0876b86..ef95f2764 100644 --- a/src/core/libs/gnss_sdr_supl_client.h +++ b/src/core/libs/gnss_sdr_supl_client.h @@ -46,6 +46,12 @@ extern "C" #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver_Library + * \{ */ + + /*! * \brief class that implements a C++ interface to external Secure User Location Protocol (SUPL) client library.. */ @@ -264,4 +270,7 @@ private: int ci; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_SUPL_CLIENT_H diff --git a/src/core/libs/gnss_sdr_time_counter.h b/src/core/libs/gnss_sdr_time_counter.h index 8bf0db3e0..985670eba 100644 --- a/src/core/libs/gnss_sdr_time_counter.h +++ b/src/core/libs/gnss_sdr_time_counter.h @@ -26,6 +26,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver_Library + * \{ */ + + class gnss_sdr_time_counter; using gnss_sdr_time_counter_sptr = std::shared_ptr; @@ -56,4 +62,7 @@ private: bool flag_days; // True if the receiver has been running for at least 1 day }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GNSS_SDR_SAMPLE_COUNTER_H diff --git a/src/core/libs/ini.h b/src/core/libs/ini.h index 60a47968d..db0fd9726 100644 --- a/src/core/libs/ini.h +++ b/src/core/libs/ini.h @@ -36,8 +36,13 @@ #ifndef GNSS_SDR_INI_H #define GNSS_SDR_INI_H +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver_Library + * \{ */ -/* Parse given INI-style file. May have [section]s, name=value pains + +/*! \brief Parse given INI-style file. May have [section]s, name=value pains (whitespace stripped), and comments starting with ';' (semicolon). Section is "" if name=value pain parsed before any section heading. @@ -61,4 +66,6 @@ int ini_parse(const char* filename, #endif +/** \} */ +/** \} */ #endif // GNSS_SDR_INI_H diff --git a/src/core/libs/string_converter.h b/src/core/libs/string_converter.h index 143e58266..216f1dbe9 100644 --- a/src/core/libs/string_converter.h +++ b/src/core/libs/string_converter.h @@ -25,6 +25,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver_Library + * \{ */ + + /*! * \brief Class that interprets the contents of a string * and converts it into different types. @@ -46,4 +52,7 @@ public: double convert(const std::string& value, double default_value); }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_STRING_CONVERTER_H diff --git a/src/core/libs/supl/supl.h b/src/core/libs/supl/supl.h index eeb2fd1d8..dedf90f5e 100644 --- a/src/core/libs/supl/supl.h +++ b/src/core/libs/supl/supl.h @@ -18,8 +18,8 @@ */ -#ifndef SUPL_H -#define SUPL_H +#ifndef GNSS_SDR_SUPL_H +#define GNSS_SDR_SUPL_H #ifdef USE_EXPORT #define EXPORT __attribute__((visibility("default"))) @@ -44,6 +44,13 @@ #include #include + +/** \addtogroup Core + * \{ */ +/** \addtogroup SUPL_Library core_libs_supl + * \{ */ + + #define SUPL_PORT "7275" /* error messages */ @@ -286,4 +293,7 @@ void supl_close(supl_ctx_t *ctx); int supl_ulp_send(supl_ctx_t *ctx, supl_ulp_t *pdu); int supl_ulp_recv(supl_ctx_t *ctx, supl_ulp_t *pdu); -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_SUPL_H diff --git a/src/core/monitor/gnss_synchro_monitor.h b/src/core/monitor/gnss_synchro_monitor.h index 4c117e542..3cd2018ad 100644 --- a/src/core/monitor/gnss_synchro_monitor.h +++ b/src/core/monitor/gnss_synchro_monitor.h @@ -35,6 +35,13 @@ #include #endif +/** \addtogroup Core + * \{ */ +/** \addtogroup Gnss_Synchro_Monitor core_monitor + * Classes for the Gnss_Synchro monitor. + * \{ */ + + class gnss_synchro_monitor; #if GNURADIO_USES_STD_POINTERS @@ -80,4 +87,7 @@ private: std::unique_ptr udp_sink_ptr; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GNSS_SYNCHRO_MONITOR_H diff --git a/src/core/monitor/gnss_synchro_udp_sink.h b/src/core/monitor/gnss_synchro_udp_sink.h index e107f0768..887e4839b 100644 --- a/src/core/monitor/gnss_synchro_udp_sink.h +++ b/src/core/monitor/gnss_synchro_udp_sink.h @@ -29,6 +29,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup Gnss_Synchro_Monitor + * \{ */ + + #if USE_BOOST_ASIO_IO_CONTEXT using b_io_context = boost::asio::io_context; #else @@ -55,4 +61,6 @@ private: }; +/** \} */ +/** \} */ #endif // GNSS_SDR_GNSS_SYNCHRO_UDP_SINK_H diff --git a/src/core/receiver/concurrent_map.h b/src/core/receiver/concurrent_map.h index 3299ff88d..ec17b51d2 100644 --- a/src/core/receiver/concurrent_map.h +++ b/src/core/receiver/concurrent_map.h @@ -24,6 +24,11 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver core_receiver + * \{ */ + template @@ -88,4 +93,7 @@ private: mutable std::mutex the_mutex; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_CONCURRENT_MAP_H diff --git a/src/core/receiver/concurrent_queue.h b/src/core/receiver/concurrent_queue.h index a8c28ae21..6c609b399 100644 --- a/src/core/receiver/concurrent_queue.h +++ b/src/core/receiver/concurrent_queue.h @@ -26,6 +26,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver + * \{ */ + + template /*! @@ -97,4 +103,7 @@ private: std::condition_variable the_condition_variable; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_CONCURRENT_QUEUE_H diff --git a/src/core/receiver/control_thread.h b/src/core/receiver/control_thread.h index ed6da77c2..cd66d4e49 100644 --- a/src/core/receiver/control_thread.h +++ b/src/core/receiver/control_thread.h @@ -45,6 +45,13 @@ #include // for boost::thread #endif +/** \addtogroup Core Core GNSS Receiver + * Core GNSS Receiver. + * \{ */ +/** \addtogroup Core_Receiver + * Classes for the core GNSS receiver. + * \{ */ + class ConfigurationInterface; class GNSSFlowgraph; @@ -206,4 +213,7 @@ private: bool pre_2009_file_; // to override the system time to postprocess old gnss records and avoid wrong week rollover }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_CONTROL_THREAD_H diff --git a/src/core/receiver/file_configuration.h b/src/core/receiver/file_configuration.h index a960a29d4..b61809b5b 100644 --- a/src/core/receiver/file_configuration.h +++ b/src/core/receiver/file_configuration.h @@ -33,6 +33,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver + * \{ */ + + /*! * \brief This class is an implementation of the interface ConfigurationInterface * @@ -70,4 +76,7 @@ private: int error_{}; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_FILE_CONFIGURATION_H diff --git a/src/core/receiver/gnss_block_factory.h b/src/core/receiver/gnss_block_factory.h index 427bff37f..fad210d49 100644 --- a/src/core/receiver/gnss_block_factory.h +++ b/src/core/receiver/gnss_block_factory.h @@ -33,6 +33,11 @@ #include // for string #include // for vector +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver + * \{ */ + class ConfigurationInterface; class GNSSBlockInterface; @@ -96,4 +101,7 @@ private: unsigned int out_streams); }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_BLOCK_FACTORY_H diff --git a/src/core/receiver/gnss_flowgraph.h b/src/core/receiver/gnss_flowgraph.h index 54833ea13..cc0f7be46 100644 --- a/src/core/receiver/gnss_flowgraph.h +++ b/src/core/receiver/gnss_flowgraph.h @@ -46,6 +46,12 @@ #include "gnss_sdr_fpga_sample_counter.h" #endif +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver + * \{ */ + + class ChannelInterface; class ConfigurationInterface; class GNSSBlockInterface; @@ -246,4 +252,7 @@ private: bool enable_tracking_monitor_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GNSS_FLOWGRAPH_H diff --git a/src/core/receiver/in_memory_configuration.h b/src/core/receiver/in_memory_configuration.h index 515d8d059..b76a7d3a9 100644 --- a/src/core/receiver/in_memory_configuration.h +++ b/src/core/receiver/in_memory_configuration.h @@ -31,6 +31,11 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver + * \{ */ + /*! * \brief This class is an implementation of the interface ConfigurationInterface. @@ -62,4 +67,7 @@ private: std::unique_ptr converter_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_IN_MEMORY_CONFIGURATION_H diff --git a/src/core/receiver/tcp_cmd_interface.h b/src/core/receiver/tcp_cmd_interface.h index a8bcc0d37..1995d8a1d 100644 --- a/src/core/receiver/tcp_cmd_interface.h +++ b/src/core/receiver/tcp_cmd_interface.h @@ -32,6 +32,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup Core_Receiver + * \{ */ + + class PvtInterface; class TcpCmdInterface @@ -79,4 +85,7 @@ private: bool keep_running_; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_TCP_CMD_INTERFACE_H diff --git a/src/core/system_parameters/Beidou_B1I.h b/src/core/system_parameters/Beidou_B1I.h index 3be5dacc9..c2f53c1dc 100644 --- a/src/core/system_parameters/Beidou_B1I.h +++ b/src/core/system_parameters/Beidou_B1I.h @@ -24,6 +24,12 @@ #include "gnss_frequencies.h" #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + // carrier and code frequencies constexpr double BEIDOU_B1I_FREQ_HZ = FREQ1_BDS; //!< B1I [Hz] constexpr double BEIDOU_B1I_CODE_RATE_CPS = 2.046e6; //!< Beidou B1I code rate [chips/s] @@ -46,4 +52,6 @@ constexpr char BEIDOU_B1I_GEO_PREAMBLE_SYMBOLS_STR[23] = "1111110000001100001100 constexpr char BEIDOU_B1I_D2_SECONDARY_CODE_STR[3] = "00"; +/** \} */ +/** \} */ #endif // GNSS_SDR_BEIDOU_B1I_H diff --git a/src/core/system_parameters/Beidou_B3I.h b/src/core/system_parameters/Beidou_B3I.h index 4be1f7ba1..170ba2399 100644 --- a/src/core/system_parameters/Beidou_B3I.h +++ b/src/core/system_parameters/Beidou_B3I.h @@ -23,6 +23,12 @@ #include "gnss_frequencies.h" #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + // carrier and code frequencies constexpr double BEIDOU_B3I_FREQ_HZ = FREQ3_BDS; //!< BeiDou B3I [Hz] constexpr double BEIDOU_B3I_CODE_RATE_CPS = 10.23e6; //!< BeiDou B3I code rate [chips/s] @@ -45,4 +51,6 @@ constexpr char BEIDOU_B3I_GEO_PREAMBLE_SYMBOLS_STR[23] = "1111110000001100001100 constexpr char BEIDOU_B3I_D2_SECONDARY_CODE_STR[3] = "00"; +/** \} */ +/** \} */ #endif // GNSS_SDR_BEIDOU_B3I_H diff --git a/src/core/system_parameters/Beidou_DNAV.h b/src/core/system_parameters/Beidou_DNAV.h index 8c5d3d28c..e41d86e35 100644 --- a/src/core/system_parameters/Beidou_DNAV.h +++ b/src/core/system_parameters/Beidou_DNAV.h @@ -25,6 +25,11 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + // DNAV SCALE FACTORS // EPH @@ -280,4 +285,7 @@ const std::vector > D2_OMEGA({{269, 32}}); // D2 NAV, SUBFRAME 1, PAGE 10 const std::vector > D2_IDOT({{52, 1}, {61, 13}}); + +/** \} */ +/** \} */ #endif // GNSS_SDR_BEIDOU_DNAV_H diff --git a/src/core/system_parameters/GLONASS_L1_L2_CA.h b/src/core/system_parameters/GLONASS_L1_L2_CA.h index 3ba6f62c9..c555a36ca 100644 --- a/src/core/system_parameters/GLONASS_L1_L2_CA.h +++ b/src/core/system_parameters/GLONASS_L1_L2_CA.h @@ -28,6 +28,11 @@ #include // std::pair #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + // Physical constants constexpr double GLONASS_F_M_A = 0.35e9; //!< Gravitational constant of atmosphere [m^3/s^2] @@ -307,4 +312,7 @@ const std::vector> H_N_A({{72, 5}}); const std::vector> B1({{6, 11}}); const std::vector> B2({{17, 10}}); + +/** \} */ +/** \} */ #endif // GNSS_SDR_GLONASS_L1_L2_CA_H diff --git a/src/core/system_parameters/GPS_CNAV.h b/src/core/system_parameters/GPS_CNAV.h index b45c7d80a..bb37416a7 100644 --- a/src/core/system_parameters/GPS_CNAV.h +++ b/src/core/system_parameters/GPS_CNAV.h @@ -26,6 +26,11 @@ #include // std::pair #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + // CNAV GPS NAVIGATION MESSAGE STRUCTURE // NAVIGATION MESSAGE FIELDS POSITIONS (from IS-GPS-200K Appendix III) @@ -161,4 +166,6 @@ constexpr int32_t CNAV_DELTA_TLSF_LSB = 1; // TODO: Add more frames (Almanac, etc...) +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_CNAV_H diff --git a/src/core/system_parameters/GPS_L1_CA.h b/src/core/system_parameters/GPS_L1_CA.h index 3fc5d04fa..a4f93ce91 100644 --- a/src/core/system_parameters/GPS_L1_CA.h +++ b/src/core/system_parameters/GPS_L1_CA.h @@ -27,6 +27,11 @@ #include // std::pair #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + // carrier and code frequencies constexpr double GPS_L1_FREQ_HZ = FREQ1; //!< L1 [Hz] @@ -223,4 +228,7 @@ const std::vector> HEALTH_SV22({{247, 6}}); const std::vector> HEALTH_SV23({{253, 6}}); const std::vector> HEALTH_SV24({{259, 6}}); + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L1_CA_H diff --git a/src/core/system_parameters/GPS_L2C.h b/src/core/system_parameters/GPS_L2C.h index 67fb67005..f84aeb1fc 100644 --- a/src/core/system_parameters/GPS_L2C.h +++ b/src/core/system_parameters/GPS_L2C.h @@ -28,6 +28,11 @@ #include // std::pair #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + // carrier and code frequencies constexpr double GPS_L2_FREQ_HZ = FREQ2; //!< L2 [Hz] @@ -80,4 +85,6 @@ constexpr int32_t GPS_L2C_M_INIT_REG[115] = 0132720621, 0434015513, 0566721727, 0140633660}; +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L2C_H diff --git a/src/core/system_parameters/GPS_L5.h b/src/core/system_parameters/GPS_L5.h index 4f3bbebdd..57ab2a83a 100644 --- a/src/core/system_parameters/GPS_L5.h +++ b/src/core/system_parameters/GPS_L5.h @@ -25,6 +25,11 @@ #include "gnss_frequencies.h" #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + // carrier and code frequencies constexpr double GPS_L5_FREQ_HZ = FREQ5; //!< L5 [Hz] @@ -169,4 +174,7 @@ constexpr int32_t GPS_L5Q_NH_CODE[20] = {0, 0, 0, 0, 0, 1, 0, 0, 1, 1, 0, 1, 0, constexpr char GPS_L5I_NH_CODE_STR[11] = "0000110101"; constexpr char GPS_L5Q_NH_CODE_STR[21] = "00000100110101001110"; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GPS_L5_H diff --git a/src/core/system_parameters/Galileo_E1.h b/src/core/system_parameters/Galileo_E1.h index 30743a207..3adb6ab93 100644 --- a/src/core/system_parameters/Galileo_E1.h +++ b/src/core/system_parameters/Galileo_E1.h @@ -27,6 +27,11 @@ #include // for size_t #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + // carrier and code frequencies constexpr double GALILEO_E1_FREQ_HZ = FREQ1; //!< Galileo E1 carrier frequency [Hz] @@ -157,4 +162,7 @@ constexpr char GALILEO_E1_C_PRIMARY_CODE[GALILEO_E1_NUMBER_OF_CODES][1024] = { "CD7AAC98501F29507EA4E0183E8A40D2E5117E47BB5D18D01A3732DE4C821DFE86521CBEA7DB29BE1148BD544ECC681689BCD1B41EAF755310B7659342F8EE11CB41550CC30E566E192796B66C1A83C0B28BACCFA6C393043A0A2CB89712BC1CCB174DE58E66896AF39C1CEED1E05B0435F8CF6FD920D100F51584FE24879987399481DBF27DDB6286B6353919E552E669290CE02AB4CD5113D7F484229F379C7332767EC69E4336439B05DE1C1E3563DD303A4F580BFF20A40E49CB0822F715ED0221EBCDB5DBAD751124B1715E82F37488265135B6C8BBCF4F801ECC4D3525FF189493AD4EFF0C042B070C4CA8FB1FDF43D79F06A6E4E3D35D7B07D4B728D5DC54EEDACBBBA1EDDCDC07ADF7DFCFEF835E44DF1FF66DAF2A7BAEBE218AC3B15E183044D6A8A89B3C101B40BED97ED5DF93BBC1B84931D56B8C822A6D058AC74CFA4C85D8B456698E82D5B7574C17B041E5F4BEED09F75012355CBC322B822C63F10C18A8F279E9A0E18E1FEF183D23E13894E31F6D046956FE8A647558228F6D4D6910151EC03937876B6ED7A078D33DAEB3F2239353BB8181E62B286BBC41588DE10F478A5CE5B508F205A41820356767B0A0ED4B8DB9EFE348362E9A90D6C30218B295B338B51C09239D02FC8A1E7DAAAB60AC37F5E67CFC88EEF69567B5C81A03B449F4ED38B9D295A36AA3503173F6F6F66D93CE72D753076040FACDE", "ADDCEDB50E907D20E826E6E8A0D30C20C74B2DF204EA784BAE9F618CAE33A3C937729DF9CB10BA2A4C33E0182A37200C0CC509729D828B8A2A20F283AC4F9306596684EA3FB5492A4C9F2DB459E7531C9F9C0950E7D9E93B3EE5912AE7E39AC8F4EC14B18F24E325003F477E347C5AC1B67CDB11AF3BBBBCD0AC3703024B5767AA67A208254F798684BFD1D3EACD757EEC77254950A146620400DB95E694574F739A991EBA771EBBDFF1056BB39A77DBE0636A032E17141332F951C57C6C90F348F165E3ABDD60D429D5D6BEC7E3E3463806F819EB2D212B3528A5EDE51F235AD100A35E890955F8A1DC51FDCB53EABCA2540997DD054C1F5B29462995B876B44D085904E55E1B838BEF600A992EB49CE078DF75AF3D0F137685AC0D07F0BE1EB87B63A41E74DDE869C8A683BDE60AF5D77FF18F7137495BCEFD0ED28F62F9C3E25D332B5F861D999FCDC0B4851A984A4DBB53401FD40351ADA4335C702BCC8D900C737507B990BDDBE91D201E3A0946DC968D43FD10D04B0B76667FF5B4291C2124B0124C6B710A6D1BCFAEB016B9DEEB0F7A4FE044CA4EA0CCD84B7682617C3A545071EC295B0663B3F577D562DE1D9DD80DE6A1EFD6D5991EB5246F1597B86D0E9A90CF6DB0EB2B8E7BAE9431E567F01AA98502C773742246467ABF911A91A51F6C1B9E0C3233DC1A37D17DB91A5F0F661B0EB5886964456C7818601BD0C"}; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E1_H diff --git a/src/core/system_parameters/Galileo_E5a.h b/src/core/system_parameters/Galileo_E5a.h index 899073f7d..f5394561c 100644 --- a/src/core/system_parameters/Galileo_E5a.h +++ b/src/core/system_parameters/Galileo_E5a.h @@ -25,6 +25,11 @@ #include // for size_t #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + // Carrier and code frequencies constexpr double GALILEO_E5A_FREQ_HZ = FREQ5; //!< Galileo E5a carrier frequency [Hz] @@ -231,4 +236,6 @@ constexpr char GALILEO_E5A_Q_SECONDARY_CODE[GALILEO_E5A_NUMBER_OF_CODES][101] = }; +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E5A_H diff --git a/src/core/system_parameters/Galileo_E5b.h b/src/core/system_parameters/Galileo_E5b.h index 2ae446f8c..f1f135d80 100644 --- a/src/core/system_parameters/Galileo_E5b.h +++ b/src/core/system_parameters/Galileo_E5b.h @@ -26,6 +26,11 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + // Carrier and code frequencies constexpr double GALILEO_E5B_FREQ_HZ = FREQ7; //!< Galileo E5b carrier frequency [Hz] @@ -214,4 +219,6 @@ constexpr char GALILEO_E5B_Q_SECONDARY_CODE[GALILEO_E5B_NUMBER_OF_CODES][101] = "0110010000110001000010111010110110001110101101011011001101101110001110000110010001101010111100000001"}; +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_E5B_H diff --git a/src/core/system_parameters/Galileo_FNAV.h b/src/core/system_parameters/Galileo_FNAV.h index a954dd99b..ccbd62da9 100644 --- a/src/core/system_parameters/Galileo_FNAV.h +++ b/src/core/system_parameters/Galileo_FNAV.h @@ -26,6 +26,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + const std::vector> FNAV_PAGE_TYPE_BIT({{1, 6}}); /* WORD 1 iono corrections. FNAV (Galileo E5a message)*/ @@ -174,4 +180,7 @@ const std::vector> FNAV_AF0_3_6_BIT({{181, 16}}); const std::vector> FNAV_AF1_3_6_BIT({{197, 13}}); const std::vector> FNAV_E5AHS_3_6_BIT({{210, 2}}); + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_FNAV_H diff --git a/src/core/system_parameters/Galileo_INAV.h b/src/core/system_parameters/Galileo_INAV.h index 28992d26d..899ae1dfe 100644 --- a/src/core/system_parameters/Galileo_INAV.h +++ b/src/core/system_parameters/Galileo_INAV.h @@ -26,6 +26,11 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + // Galileo INAV message structure constexpr int32_t GALILEO_INAV_PREAMBLE_LENGTH_BITS = 10; @@ -249,4 +254,7 @@ const std::vector> TIME_0_BIT({{7, 2}}); const std::vector> WN_0_BIT({{97, 12}}); const std::vector> TOW_0_BIT({{109, 20}}); + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_INAV_H diff --git a/src/core/system_parameters/MATH_CONSTANTS.h b/src/core/system_parameters/MATH_CONSTANTS.h index 121806ad2..07a87c36f 100644 --- a/src/core/system_parameters/MATH_CONSTANTS.h +++ b/src/core/system_parameters/MATH_CONSTANTS.h @@ -20,6 +20,12 @@ #ifndef GNSS_SDR_MATH_CONSTANTS_H #define GNSS_SDR_MATH_CONSTANTS_H +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + constexpr double GNSS_OMEGA_EARTH_DOT = 7.2921151467e-5; //!< Default Earth rotation rate, [rad/s] constexpr double SPEED_OF_LIGHT_M_S = 299792458.0; //!< Speed of light in vacuum [m/s] constexpr double SPEED_OF_LIGHT_M_MS = 299792.4580; //!< Speed of light in vacuum [m/ms] @@ -121,4 +127,7 @@ constexpr double AS2R = D2R / 3600.0; //!< arc sec to radian constexpr double AU = 149597870691.0; //!< 1 Astronomical Unit AU (m) distance from Earth to the Sun. + +/** \} */ +/** \} */ #endif // GNSS_SDR_MATH_CONSTANTS_H diff --git a/src/core/system_parameters/agnss_ref_location.h b/src/core/system_parameters/agnss_ref_location.h index 023733fbf..65790da1c 100644 --- a/src/core/system_parameters/agnss_ref_location.h +++ b/src/core/system_parameters/agnss_ref_location.h @@ -23,6 +23,11 @@ #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * Classes containing info about system parameters for the different GNSS. + * \{ */ /*! * \brief Interface of an Assisted GNSS REFERENCE LOCATION storage @@ -59,4 +64,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_AGNSS_REF_LOCATION_H diff --git a/src/core/system_parameters/agnss_ref_time.h b/src/core/system_parameters/agnss_ref_time.h index 86159b2dd..0e6936a05 100644 --- a/src/core/system_parameters/agnss_ref_time.h +++ b/src/core/system_parameters/agnss_ref_time.h @@ -23,6 +23,11 @@ #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + /*! * \brief Interface of an Assisted GNSS REFERENCE TIME storage @@ -61,4 +66,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_AGNSS_REF_TIME_H diff --git a/src/core/system_parameters/beidou_dnav_almanac.h b/src/core/system_parameters/beidou_dnav_almanac.h index 29dc083fe..d6f2a60ae 100644 --- a/src/core/system_parameters/beidou_dnav_almanac.h +++ b/src/core/system_parameters/beidou_dnav_almanac.h @@ -24,6 +24,11 @@ #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + /*! * \brief This class is a storage for the BeiDou D1 almanac @@ -73,4 +78,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_BEIDOU_DNAV_ALMANAC_H diff --git a/src/core/system_parameters/beidou_dnav_ephemeris.h b/src/core/system_parameters/beidou_dnav_ephemeris.h index f8b5c7efc..e4741acd8 100644 --- a/src/core/system_parameters/beidou_dnav_ephemeris.h +++ b/src/core/system_parameters/beidou_dnav_ephemeris.h @@ -25,6 +25,11 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + /*! * \brief This class is a storage and orbital model functions for the GPS SV ephemeris data as described in @@ -194,4 +199,7 @@ private: double check_t(double time); }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_BEIDOU_DNAV_EPHEMERIS_H diff --git a/src/core/system_parameters/beidou_dnav_iono.h b/src/core/system_parameters/beidou_dnav_iono.h index 65daaea64..3681ccac0 100644 --- a/src/core/system_parameters/beidou_dnav_iono.h +++ b/src/core/system_parameters/beidou_dnav_iono.h @@ -23,6 +23,11 @@ #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + /*! * \brief This class is a storage for the BEIDOU IONOSPHERIC data as described in ICD v2.1 @@ -67,4 +72,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_BEIDOU_DNAV_IONO_H diff --git a/src/core/system_parameters/beidou_dnav_navigation_message.h b/src/core/system_parameters/beidou_dnav_navigation_message.h index bf4d867a7..2804ac53d 100644 --- a/src/core/system_parameters/beidou_dnav_navigation_message.h +++ b/src/core/system_parameters/beidou_dnav_navigation_message.h @@ -37,6 +37,11 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + /*! * \brief This class decodes a BeiDou D1 NAV Data message @@ -326,4 +331,7 @@ private: bool flag_sf1_p10{}; // D2 NAV Message, Subframe 1, Page 10 decoded indicator }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_BEIDOU_DNAV_NAVIGATION_MESSAGE_H diff --git a/src/core/system_parameters/beidou_dnav_utc_model.h b/src/core/system_parameters/beidou_dnav_utc_model.h index 9f279b2cb..7578c2d35 100644 --- a/src/core/system_parameters/beidou_dnav_utc_model.h +++ b/src/core/system_parameters/beidou_dnav_utc_model.h @@ -24,6 +24,11 @@ #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + /*! * \brief This class is a storage for the BeiDou DNAV UTC Model. @@ -83,4 +88,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_BEIDOU_DNAV_UTC_MODEL_H diff --git a/src/core/system_parameters/display.h b/src/core/system_parameters/display.h index 420be649f..f4eed6490 100644 --- a/src/core/system_parameters/display.h +++ b/src/core/system_parameters/display.h @@ -22,6 +22,12 @@ #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + #ifndef NO_DISPLAY_COLORS #define DISPLAY_COLORS 1 #endif @@ -69,4 +75,7 @@ const std::string TEXT_BOLD_WHITE = ""; #endif // DISPLAY_COLORS + +/** \} */ +/** \} */ #endif // GNSS_SDR_DISPLAY_H diff --git a/src/core/system_parameters/galileo_almanac.h b/src/core/system_parameters/galileo_almanac.h index eaec3da87..2bfec22ab 100644 --- a/src/core/system_parameters/galileo_almanac.h +++ b/src/core/system_parameters/galileo_almanac.h @@ -24,6 +24,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + /*! * \brief This class is a storage for the Galileo SV ALMANAC data */ @@ -78,4 +84,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GALILEO_ALMANAC_H diff --git a/src/core/system_parameters/galileo_almanac_helper.h b/src/core/system_parameters/galileo_almanac_helper.h index b401c1543..abd8a98ae 100644 --- a/src/core/system_parameters/galileo_almanac_helper.h +++ b/src/core/system_parameters/galileo_almanac_helper.h @@ -23,6 +23,12 @@ #include "galileo_almanac.h" #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + /*! * \brief This class is a storage for the GALILEO ALMANAC data as described in GALILEO ICD * @@ -91,4 +97,7 @@ public: int32_t E5a_HS_10{}; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GALILEO_ALMANAC_HELPER_H diff --git a/src/core/system_parameters/galileo_ephemeris.h b/src/core/system_parameters/galileo_ephemeris.h index 3cc6f859a..4ca7b9b57 100644 --- a/src/core/system_parameters/galileo_ephemeris.h +++ b/src/core/system_parameters/galileo_ephemeris.h @@ -25,6 +25,11 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + /*! * \brief This class is a storage and orbital model functions for the Galileo SV ephemeris data as described in Galileo ICD paragraph 5.1.1 @@ -159,4 +164,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GALILEO_EPHEMERIS_H diff --git a/src/core/system_parameters/galileo_fnav_message.h b/src/core/system_parameters/galileo_fnav_message.h index fe2fa94ab..e4440c162 100644 --- a/src/core/system_parameters/galileo_fnav_message.h +++ b/src/core/system_parameters/galileo_fnav_message.h @@ -39,6 +39,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + /*! * \brief This class handles the Galileo F/NAV Data message, as described in the * Galileo Open Service Signal in Space Interface Control Document (OS SIS ICD), Issue 1.2 (Nov 2015). @@ -278,4 +284,7 @@ private: bool flag_almanac_2{}; // Flag indicating that almanac 2/2 (word 6) have been received }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_FNAV_MESSAGE_H diff --git a/src/core/system_parameters/galileo_inav_message.h b/src/core/system_parameters/galileo_inav_message.h index 528d8c50a..aa1dbf9d2 100644 --- a/src/core/system_parameters/galileo_inav_message.h +++ b/src/core/system_parameters/galileo_inav_message.h @@ -33,6 +33,11 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + /*! * \brief This class handles the Galileo I/NAV Data message, as described in the @@ -351,4 +356,7 @@ private: bool flag_GGTO_4{}; }; + +/** \} */ +/** \} */ #endif // GNSS_SDR_GALILEO_INAV_MESSAGE_H diff --git a/src/core/system_parameters/galileo_iono.h b/src/core/system_parameters/galileo_iono.h index 8d5b42bcc..7a8f8629c 100644 --- a/src/core/system_parameters/galileo_iono.h +++ b/src/core/system_parameters/galileo_iono.h @@ -24,6 +24,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + /*! * \brief This class is a storage for the GALILEO IONOSPHERIC data as described in Galileo ICD paragraph 5.1.6 * @@ -78,4 +84,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GALILEO_IONO_H diff --git a/src/core/system_parameters/galileo_utc_model.h b/src/core/system_parameters/galileo_utc_model.h index 5ef89fa7d..fb4eb3df6 100644 --- a/src/core/system_parameters/galileo_utc_model.h +++ b/src/core/system_parameters/galileo_utc_model.h @@ -25,6 +25,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + /*! * \brief This class is a storage for the GALILEO UTC MODEL data as described in Galileo ICD * https://www.gsc-europa.eu/sites/default/files/sites/all/files/Galileo-OS-SIS-ICD.pdf @@ -83,4 +89,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GALILEO_UTC_MODEL_H diff --git a/src/core/system_parameters/glonass_gnav_almanac.h b/src/core/system_parameters/glonass_gnav_almanac.h index 339e9033f..186ad4698 100644 --- a/src/core/system_parameters/glonass_gnav_almanac.h +++ b/src/core/system_parameters/glonass_gnav_almanac.h @@ -26,6 +26,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + /*! * \brief This class is a storage for the GLONASS SV ALMANAC data as described GLONASS ICD (Edition 5.1) * \note Code added as part of GSoC 2017 program @@ -90,4 +96,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GLONASS_ALMANAC_H diff --git a/src/core/system_parameters/glonass_gnav_ephemeris.h b/src/core/system_parameters/glonass_gnav_ephemeris.h index 7b2565c5b..03f8d4619 100644 --- a/src/core/system_parameters/glonass_gnav_ephemeris.h +++ b/src/core/system_parameters/glonass_gnav_ephemeris.h @@ -29,6 +29,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + /*! * \brief This class is a storage and orbital model functions for the GLONASS SV ephemeris data as described in GLONASS ICD (Edition 5.1) * \note Code added as part of GSoC 2017 program @@ -173,4 +179,7 @@ private: double check_t(double time); }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GLONASS_GNAV_EPHEMERIS_H diff --git a/src/core/system_parameters/glonass_gnav_navigation_message.h b/src/core/system_parameters/glonass_gnav_navigation_message.h index 6d490fca4..394c03fe5 100644 --- a/src/core/system_parameters/glonass_gnav_navigation_message.h +++ b/src/core/system_parameters/glonass_gnav_navigation_message.h @@ -35,6 +35,12 @@ #include // for pair #include // for vector +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + /*! * \brief This class decodes a GLONASS GNAV Data message as described in GLONASS ICD (Edition 5.1) * \note Code added as part of GSoC 2017 program @@ -213,4 +219,7 @@ private: bool flag_TOW_new{}; // Flag indicating when a new TOW has been computed }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GLONASS_GNAV_NAVIGATION_MESSAGE_H diff --git a/src/core/system_parameters/glonass_gnav_utc_model.h b/src/core/system_parameters/glonass_gnav_utc_model.h index bbc9a11dd..e04fd5b90 100644 --- a/src/core/system_parameters/glonass_gnav_utc_model.h +++ b/src/core/system_parameters/glonass_gnav_utc_model.h @@ -26,6 +26,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + /*! * \brief This class is a storage for the GLONASS GNAV UTC MODEL data as described in GLONASS ICD (Edition 5.1) * \note Code added as part of GSoC 2017 program @@ -74,4 +80,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GLONASS_GNAV_UTC_MODEL_H diff --git a/src/core/system_parameters/gnss_frequencies.h b/src/core/system_parameters/gnss_frequencies.h index 8a7ff2807..15b87cd76 100644 --- a/src/core/system_parameters/gnss_frequencies.h +++ b/src/core/system_parameters/gnss_frequencies.h @@ -22,6 +22,12 @@ #ifndef GNSS_SDR_GNSS_FREQUENCIES_H #define GNSS_SDR_GNSS_FREQUENCIES_H +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + constexpr double FREQ1 = 1.57542e9; //!< L1/E1 frequency (Hz) constexpr double FREQ2 = 1.22760e9; //!< L2 frequency (Hz) constexpr double FREQ5 = 1.17645e9; //!< L5/E5a frequency (Hz) @@ -38,4 +44,7 @@ constexpr double FREQ1_BDS = 1.561098e9; //!< BeiDou B1 frequency (Hz) constexpr double FREQ2_BDS = 1.20714e9; //!< BeiDou B2 frequency (Hz) constexpr double FREQ3_BDS = 1.26852e9; //!< BeiDou B3 frequency (Hz) -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GNSS_FREQUENCIES_H diff --git a/src/core/system_parameters/gnss_obs_codes.h b/src/core/system_parameters/gnss_obs_codes.h index eeb3adf41..3873ce3b4 100644 --- a/src/core/system_parameters/gnss_obs_codes.h +++ b/src/core/system_parameters/gnss_obs_codes.h @@ -24,6 +24,12 @@ #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + constexpr uint32_t CODE_NONE = 0; //!< obs code: none or unknown constexpr uint32_t CODE_L1C = 1; //!< obs code: L1C/A,G1C/A,E1C (GPS,GLO,GAL,QZS,SBS) constexpr uint32_t CODE_L1P = 2; //!< obs code: L1P,G1P (GPS,GLO) @@ -83,4 +89,6 @@ constexpr uint32_t CODE_L9X = 55; //!< obs code: SB+C (IRN) constexpr int32_t MAXCODE = 55; //!< max number of obs code -#endif +/** \} */ +/** \} */ +#endif // GNSS_SDR_GNSS_OBS_CODES_H diff --git a/src/core/system_parameters/gnss_satellite.h b/src/core/system_parameters/gnss_satellite.h index 9389bd27c..c525f87b7 100644 --- a/src/core/system_parameters/gnss_satellite.h +++ b/src/core/system_parameters/gnss_satellite.h @@ -27,6 +27,11 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + /*! * \brief This class represents a GNSS satellite. @@ -70,4 +75,8 @@ private: uint32_t PRN{}; int32_t rf_link{}; }; -#endif + + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GNSS_SATELLITE_H diff --git a/src/core/system_parameters/gnss_signal.h b/src/core/system_parameters/gnss_signal.h index 7bed4ea5e..bcd76a6be 100644 --- a/src/core/system_parameters/gnss_signal.h +++ b/src/core/system_parameters/gnss_signal.h @@ -25,6 +25,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + /*! * \brief This class represents a GNSS signal. * @@ -48,4 +54,7 @@ private: std::string signal{}; }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GNSS_SIGNAL_H diff --git a/src/core/system_parameters/gnss_synchro.h b/src/core/system_parameters/gnss_synchro.h index 8017e9a48..f06afa620 100644 --- a/src/core/system_parameters/gnss_synchro.h +++ b/src/core/system_parameters/gnss_synchro.h @@ -26,6 +26,13 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters core_system_parameters + * GNSS parameters + * \{ */ + + /*! * \brief This is the class that contains the information that is shared * by the processing blocks. @@ -204,4 +211,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GNSS_SYNCHRO_H diff --git a/src/core/system_parameters/gps_acq_assist.h b/src/core/system_parameters/gps_acq_assist.h index 8246a8b27..b7f7a39e9 100644 --- a/src/core/system_parameters/gps_acq_assist.h +++ b/src/core/system_parameters/gps_acq_assist.h @@ -23,6 +23,12 @@ #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + /*! * \brief This class is a storage for the GPS GSM RRLL acquisition assistance data as described in * Digital cellular telecommunications system (Phase 2+); @@ -52,4 +58,7 @@ public: double Elevation{}; //!< Satellite Elevation [deg] }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GPS_ACQ_ASSIST_H diff --git a/src/core/system_parameters/gps_almanac.h b/src/core/system_parameters/gps_almanac.h index d2ae75fd4..0a7469d74 100644 --- a/src/core/system_parameters/gps_almanac.h +++ b/src/core/system_parameters/gps_almanac.h @@ -24,6 +24,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + /*! * \brief This class is a storage for the GPS SV ALMANAC data as described in IS-GPS-200K * @@ -76,4 +82,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GPS_ALMANAC_H diff --git a/src/core/system_parameters/gps_cnav_ephemeris.h b/src/core/system_parameters/gps_cnav_ephemeris.h index 9535383a3..da2950a0e 100644 --- a/src/core/system_parameters/gps_cnav_ephemeris.h +++ b/src/core/system_parameters/gps_cnav_ephemeris.h @@ -24,6 +24,11 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + /*! * \brief This class is a storage and orbital model functions for the GPS SV ephemeris data as described in IS-GPS-200K @@ -183,4 +188,7 @@ private: double check_t(double time); }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GPS_CNAV_EPHEMERIS_H diff --git a/src/core/system_parameters/gps_cnav_iono.h b/src/core/system_parameters/gps_cnav_iono.h index 6d6d0969f..f66cea95a 100644 --- a/src/core/system_parameters/gps_cnav_iono.h +++ b/src/core/system_parameters/gps_cnav_iono.h @@ -24,6 +24,11 @@ #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + /*! * \brief This class is a storage for the GPS IONOSPHERIC data as described in IS-GPS-200K @@ -68,4 +73,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GPS_CNAV_IONO_H diff --git a/src/core/system_parameters/gps_cnav_navigation_message.h b/src/core/system_parameters/gps_cnav_navigation_message.h index cb56a7bd9..87dfdf681 100644 --- a/src/core/system_parameters/gps_cnav_navigation_message.h +++ b/src/core/system_parameters/gps_cnav_navigation_message.h @@ -33,6 +33,11 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + /*! * \brief This class decodes a GPS CNAV Data message as described in IS-GPS-200K @@ -98,4 +103,7 @@ private: bool b_flag_utc_valid{}; //!< If set, it indicates that the utc parameters are filled and are not yet read by the get_utc_model }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GPS_CNAV_NAVIGATION_MESSAGE_H diff --git a/src/core/system_parameters/gps_cnav_utc_model.h b/src/core/system_parameters/gps_cnav_utc_model.h index c82d078dc..ad1e8cc9b 100644 --- a/src/core/system_parameters/gps_cnav_utc_model.h +++ b/src/core/system_parameters/gps_cnav_utc_model.h @@ -24,6 +24,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + /*! * \brief This class is a storage for the GPS UTC MODEL data as described in in IS-GPS-200K * @@ -71,4 +77,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GPS_CNAV_UTC_MODEL_H diff --git a/src/core/system_parameters/gps_ephemeris.h b/src/core/system_parameters/gps_ephemeris.h index 7f17b285a..212f1f567 100644 --- a/src/core/system_parameters/gps_ephemeris.h +++ b/src/core/system_parameters/gps_ephemeris.h @@ -27,6 +27,11 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + /*! * \brief This class is a storage and orbital model functions for the GPS SV ephemeris data as described in IS-GPS-200K @@ -196,4 +201,7 @@ private: double check_t(double time); }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GPS_EPHEMERIS_H diff --git a/src/core/system_parameters/gps_iono.h b/src/core/system_parameters/gps_iono.h index b8a3997f2..5954e542e 100644 --- a/src/core/system_parameters/gps_iono.h +++ b/src/core/system_parameters/gps_iono.h @@ -24,6 +24,11 @@ #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + /*! * \brief This class is a storage for the GPS IONOSPHERIC data as described in IS-GPS-200K @@ -68,4 +73,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GPS_IONO_H diff --git a/src/core/system_parameters/gps_navigation_message.h b/src/core/system_parameters/gps_navigation_message.h index 8f5aca829..d77cc0b07 100644 --- a/src/core/system_parameters/gps_navigation_message.h +++ b/src/core/system_parameters/gps_navigation_message.h @@ -34,6 +34,11 @@ #include // for pair #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + /*! * \brief This class decodes a GPS NAV Data message as described in IS-GPS-200K @@ -254,4 +259,7 @@ private: bool b_antispoofing_flag{}; // If true, the AntiSpoofing mode is ON in that SV }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GPS_NAVIGATION_MESSAGE_H diff --git a/src/core/system_parameters/gps_utc_model.h b/src/core/system_parameters/gps_utc_model.h index 4c811a032..37afa191e 100644 --- a/src/core/system_parameters/gps_utc_model.h +++ b/src/core/system_parameters/gps_utc_model.h @@ -24,6 +24,12 @@ #include #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + /*! * \brief This class is a storage for the GPS UTC MODEL data as described in IS-GPS-200K * @@ -72,4 +78,7 @@ public: } }; -#endif + +/** \} */ +/** \} */ +#endif // GNSS_SDR_GPS_UTC_MODEL_H diff --git a/src/core/system_parameters/sbas_ephemeris.h b/src/core/system_parameters/sbas_ephemeris.h index 21fbfb038..6698fdb60 100644 --- a/src/core/system_parameters/sbas_ephemeris.h +++ b/src/core/system_parameters/sbas_ephemeris.h @@ -23,6 +23,12 @@ #include +/** \addtogroup Core + * \{ */ +/** \addtogroup System_Parameters + * \{ */ + + /*! * \brief This class stores SBAS SV ephemeris data * @@ -47,4 +53,6 @@ public: }; +/** \} */ +/** \} */ #endif // GNSS_SDR_SBAS_EPHEMERIS_H