1
0
mirror of https://github.com/gnss-sdr/gnss-sdr synced 2024-12-14 20:20:35 +00:00

header cleanup, added documentation comments

This commit is contained in:
Lenhart 2021-04-17 22:51:29 +02:00
parent 170e4666d1
commit 2072197f0f
2 changed files with 12 additions and 18 deletions

View File

@ -18,14 +18,12 @@
#include "fifo_signal_source.h" #include "fifo_signal_source.h"
#include "configuration_interface.h" #include "configuration_interface.h"
#include "fifo_reader.h" #include "fifo_reader.h"
#include "gnss_sdr_filesystem.h"
#include "gnss_sdr_flags.h" #include "gnss_sdr_flags.h"
#include "gnss_sdr_string_literals.h" #include "gnss_sdr_string_literals.h"
#include "gnss_sdr_valve.h"
#include <glog/logging.h> #include <glog/logging.h>
#include <gnuradio/blocks/file_sink.h>
#include <gnuradio/blocks/file_source.h>
#include <cmath> // ceil, floor #include <cmath> // ceil, floor
#include <fstream>
#include <utility> // move
using namespace std::string_literals; using namespace std::string_literals;

View File

@ -16,26 +16,21 @@
* ----------------------------------------------------------------------------- * -----------------------------------------------------------------------------
*/ */
#ifndef GNSS_SDR_FIFO_SOURCE_BASE_H #ifndef GNSS_SDR_FIFO_SIGNAL_SOURCE_H
#define GNSS_SDR_FIFO_SOURCE_BASE_H #define GNSS_SDR_FIFO_SIGNAL_SOURCE_H
#include "concurrent_queue.h" #include "concurrent_queue.h"
#include "file_source_base.h" #include "signal_source_base.h"
#include "gnss_block_interface.h"
#include <gnuradio/blocks/file_source.h>
#include <gnuradio/blocks/throttle.h>
#include <pmt/pmt.h> #include <pmt/pmt.h>
#include <tuple>
// for dump
#include <gnuradio/blocks/file_sink.h>
#include <cstddef>
#include <string>
/** \addtogroup Signal_Source
* \{ */
/** \addtogroup Signal_Source_adapters
* \{ */
class ConfigurationInterface; class ConfigurationInterface;
//! \brief Class that reads a sample stream from a Unix fifo //! \brief Class that reads a sample stream from a Unix fifo
//! //!
//! This class supports the following properties: //! This class supports the following properties:
@ -79,5 +74,6 @@ private:
const std::string dump_filename_; const std::string dump_filename_;
}; };
/** \} */
#endif /** \} */
#endif // GNSS_SDR_FIFO_SIGNAL_SOURCE_H