Adding documentation and improving code formatting.

git-svn-id: https://svn.code.sf.net/p/gnss-sdr/code/trunk@103 64b25241-fba3-4117-9849-534c7e92360d

src/algorithms/PVT/adapters/gps_l1_ca_pvt.cc

@@ -1,6 +1,7 @@
 /*!
  * \file gps_l1_ca_pvt.cc
- * \brief Simple Least Squares implementation for GPS L1 C/A Position Velocity and Time
+ * \brief  Implementation of an adapter of a GPS L1 C/A PVT solver block to a
+ * PVTInterface
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
  *

src/algorithms/PVT/adapters/gps_l1_ca_pvt.h

@@ -1,6 +1,8 @@
 /*!
  * \file gps_l1_ca_pvt.h
- * \brief Simple Least Squares implementation for GPS L1 C/A Position Velocity and Time
+ * \brief Interface of an adapter of a GPS L1 C/A PVT solver block to a
+ * PVTInterface
+ * Position Velocity and Time
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
  *

src/algorithms/PVT/gnuradio_blocks/gps_l1_ca_pvt_cc.cc

@@ -1,6 +1,6 @@
 /*!
  * \file gps_l1_ca_pvt_cc.cc
- * \brief Position Velocity and Time computation for GPS L1 C/A
+ * \brief Implementation of a Position Velocity and Time computation block for GPS L1 C/A
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  * -------------------------------------------------------------------------
  *

src/algorithms/PVT/gnuradio_blocks/gps_l1_ca_pvt_cc.h

@@ -1,6 +1,6 @@
 /*!
  * \file gps_l1_ca_pvt_cc.h
- * \brief Position Velocity and Time computation for GPS L1 C/A
+ * \brief Interface of a Position Velocity and Time computation block for GPS L1 C/A
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  * -------------------------------------------------------------------------
  *

src/algorithms/PVT/libs/gps_l1_ca_ls_pvt.cc

@@ -1,7 +1,7 @@
 /*!
  * \file gps_l1_ca_ls_pvt.cc
- * \brief Least Squares Position, Velocity, and Time (PVT) solver, based on
+ * \brief Implementation of a Least Squares Position, Velocity, and Time
- * K.Borre Matlab receiver.
+ * (PVT) solver, based on K.Borre's Matlab receiver.
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  * -------------------------------------------------------------------------
  *
@@ -139,7 +139,6 @@ arma::vec gps_l1_ca_ls_pvt::leastSquarePos(arma::mat satpos, arma::vec obs, arma
     el=arma::zeros(1,nmbOfSatellites);
     for (int i = 0; i < nmbOfSatellites; i++) {
             for (int j = 0; j < 4; j++) {
-            //A.set(i, j, 0.0); //ITPP
                     A(i,j)=0.0; //Armadillo
             }
             omc(i, 0)=0.0;

src/algorithms/PVT/libs/gps_l1_ca_ls_pvt.h

@@ -1,7 +1,7 @@
 /*!
  * \file gps_l1_ca_ls_pvt.h
- * \brief Least Squares Position, Velocity, and Time (PVT) solver, based on
+ * \brief Interface of a Least Squares Position, Velocity, and Time (PVT)
- * K.Borre Matlab receiver.
+ * solver, based on K.Borre's Matlab receiver.
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  * -------------------------------------------------------------------------
  *

src/algorithms/PVT/libs/kml_printer.cc

@@ -1,6 +1,6 @@
 /*!
  * \file kml_printer.cc
- * \brief Prints PVT information to a GoogleEarth kml file
+ * \brief Implementation of a class that prints PVT information to a kml file
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
  *
@@ -32,7 +32,6 @@
 #include "kml_printer.h"
 #include <glog/log_severity.h>
 #include <glog/logging.h>
-
 #include <time.h>
 
 bool kml_printer::set_headers(std::string filename)
@@ -102,6 +101,7 @@ bool kml_printer::print_position(gps_l1_ca_ls_pvt* position,bool print_average_v
                 return false;
             }
 }
+
 bool kml_printer::close_file()
 {
     if (kml_file.is_open())
@@ -117,10 +117,7 @@ bool kml_printer::close_file()
                 return false;
         }
 }
-kml_printer::kml_printer ()
-{
-}
 
-kml_printer::~kml_printer ()
+kml_printer::kml_printer () {}
-{
+
-}
+kml_printer::~kml_printer () {}

src/algorithms/PVT/libs/kml_printer.h

@@ -1,6 +1,6 @@
 /*!
  * \file kml_printer.h
- * \brief Prints PVT information to a GoogleEarth kml file
+ * \brief Interface of a class that prints PVT information to a kml file
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
  *

src/algorithms/acquisition/adapters/gps_l1_ca_gps_sdr_acquisition.cc

@@ -1,6 +1,8 @@
 /*!
  * \file gps_l1_ca_gps_sdr_acquisition.cc
- * \brief Brief description of the file here
+ * \brief Implementation of an adapter of an acquisition module based
+ * on the method in Gregory Heckler's GPS-SDR (see http://github.com/gps-sdr/gps-sdr)
+ * to an AcquisitionInterface
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *         Luis Esteve, 2011. luis(at)epsilon-formacion.com
  *
@@ -32,19 +34,17 @@
 #include "gps_l1_ca_gps_sdr_acquisition.h"
 #include "GPS_L1_CA.h"
 #include "configuration_interface.h"
-
 #include <gnuradio/gr_io_signature.h>
 #include <gnuradio/gr_stream_to_vector.h>
 #include <gnuradio/gr_vector_to_stream.h>
 #include <gnuradio/gr_complex_to_interleaved_short.h>
 #include <gnuradio/gr_interleaved_short_to_complex.h>
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
 
 using google::LogMessage;
 
-//! Constructor
+// Constructor
 GpsL1CaGpsSdrAcquisition::GpsL1CaGpsSdrAcquisition(
         ConfigurationInterface* configuration, std::string role,
         unsigned int in_streams, unsigned int out_streams,
@@ -108,11 +108,11 @@ GpsL1CaGpsSdrAcquisition::GpsL1CaGpsSdrAcquisition(
 
 }
 
-//! Destructor
+// Destructor
 GpsL1CaGpsSdrAcquisition::~GpsL1CaGpsSdrAcquisition()
 {}
 
-//! Set satellite
+// Set satellite
 void GpsL1CaGpsSdrAcquisition::set_satellite(unsigned int satellite)
 {
     satellite_ = satellite;
@@ -128,7 +128,7 @@ void GpsL1CaGpsSdrAcquisition::set_satellite(unsigned int satellite)
 }
 
 
-//! Set channel
+// Set channel
 void GpsL1CaGpsSdrAcquisition::set_channel(unsigned int channel)
 {
     channel_ = channel;
@@ -143,7 +143,7 @@ void GpsL1CaGpsSdrAcquisition::set_channel(unsigned int channel)
     }
 }
 
-//! Set acquisition threshold
+// Set acquisition threshold
 void GpsL1CaGpsSdrAcquisition::set_threshold(float threshold)
 {
     threshold_ = threshold;
@@ -158,7 +158,7 @@ void GpsL1CaGpsSdrAcquisition::set_threshold(float threshold)
     }
 }
 
-//! Set maximum Doppler shift
+// Set maximum Doppler shift
 void GpsL1CaGpsSdrAcquisition::set_doppler_max(unsigned int doppler_max)
 {
     doppler_max_ = doppler_max;
@@ -173,7 +173,7 @@ void GpsL1CaGpsSdrAcquisition::set_doppler_max(unsigned int doppler_max)
     }
 }
 
-//! Set Channel Queue
+// Set Channel Queue
 void GpsL1CaGpsSdrAcquisition::set_channel_queue(
         concurrent_queue<int> *channel_internal_queue)
 {

src/algorithms/acquisition/adapters/gps_l1_ca_gps_sdr_acquisition.h

@@ -1,6 +1,8 @@
 /*!
  * \file gps_l1_ca_gps_sdr_acquisition.h
- * \brief Brief description of the file here
+ * \brief Interface of an adapter of an acquisition module based
+ * on the method in Gregory Heckler's GPS-SDR (see http://github.com/gps-sdr/gps-sdr)
+ * to an AcquisitionInterface
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *         Luis Esteve, 2011. luis(at)epsilon-formacion.com
  *

src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition.cc

@@ -1,11 +1,9 @@
 /*!
  * \file gps_l1_ca_pcps_acquisition.cc
- * \brief Brief description of the file here
+ * \brief Adapts a PCPS acquisition block for GPS L1 C/A to an AcquisitionInterface
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *         Luis Esteve, 2011. luis(at)epsilon-formacion.com
  *
- * Detailed description of the file here if needed.
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)
@@ -40,7 +38,6 @@
 #include <gnuradio/gr_vector_to_stream.h>
 #include <gnuradio/gr_complex_to_interleaved_short.h>
 #include <gnuradio/gr_interleaved_short_to_complex.h>
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
 

src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition.h

@@ -1,6 +1,6 @@
 /*!
  * \file gps_l1_ca_pcps_acquisition.h
- * \brief Brief description of the file here
+ * \brief Adapts a PCPS acquisition block to an AcquisitionInterface for GPS L1 C/A
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *         Luis Esteve, 2011. luis(at)epsilon-formacion.com
  *

src/algorithms/acquisition/gnuradio_blocks/gps_l1_ca_pcps_acquisition_cc.h

@@ -53,7 +53,7 @@ gps_l1_ca_pcps_make_acquisition_cc(unsigned int sampled_ms,
         gr_msg_queue_sptr queue, bool dump, std::string dump_filename);
 
 /*!
- * \brief This class implements a PCPS acquisition block
+ * \brief This class implements a PCPS acquisition block for GPS L1 C/A
  */
 class gps_l1_ca_pcps_acquisition_cc: public gr_block
 {
@@ -130,22 +130,27 @@ public:
     }
 
     void set_satellite(unsigned int satellite);
+
     void set_active(bool active)
     {
         d_active = active;
     }
+
     void set_channel(unsigned int channel)
     {
         d_channel = channel;
     }
+
     void set_threshold(float threshold)
     {
         d_threshold = threshold;
     }
+
     void set_doppler_max(unsigned int doppler_max)
     {
         d_doppler_max = doppler_max;
     }
+
     void set_doppler_step(unsigned int doppler_step)
     {
         d_doppler_step = doppler_step;

src/algorithms/acquisition/gnuradio_blocks/gps_l1_ca_tong_pcps_acquisition_cc.h

@@ -44,8 +44,10 @@
 #include "concurrent_queue.h"
 
 class gps_l1_ca_tong_pcps_acquisition_cc;
+
 typedef boost::shared_ptr<gps_l1_ca_tong_pcps_acquisition_cc>
  gps_l1_ca_tong_pcps_acquisition_cc_sptr;
+
 gps_l1_ca_tong_pcps_acquisition_cc_sptr
  gps_l1_ca_tong_pcps_make_acquisition_cc(unsigned int sampled_ms,
         unsigned int doppler_max, long freq, long fs_in, int samples_per_ms,

src/algorithms/channel/adapters/channel.cc

@@ -4,8 +4,6 @@
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *         Luis Esteve, 2011. luis(at)epsilon-formacion.com
  *
- * Detailed description of the file here if needed.
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)
@@ -32,27 +30,23 @@
  */
 
 #include "channel.h"
-
 #include "acquisition_interface.h"
 #include "tracking_interface.h"
 #include "telemetry_decoder_interface.h"
 #include "configuration_interface.h"
 #include "gnss_flowgraph.h"
-
 #include <iostream>
 #include <sstream>
 #include <boost/lexical_cast.hpp>
 #include <boost/thread/thread.hpp>
-
 #include <gnuradio/gr_io_signature.h>
 #include <gnuradio/gr_message.h>
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
 
 using google::LogMessage;
 
-//! Constructor
+// Constructor
 Channel::Channel(ConfigurationInterface *configuration, unsigned int channel,
         GNSSBlockInterface *pass_through, AcquisitionInterface *acq,
         TrackingInterface *trk, TelemetryDecoderInterface *nav,
@@ -95,7 +89,7 @@ Channel::Channel(ConfigurationInterface *configuration, unsigned int channel,
 }
 
 
-//! Destructor
+// Destructor
 Channel::~Channel()
 {
 
@@ -198,7 +192,7 @@ void Channel::run()
 }
 
 /*
- * \brief Set stop_ to true and blocks the calling thread until
+ * Set stop_ to true and blocks the calling thread until
  * the thread of the constructor has completed
  */
 void Channel::stop()

src/algorithms/channel/adapters/channel.h

@@ -1,6 +1,6 @@
 /*!
  * \file channel.h
- * \brief This class represents a GNSS channel.
+ * \brief Interface of a GNSS channel.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *         Luis Esteve, 2011. luis(at)epsilon-formacion.com
  *
@@ -88,6 +88,11 @@ public:
     void start_acquisition();
     void set_satellite(unsigned int satellite);
     void start();
+
+    /*!
+     * \brief Set stop_ to true and blocks the calling thread until
+     * the thread of the constructor has completed
+     */
     void stop();
 
 private:

src/algorithms/channel/libs/gps_l1_ca_channel_fsm.cc

@@ -1,10 +1,8 @@
 /*!
  * \file gps_l1_ca_channel_fsm.cc
- * \briefState Machine for channel using boost::statechart
+ * \brief Implementation of a State Machine for channel using boost::statechart
  * \author Luis Esteve, 2011. luis(at)epsilon-formacion.com
  *
- * Detailed description of the file here if needed.
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)
@@ -33,7 +31,6 @@
 #include "gps_l1_ca_channel_fsm.h"
 #include "control_message_factory.h"
 #include "channel.h"
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
 

src/algorithms/channel/libs/gps_l1_ca_channel_fsm.h

@@ -59,8 +59,7 @@ struct gps_channel_waiting_fsm_S3;
 /*!
  * \brief This class implements a State Machine for channel using boost::statechart
  */
-class GpsL1CaChannelFsm: public sc::state_machine<GpsL1CaChannelFsm,
+class GpsL1CaChannelFsm: public sc::state_machine<GpsL1CaChannelFsm,gps_channel_idle_fsm_S0>
-        gps_channel_idle_fsm_S0>
 {
 
 public:

src/algorithms/conditioner/adapters/direct_resampler_conditioner.cc

@@ -1,10 +1,9 @@
 /*!
  * \file direct_resampler_conditioner.cc
- * \brief Brief description of the file here
+ * \brief Implementation of an adapter of a direct resampler conditioner block
+ * to a SignalConditionerInterface
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
- * Detailed description of the file here if needed.
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)
@@ -31,15 +30,11 @@
  */
 
 #include "direct_resampler_conditioner.h"
-
 // #include <gnuradio/usrp_source_c.h>
 #include <gnuradio/gr_file_sink.h>
-
 #include "direct_resampler_conditioner_cc.h"
 #include "direct_resampler_conditioner_ss.h"
-
 #include "configuration_interface.h"
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
 
@@ -98,9 +93,7 @@ DirectResamplerConditioner::DirectResamplerConditioner(
             DLOG(INFO) << "file_sink(" << file_sink_->unique_id() << ")";
         }
 }
-DirectResamplerConditioner::~DirectResamplerConditioner()
+DirectResamplerConditioner::~DirectResamplerConditioner() {}
-{
-}
 
 void DirectResamplerConditioner::connect(gr_top_block_sptr top_block)
 {

src/algorithms/conditioner/adapters/direct_resampler_conditioner.h

@@ -1,10 +1,9 @@
 /*!
  * \file direct_resampler_conditioner.h
- * \brief This class represents a direct resampler.
+ * \brief Interface of an adapter of a direct resampler conditioner block
+ * to a SignalConditionerInterface
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
- * Detailed description of the file here if needed.
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)
@@ -45,6 +44,7 @@ public:
     DirectResamplerConditioner(ConfigurationInterface* configuration,
             std::string role, unsigned int in_stream,
             unsigned int out_stream);
+
     virtual ~DirectResamplerConditioner();
 
     std::string role()
@@ -70,7 +70,6 @@ private:
     std::string role_;
     unsigned int in_stream_;
     unsigned int out_stream_;
-
     std::string item_type_;
     size_t item_size_;
     long samples_;
@@ -78,7 +77,6 @@ private:
     std::string dump_filename_;
     double sample_freq_in_;
     double sample_freq_out_;
-
     gr_block_sptr resampler_;
     gr_block_sptr file_sink_;
 };

src/algorithms/libs/gnss_sdr_valve.h

@@ -1,11 +1,9 @@
 /*!
  * \file gnss_sdr_valve.h
- * \brief  This class implements a GNU Radio block that sends a STOP message to the
+ * \brief  Interface of a GNU Radio block that sends a STOP message to the
  * control queue right after a specific number of samples have passed through it.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
- * Detailed description of the file here if needed.
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)
@@ -34,8 +32,8 @@
 
 
 
-#ifndef GNSS_SDR_VALVE_H_
+#ifndef GNSS_SDR_GNSS_SDR_VALVE_H_
-#define GNSS_SDR_VALVE_H_
+#define GNSS_SDR_GNSS_SDR_VALVE_H_
 
 #include <cstring>
 #include <gr_sync_block.h>
@@ -66,4 +64,4 @@ public:
               gr_vector_void_star &output_items);
 };
 
-#endif /*GNSS_SDR_VALVE_H_*/
+#endif /*GNSS_SDR_GNSS_SDR_VALVE_H_*/

src/algorithms/libs/pass_through.cc

@@ -1,6 +1,7 @@
 /*!
  * \file pass_through.cc
- * \brief Brief description of the file here
+ * \brief Implementation of a block that just puts its input in its
+ *        output.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
  * Detailed description of the file here if needed.
@@ -33,14 +34,10 @@
 
 
 #include "pass_through.h"
-
 #include <iostream>
-
 #include <gnuradio/gr_io_signature.h>
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
-
 #include "configuration_interface.h"
 
 using google::LogMessage;

src/algorithms/libs/pass_through.h

@@ -1,6 +1,6 @@
 /*!
  * \file pass_through.h
- * \brief This class represent a block that just puts its input in its
+ * \brief Interface of a block that just puts its input in its
  *        output.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
@@ -33,13 +33,12 @@
 
 
 
-#ifndef PASS_THROUGH_H_
+#ifndef GNSS_SDR_PASS_THROUGH_H_
-#define PASS_THROUGH_H_
+#define GNSS_SDR_PASS_THROUGH_H_
 
 #include <gr_hier_block2.h>
 #include <gr_kludge_copy.h>
 #include <gr_file_sink.h>
-
 #include "gnss_block_interface.h"
 
 class ConfigurationInterface;
@@ -94,4 +93,4 @@ private:
     size_t item_size_;
 };
 
-#endif /*PASS_THROUGH_H_*/
+#endif /*GNSS_SDR_PASS_THROUGH_H_*/

src/algorithms/observables/adapters/gps_l1_ca_observables.cc

@@ -1,10 +1,9 @@
 /*!
  * \file gps_l1_ca_observables.cc
- * \brief Brief description of the file here
+ * \brief Implementation of an adapter of a GPS L1 C/A observables block
+ * to a SignalConditionerInterface
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Detailed description of the file here if needed.
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)
@@ -31,17 +30,12 @@
  */
 
 
-
 #include "gps_l1_ca_observables.h"
-
 #include "configuration_interface.h"
-
 #include "gps_l1_ca_observables_cc.h"
-
 #include <gnuradio/gr_io_signature.h>
 #include <gnuradio/gr_stream_to_vector.h>
 #include <gnuradio/gr_vector_to_stream.h>
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
 

src/algorithms/observables/adapters/gps_l1_ca_observables.h

@@ -1,10 +1,9 @@
 /*!
  * \file gps_l1_ca_observables.h
- * \brief Brief description of the file here
+ * \brief Interface of an adapter of a GPS L1 C/A observables block
+ * to a SignalConditionerInterface
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Detailed description of the file here if needed.
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)

src/algorithms/observables/gnuradio_blocks/gps_l1_ca_observables_cc.cc

@@ -1,6 +1,6 @@
 /*!
  * \file gps_l1_ca_observables_cc.cc
- * \brief Pseudorange computation module for GPS L1 C/A
+ * \brief Implementation of the pseudorange computation block for GPS L1 C/A
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  * -------------------------------------------------------------------------
  *
@@ -33,16 +33,11 @@
 #include <map>
 #include <algorithm>
 #include <bitset>
-
 #include <cmath>
 #include "math.h"
-
 #include "gps_l1_ca_observables_cc.h"
-
 #include "control_message_factory.h"
-
 #include <gnuradio/gr_io_signature.h>
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
 

src/algorithms/observables/gnuradio_blocks/gps_l1_ca_observables_cc.h

@@ -1,6 +1,6 @@
 /*!
  * \file gps_l1_ca_observables_cc.h
- * \brief Interface of the pseudorange computation module for GPS L1 C/A
+ * \brief Interface of the pseudorange computation block for GPS L1 C/A
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  * -------------------------------------------------------------------------
  *

src/algorithms/output_filter/adapters/file_output_filter.cc

@@ -1,10 +1,9 @@
 /*!
  * \file file_output_filter.cc
- * \brief Brief description of the file here
+ * \brief Implementation of an adapter of a file output filter block
+ * to an OutputFilterInterface
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
- * Detailed description of the file here if needed.
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)
@@ -30,15 +29,10 @@
  * -------------------------------------------------------------------------
  */
 
-
-
 #include "file_output_filter.h"
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
-
 #include <gr_io_signature.h>
-
 #include "configuration_interface.h"
 
 using google::LogMessage;

src/algorithms/output_filter/adapters/file_output_filter.h

@@ -1,11 +1,10 @@
 /*!
  * \file file_output_filter.h
- * \brief This class represents an output filter that sends its output
+ * \brief Interface of an adapter of a file output filter block to an
- *        to a file without any change in the data format.
+ * OutputFilterInterface
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
  *
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)
@@ -41,6 +40,10 @@
 
 class ConfigurationInterface;
 
+/*!
+ * \brief An output filter that sends its output
+ *  to a file without any change in the data format.
+ */
 class FileOutputFilter : public GNSSBlockInterface
 {
 
@@ -74,7 +77,6 @@ private:
 
     gr_file_sink_sptr file_sink_;
     size_t item_size_;
-
     std::string filename_;
     std::string item_type_;
     std::string role_;

src/algorithms/output_filter/adapters/null_sink_output_filter.cc

@@ -1,10 +1,9 @@
 /*!
  * \file null_sink_output_filter.cc
- * \brief Brief description of the file here
+ * \brief  Implementation of an adapter of a null sink output filter block to an
+ * OutputFilterInterface
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
- * Detailed description of the file here if needed.
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)
@@ -33,12 +32,9 @@
 
 
 #include "null_sink_output_filter.h"
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
-
 #include <gr_io_signature.h>
-
 #include "configuration_interface.h"
 
 using google::LogMessage;

src/algorithms/output_filter/adapters/null_sink_output_filter.h

@@ -1,6 +1,7 @@
 /*!
  * \file null_sink_output_filter.h
- * \brief Interface of a null sink output filter
+ * \brief Interface of an adapter of a null sink output filter block to an
+ * OutputFilterInterface
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
  * This class represents an implementation of an output filter that

src/algorithms/signal_source/adapters/file_signal_source.cc

@@ -1,11 +1,10 @@
 /*!
  * \file file_signal_source.cc
- * \brief Brief description of the file here
+ * \brief Implementation of a class that reads signals samples from a file
+ * and adapts it to a SignalSourceInterface
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *         Javier Arribas, 2011 jarribas(at)cttc.es
  *
- * Detailed description of the file here if needed.
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)
@@ -32,10 +31,8 @@
  */
 
 #include "file_signal_source.h"
-
 #include "gnss_sdr_valve.h"
 #include "configuration_interface.h"
-
 #include <string>
 #include <iostream>
 #include <fstream>
@@ -43,7 +40,6 @@
 #include <gflags/gflags.h>
 #include <glog/log_severity.h>
 #include <glog/logging.h>
-
 #include <gnuradio/gr_io_signature.h>
 
 using google::LogMessage;
@@ -106,7 +102,7 @@ FileSignalSource::FileSignalSource(ConfigurationInterface* configuration,
     {
 		/*!
 		 * BUG workaround: The GNURadio file source does not stop the receiver after reaching the End of File.
-		 * A possible solution is to compute the file lenght in samples using file size, excluding the last 100 milliseconds, and enable always the
+		 * A possible solution is to compute the file length in samples using file size, excluding the last 100 milliseconds, and enable always the
 		 * valve block
 		 */
 		std::ifstream file (filename_.c_str(), std::ios::in|std::ios::binary|std::ios::ate);

src/algorithms/signal_source/adapters/file_signal_source.h

@@ -1,10 +1,11 @@
 /*!
  * \file file_signal_source.h
- * \brief This class reads signals samples from a file
+ * \brief Interface of a class that reads signals samples from a file
+ * and adapts it to a SignalSourceInterface
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
- * This class represents a file signal source. Internally it uses a GNU Radio's gr_file_source
+ * This class represents a file signal source. Internally it uses a GNU Radio's
- * a a connector to the data.
+ * gr_file_source as a connector to the data.
  *
  * -------------------------------------------------------------------------
  *

src/algorithms/telemetry_decoder/adapters/gps_l1_ca_telemetry_decoder.cc

@@ -1,10 +1,9 @@
 /*!
  * \file gps_l1_ca_telemetry_decoder.cc
- * \brief This class implements a NAV data decoder for GPS L1 C/A
+ * \brief Implementation of an adapter of a GPS L1 C/A NAV data decoder block
+ * to a TelemetryDecoderInterface
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Detailed description of the file here if needed.
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)
@@ -31,7 +30,6 @@
  */
 
 
-
 #include "gps_l1_ca_telemetry_decoder.h"
 #include "configuration_interface.h"
 #include "gps_l1_ca_telemetry_decoder_cc.h"

src/algorithms/telemetry_decoder/adapters/gps_l1_ca_telemetry_decoder.h

@@ -1,6 +1,7 @@
 /*!
  * \file gps_l1_ca_telemetry_decoder.h
- * \brief This class implements a NAV data decoder for GPS L1 C/A
+ * \brief Interface of an adapter of a GPS L1 C/A NAV data decoder block
+ * to a TelemetryDecoderInterface
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
  * -------------------------------------------------------------------------

src/algorithms/telemetry_decoder/gnuradio_blocks/gps_l1_ca_telemetry_decoder_cc.cc

@@ -1,6 +1,7 @@
 /*!
  * \file gps_l1_ca_telemetry_decoder_cc.cc
- * \brief Navigation message demodulator based on the Kay Borre book MATLAB-based GPS receiver
+ * \brief Implementation of a NAV message demodulator block based on
+ * Kay Borre book MATLAB-based GPS receiver
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
  * -------------------------------------------------------------------------

src/algorithms/telemetry_decoder/gnuradio_blocks/gps_l1_ca_telemetry_decoder_cc.h

@@ -1,6 +1,7 @@
 /*!
  * \file gps_l1_ca_telemetry_decoder_cc.h
- * \brief Navigation message demodulator based on the Kay Borre book MATLAB-based GPS receiver
+ * \brief Interface of a NAV message demodulator block based on
+ * Kay Borre book MATLAB-based GPS receiver
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  * -------------------------------------------------------------------------
  *

src/algorithms/tracking/adapters/gps_l1_ca_dll_fll_pll_tracking.cc

@@ -1,11 +1,13 @@
 /*!
  * \file gps_l1_ca_dll_fll_pll_tracking.cc
- * \brief code DLL + carrier FLL/PLL tracking
+ * \brief Implementation of an adapter of a code DLL + carrier FLL/PLL tracking
+ * loop for GPS L1 C/A to a TrackingInterface
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * This file implements the code Delay Locked Loop (DLL) + carrier Phase Locked Loop (PLL) helped with a carrier Frequency Locked Loop (FLL) stage
+ * This file implements the code Delay Locked Loop (DLL) + carrier Phase
- * according to the algorithms described in [1]
+ * Locked Loop (PLL) helped with a carrier Frequency Locked Loop (FLL)
- * [1] E.D. Kaplan and C. Hegarty, Understanding GPS. Principles and
+ * according to the algorithms described in:
+ * E.D. Kaplan and C. Hegarty, Understanding GPS. Principles and
  * Applications, Second Edition, Artech House Publishers, 2005.
  *
  * -------------------------------------------------------------------------
@@ -40,18 +42,21 @@
   #include <boost/math/special_functions/round.hpp>
 #endif
 #include <gnuradio/gr_io_signature.h>
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
 
 using google::LogMessage;
 
 GpsL1CaDllFllPllTracking::GpsL1CaDllFllPllTracking(
-        ConfigurationInterface* configuration, std::string role,
+        ConfigurationInterface* configuration,
-        unsigned int in_streams, unsigned int out_streams,
+        std::string role,
+        unsigned int in_streams, unsigned int
+        out_streams,
         gr_msg_queue_sptr queue) :
-    role_(role), in_streams_(in_streams), out_streams_(out_streams), queue_(
+        role_(role),
-            queue)
+        in_streams_(in_streams),
+        out_streams_(out_streams),
+        queue_(queue)
 {
 
     DLOG(INFO) << "role " << role;

src/algorithms/tracking/adapters/gps_l1_ca_dll_fll_pll_tracking.h

@@ -1,11 +1,13 @@
 /*!
  * \file gps_l1_ca_dll_fll_pll_tracking.h
- * \brief code DLL + carrier FLL/PLL tracking
+ * \brief Interface of an adapter of a code DLL + carrier FLL/PLL tracking
+ * loop for GPS L1 C/A to a TrackingInterface
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * This file implements the code Delay Locked Loop (DLL) + carrier Phase Locked Loop (PLL) helped with a carrier Frequency Locked Loop (FLL) stage
+ * This is the interface of a code Delay Locked Loop (DLL) + carrier
- * according to the algorithms described in [1]
+ * Phase Locked Loop (PLL) helped with a carrier Frequency Locked Loop (FLL)
- * [1] E.D. Kaplan and C. Hegarty, Understanding GPS. Principles and
+ * according to the algorithms described in:
+ * E.D. Kaplan and C. Hegarty, Understanding GPS. Principles and
  * Applications, Second Edition, Artech House Publishers, 2005.
  *
  * -------------------------------------------------------------------------

src/algorithms/tracking/adapters/gps_l1_ca_dll_pll_tracking.cc

@@ -1,12 +1,14 @@
 /*!
  * \file gps_l1_ca_dll_pll_tracking.cc
- * \brief code DLL + carrier PLL
+ * \brief Implementation of an adapter of a DLL+PLL tracking loop block
+ * for GPS L1 C/A to a TrackingInterface
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *         Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Code DLL + carrier PLL according to the algorithms described in [1]
+ * Code DLL + carrier PLL according to the algorithms described in:
- * [1] K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.H.Jensen,
+ * K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.H.Jensen,
- * A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach, Birkha user, 2007
+ * A Software-Defined GPS and Galileo Receiver. A Single-Frequency
+ * Approach, Birkhauser, 2007
  *
  * -------------------------------------------------------------------------
  *
@@ -40,7 +42,6 @@
   #include <boost/math/special_functions/round.hpp>
 #endif
 #include <gnuradio/gr_io_signature.h>
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
 
@@ -50,8 +51,8 @@ GpsL1CaDllPllTracking::GpsL1CaDllPllTracking(
         ConfigurationInterface* configuration, std::string role,
         unsigned int in_streams, unsigned int out_streams,
         gr_msg_queue_sptr queue) :
-    role_(role), in_streams_(in_streams), out_streams_(out_streams), queue_(
+        role_(role), in_streams_(in_streams), out_streams_(out_streams),
-            queue)
+        queue_(queue)
 {
 
     DLOG(INFO) << "role " << role;
@@ -111,7 +112,7 @@ void GpsL1CaDllPllTracking::start_tracking()
     tracking_->start_tracking();
 }
 
-/*!
+/*
  * Set satellite ID
  */
 void GpsL1CaDllPllTracking::set_satellite(unsigned int satellite)
@@ -121,7 +122,7 @@ void GpsL1CaDllPllTracking::set_satellite(unsigned int satellite)
     DLOG(INFO) << "satellite set to " << satellite_;
 }
 
-/*!
+/*
  * Set tracking channel unique ID
  */
 void GpsL1CaDllPllTracking::set_channel(unsigned int channel)
@@ -130,7 +131,7 @@ void GpsL1CaDllPllTracking::set_channel(unsigned int channel)
     tracking_->set_channel(channel);
 }
 
-/*!
+/*
  * Set tracking channel internal queue
  */
 void GpsL1CaDllPllTracking::set_channel_queue(
@@ -141,21 +142,24 @@ void GpsL1CaDllPllTracking::set_channel_queue(
     tracking_->set_channel_queue(channel_internal_queue_);
 
 }
-/*!
+
+/*
  * Set acquisition code phase in samples
  */
 void GpsL1CaDllPllTracking::set_prn_code_phase(signed int phase_samples)
 {
     return tracking_->set_acq_code_phase((float)phase_samples);
 }
-/*!
+
+/*
  * Set acquisition Doppler frequency in Hz.
  */
 void GpsL1CaDllPllTracking::set_doppler_freq_shift(float doppler_freq_hz)
 {
     return tracking_->set_acq_doppler(doppler_freq_hz);
 }
-/*!
+
+/*
  * Set acquisition sample stamp in samples, in order to detect the delay between acquisition and tracking
  */
 void GpsL1CaDllPllTracking::set_acq_sample_stamp(
@@ -163,6 +167,7 @@ void GpsL1CaDllPllTracking::set_acq_sample_stamp(
 {
     return tracking_->set_acq_sample_stamp(sample_stamp);
 }
+
 void GpsL1CaDllPllTracking::connect(gr_top_block_sptr top_block)
 {
     //nothing to connect, now the tracking uses gr_sync_decimator

src/algorithms/tracking/adapters/gps_l1_ca_dll_pll_tracking.h

@@ -1,12 +1,14 @@
 /*!
  * \file gps_l1_ca_dll_pll_tracking.h
- * \brief code DLL + carrier PLL
+ * \brief  Interface of an adapter of a DLL+PLL tracking loop block
+ * for GPS L1 C/A to a TrackingInterface
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *         Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Code DLL + carrier PLL according to the algorithms described in [1]
+ * Code DLL + carrier PLL according to the algorithms described in:
- * [1] K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.H.Jensen,
+ * K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.H.Jensen,
- * A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach, Birkha user, 2007
+ * A Software-Defined GPS and Galileo Receiver. A Single-Frequency
+ * Approach, Birkha user, 2007
  *
  * -------------------------------------------------------------------------
  *
@@ -76,14 +78,37 @@ public:
     gr_basic_block_sptr get_left_block();
     gr_basic_block_sptr get_right_block();
 
+    /*!
+     * \brief Set satellite ID
+     */
     void set_satellite(unsigned int satellite);
+
+    /*!
+     * \brief Set tracking channel unique ID
+     */
     void set_channel(unsigned int channel);
+
+    /*!
+     * \brief Set acquisition code phase in samples
+     */
     void set_prn_code_phase(signed int phase_samples);
+
+    /*!
+     * \brief Set acquisition Doppler frequency in Hz.
+     */
     void set_doppler_freq_shift(float doppler_freq_hz);
+
+    /*!
+     * \brief Set tracking channel internal queue
+     */
     void set_channel_queue(concurrent_queue<int> *channel_internal_queue);
 
     void start_tracking();
 
+    /*!
+     * \brief Set acquisition sample stamp in samples, in order to detect
+     * the delay between acquisition and tracking
+     */
     void set_acq_sample_stamp(unsigned long int sample_stamp);
 
 private:

src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_dll_fll_pll_tracking_cc.cc

@@ -1,11 +1,12 @@
 /*!
  * \file gps_l1_ca_dll_fll_pll_tracking_cc.cc
- * \brief code DLL + carrier FLL/PLL tracking
+ * \brief Implementation of a code DLL + carrier FLL/PLL tracking block
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * This file implements the code Delay Locked Loop (DLL) + carrier Phase Locked Loop (PLL) helped with a carrier Frequency Locked Loop (FLL) stage
+ * This file implements the code Delay Locked Loop (DLL) + carrier
- * according to the algorithms described in [1]
+ * Phase Locked Loop (PLL) helped with a carrier Frequency Locked Loop (FLL)
- * [1] E.D. Kaplan and C. Hegarty, Understanding GPS. Principles and
+ * according to the algorithms described in:
+ * E.D. Kaplan and C. Hegarty, Understanding GPS. Principles and
  * Applications, Second Edition, Artech House Publishers, 2005.
  *
  * -------------------------------------------------------------------------
@@ -39,16 +40,13 @@
 #include "tracking_discriminators.h"
 #include "CN_estimators.h"
 #include "tracking_FLL_PLL_filter.h"
-
 #include "control_message_factory.h"
 #include <boost/lexical_cast.hpp>
 #include <iostream>
 #include <sstream>
 #include <cmath>
 #include "math.h"
-
 #include <gnuradio/gr_io_signature.h>
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
 
@@ -124,7 +122,7 @@ gps_l1_ca_dll_fll_pll_tracking_cc::gps_l1_ca_dll_fll_pll_tracking_cc(unsigned in
 
 void gps_l1_ca_dll_fll_pll_tracking_cc::start_tracking(){
 
-	/*!
+	/*
 	 *  correct the code phase according to the delay between acq and trk
 	 */
 	unsigned long int acq_trk_diff_samples;
@@ -242,7 +240,7 @@ gps_l1_ca_dll_fll_pll_tracking_cc::~gps_l1_ca_dll_fll_pll_tracking_cc() {
     delete[] d_Prompt_buffer;
 }
 
-/*! Tracking signal processing
+/* Tracking signal processing
  * Notice that this is a class derived from gr_sync_decimator, so each of the ninput_items has vector_length samples
  */
 
@@ -268,7 +266,7 @@ int gps_l1_ca_dll_fll_pll_tracking_cc::general_work (int noutput_items, gr_vecto
 	d_Late=gr_complex(0,0);
 
 	if (d_enable_tracking==true){
-		/*!
+		/*
 		 * Receiver signal alignment
 		 */
 	    if (d_pull_in==true)
@@ -329,7 +327,7 @@ int gps_l1_ca_dll_fll_pll_tracking_cc::general_work (int noutput_items, gr_vecto
 			d_Late += bb_signal_sample*d_late_code[i];
 		}
 
-		/*!
+		/*
 		 * DLL, FLL, and PLL discriminators
 		 */
 		// Compute DLL error

src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_dll_fll_pll_tracking_cc.h

@@ -1,12 +1,12 @@
 /*!
  * \file gps_l1_ca_dll_fll_pll_tracking_cc.h
- * \brief code DLL + carrier FLL/PLL tracking
+ * \brief Interface of a code DLL + carrier FLL/PLL tracking block
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * This file implements the code Delay Locked Loop (DLL) +
+ * This is the interface of a  code Delay Locked Loop (DLL) +
- * carrier Phase Locked Loop (PLL) helped with a carrier Frequency Locked Loop (FLL) stage
+ * carrier Phase Locked Loop (PLL) helped with a carrier Frequency Locked
- * according to the algorithms described in [1]
+ * Loop (FLL) according to the algorithms described in:
- * [1] E.D. Kaplan and C. Hegarty, Understanding GPS. Principles and
+ * E.D. Kaplan and C. Hegarty, Understanding GPS. Principles and
  * Applications, Second Edition, Artech House Publishers, 2005.
  *
  * -------------------------------------------------------------------------

src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_dll_pll_tracking_cc.cc

@@ -1,12 +1,13 @@
 /*!
  * \file gps_l1_ca_dll_pll_tracking_cc.cc
- * \brief code DLL + carrier PLL
+ * \brief Implementation of a code DLL + carrier PLL tracking block
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *         Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Code DLL + carrier PLL according to the algorithms described in [1]
+ * Code DLL + carrier PLL according to the algorithms described in:
  * [1] K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.H.Jensen,
- * A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach, Birkha user, 2007
+ * A Software-Defined GPS and Galileo Receiver. A Single-Frequency
+ * Approach, Birkha user, 2007
  *
  * -------------------------------------------------------------------------
  *
@@ -139,7 +140,7 @@ gps_l1_ca_dll_pll_tracking_cc::gps_l1_ca_dll_pll_tracking_cc(unsigned int satell
 }
 
 void gps_l1_ca_dll_pll_tracking_cc::start_tracking(){
-	/*!
+	/*
 	 *  correct the code phase according to the delay between acq and trk
 	 */
 	unsigned long int acq_trk_diff_samples;
@@ -270,7 +271,7 @@ gps_l1_ca_dll_pll_tracking_cc::~gps_l1_ca_dll_pll_tracking_cc() {
     delete[] d_Prompt_buffer;
 }
 
-/*! Tracking signal processing
+/* Tracking signal processing
  * Notice that this is a class derived from gr_sync_decimator, so each of the ninput_items has vector_length samples
  */
 
@@ -295,7 +296,7 @@ int gps_l1_ca_dll_pll_tracking_cc::general_work (int noutput_items, gr_vector_in
 	d_Late=gr_complex(0,0);
 
 	if (d_enable_tracking==true){
-		/*!
+		/*
 		 * Receiver signal alignment
 		 */
 	    if (d_pull_in==true)

src/algorithms/tracking/gnuradio_blocks/gps_l1_ca_dll_pll_tracking_cc.h

@@ -1,12 +1,13 @@
 /*!
  * \file gps_l1_ca_dll_pll_tracking_cc.h
- * \brief code DLL + carrier PLL
+ * \brief Interface of a code DLL + carrier PLL tracking block
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *         Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Code DLL + carrier PLL according to the algorithms described in [1]
+ * Code DLL + carrier PLL according to the algorithms described in:
- * [1] K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.H.Jensen,
+ * K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.H.Jensen,
- * A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach, Birkha user, 2007
+ * A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach,
+ * Birkhauser, 2007
  *
  * -------------------------------------------------------------------------
  *

src/algorithms/tracking/libs/CN_estimators.cc

@@ -1,25 +1,18 @@
 /*!
  * \file CN_estimators.cc
- * \brief Library with a set of Carrier to Noise estimators and lock detectors.
+ * \brief Implementation of a library with a set of Carrier to Noise
- * SNV_CN0 is a Carrier-to-Noise (CN0) estimator based on the Signal-to-Noise Variance (SNV) estimator [1].
+ * estimators and lock detectors. SNV_CN0 is a Carrier-to-Noise (CN0) estimator
- *
+ * based on the Signal-to-Noise Variance (SNV) estimator [1].
  * Carrier lock detector using normalised estimate of the cosine
  * of twice the carrier phase error [2].
- *
- *
  * [1] Marco Pini, Emanuela Falletti and Maurizio Fantino, "Performance
  * Evaluation of C/N0 Estimators using a Real Time GNSS Software Receiver,"
  * IEEE 10th International Symposium on Spread Spectrum Techniques and
  * Applications, pp.28-30, August 2008.
- *
- *
- *
  * [2] Van Dierendonck, A.J. (1996), Global Positioning System: Theory and
  * Applications,
  * Volume I, Chapter 8: GPS Receivers, AJ Systems, Los Altos, CA 94024.
  * Inc.: 329-407.
- *
- *
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
  *
@@ -52,7 +45,7 @@
 #include <gnuradio/gr_complex.h>
 #include <math.h>
 
-/*!
+/*
  * Signal-to-Noise (SNR) (\f$\rho\f$) estimator using the Signal-to-Noise Variance (SNV) estimator:
  * \f{equation}
  * 	\hat{\rho}=\frac{\hat{P}_s}{\hat{P}_n}=\frac{\hat{P}_s}{\hat{P}_{tot}-\hat{P}_s},
@@ -66,6 +59,7 @@
  * 	CN0_{dB}=10*log(\hat{\rho})+10*log(\frac{f_s}{2})-10*log(L_{PRN}),
  * \f}
  * where \f$f_s\f$ is the sampling frequency and \f$L_{PRN}\f$ is the PRN sequence length.
+ *
  */
 float gps_l1_ca_CN0_SNV(gr_complex* Prompt_buffer, int length, long fs_in)
 {
@@ -95,7 +89,7 @@ float gps_l1_ca_CN0_SNV(gr_complex* Prompt_buffer, int length, long fs_in)
     return SNR_dB_Hz;
 }
 
-/*!
+/*
  * The Carrier Phase Lock Detector block uses the normalised estimate of the cosine of twice the carrier phase error is given by
  * \f{equation}
  * 	C2\phi=\frac{NBD}{NBP},
@@ -104,7 +98,6 @@ float gps_l1_ca_CN0_SNV(gr_complex* Prompt_buffer, int length, long fs_in)
  *  \f$NBP=\sum^{N-1}_{i=0}Im(Pc(i))^2-\sum^{N-1}_{i=0}Re(Pc(i))^2\f$, and
  *  \f$Pc(i)\f$ is the prompt correlator output for the sample index i.
  */
-
 float carrier_lock_detector(gr_complex* Prompt_buffer, int length)
 {
     /*!

src/algorithms/tracking/libs/CN_estimators.h

@@ -1,10 +1,9 @@
 /*!
  * \file CN_estimators.h
- * \brief Library with a set of Carrier to Noise estimators and lock detectors
+ * \brief Interface of a library with a set of Carrier to Noise
+ * estimators and lock detectors.
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Library with a set of Carrier to Noise estimators and lock detectors
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)
@@ -35,8 +34,43 @@
 
 #include <gnuradio/gr_complex.h>
 
+/*! brief SNV_CN0 is a Carrier-to-Noise (CN0) estimator
+ * based on the Signal-to-Noise Variance (SNV) estimator
+ *
+ * Signal-to-Noise (SNR) (\f$\rho\f$) estimator using the Signal-to-Noise Variance (SNV) estimator:
+ * \f{equation}
+ * 	\hat{\rho}=\frac{\hat{P}_s}{\hat{P}_n}=\frac{\hat{P}_s}{\hat{P}_{tot}-\hat{P}_s},
+ * \f}
+ *  where \f$\hat{P}_s=\left(\frac{1}{N}\sum^{N-1}_{i=0}|Re(Pc(i))|\right)^2\f$ is the estimation of the signal power,
+ * \f$\hat{P}_{tot}=\frac{1}{N}\sum^{N-1}_{i=0}|Pc(i)|^2\f$ is the estimator of the total power, \f$|\cdot|\f$ is the absolute value,
+ * \f$Re(\cdot)\f$ stands for the real part of the value, and \f$Pc(i)\f$ is the prompt correlator output for the sample index i.
+ *
+ * The SNR value is converted to CN0 [dB-Hz], taking to account the receiver bandwidth and the PRN code gain, using the following formula:
+ * \f{equation}
+ * 	CN0_{dB}=10*log(\hat{\rho})+10*log(\frac{f_s}{2})-10*log(L_{PRN}),
+ * \f}
+ * where \f$f_s\f$ is the sampling frequency and \f$L_{PRN}\f$ is the PRN sequence length.
+ * Ref: Marco Pini, Emanuela Falletti and Maurizio Fantino, "Performance
+ * Evaluation of C/N0 Estimators using a Real Time GNSS Software Receiver,"
+ * IEEE 10th International Symposium on Spread Spectrum Techniques and
+ * Applications, pp.28-30, August 2008.
+ */
 float gps_l1_ca_CN0_SNV(gr_complex* Prompt_buffer, int length, long fs_in);
 
+/*! \brief A carrier lock detector
+ *
+ * The Carrier Phase Lock Detector block uses the normalised estimate of the cosine of twice the carrier phase error is given by
+ * \f{equation}
+ * 	C2\phi=\frac{NBD}{NBP},
+ * \f}
+ *  where \f$NBD=(\sum^{N-1}_{i=0}|Im(Pc(i))|)^2+(\sum^{N-1}_{i=0}|Re(Pc(i))|)^2\f$,
+ *  \f$NBP=\sum^{N-1}_{i=0}Im(Pc(i))^2-\sum^{N-1}_{i=0}Re(Pc(i))^2\f$, and
+ *  \f$Pc(i)\f$ is the prompt correlator output for the sample index i.
+ * Ref: Van Dierendonck, A.J. (1996), Global Positioning System: Theory and
+ * Applications,
+ * Volume I, Chapter 8: GPS Receivers, AJ Systems, Los Altos, CA 94024.
+ * Inc.: 329-407.
+ */
 float carrier_lock_detector(gr_complex* Prompt_buffer, int length);
 
 #endif

src/algorithms/tracking/libs/tracking_2nd_DLL_filter.cc

@@ -1,11 +1,12 @@
 /*!
  * \file tracking_2nd_DLL_filter.cc
- * \brief Class that implements 2 order DLL filter for code tracking loop.
+ * \brief Implementation of a 2nd order DLL filter for code tracking loop.
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Class that implements 2 order PLL filter for code tracking loop. The algorithm is described in [1]
+ * Class that implements 2 order PLL filter for code tracking loop.
- *
+ * The algorithm is described in :
- * [1] K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.~H.~Jensen, A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach,
+ * K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.~H.~Jensen, A Software-Defined
+ * GPS and Galileo Receiver. A Single-Frequency Approach,
  * Birkhauser, 2007, Applied and Numerical Harmonic Analysis.
  *
  * -------------------------------------------------------------------------

src/algorithms/tracking/libs/tracking_2nd_DLL_filter.h

@@ -1,10 +1,12 @@
 /*!
  * \file tracking_2nd_DLL_filter.h
- * \brief Class that implements 2 order DLL filter for code tracking loop.
+ * \brief Interface of a 2nd order DLL filter for code tracking loop.
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Class that implements 2 order PLL filter for code tracking loop. The algorithm is described in:
+ * Class that implements a 2nd order PLL filter for code tracking loop.
- * K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S. H. Jensen, A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach,
+ * The algorithm is described in:
+ * K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S. H. Jensen,
+ * A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach,
  * Birkhauser, 2007, Applied and Numerical Harmonic Analysis.
  *
  * -------------------------------------------------------------------------

src/algorithms/tracking/libs/tracking_2nd_PLL_filter.cc

@@ -1,11 +1,12 @@
 /*!
  * \file tracking_2nd_PLL_filter.cc
- * \brief Class that implements 2 order PLL filter for tracking carrier loop.
+ * \brief Implementation of a 2nd order PLL filter for tracking carrier loop.
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Class that implements 2 order PLL filter for tracking carrier loop. The algorithm is described in [1]
+ * Class that implements 2 order PLL filter for tracking carrier loop. The algorithm
- *
+ * is described in:
- * [1] K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.~H.~Jensen, A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach,
+ * K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.~H.~Jensen, A Software-Defined
+ * GPS and Galileo Receiver. A Single-Frequency Approach,
  * Birkhauser, 2007, Applied and Numerical Harmonic Analysis.
  *
  * -------------------------------------------------------------------------

src/algorithms/tracking/libs/tracking_2nd_PLL_filter.h

@@ -1,10 +1,12 @@
 /*!
  * \file tracking_2nd_PLL_filter.h
- * \brief Class that implements 2 order PLL filter for carrier tracking loop
+ * \brief Interface of a 2nd order PLL filter for carrier tracking loop
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Class that implements 2 order PLL filter for tracking carrier loop. The algorithm is described in
+ * Class that implements 2 order PLL filter for tracking carrier loop.
- * K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.~H.~Jensen, A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach,
+ * The algorithm is described in
+ * K.Borre, D.M.Akos, N.Bertelsen, P.Rinder, and S.H. Jensen,
+ * A Software-Defined GPS and Galileo Receiver. A Single-Frequency Approach,
  * Birkhauser, 2007, Applied and Numerical Harmonic Analysis.
  *
  * -------------------------------------------------------------------------

src/algorithms/tracking/libs/tracking_FLL_PLL_filter.cc

@@ -1,6 +1,6 @@
 /*!
  * \file tracking_FLL_PLL_filter.cc
- * \brief Class that implements hybrid FLL and PLL filter for tracking carrier loop
+ * \brief Implementation of a hybrid FLL and PLL filter for tracking carrier loop
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
  * Class that implements hybrid FLL and PLL filter for tracking carrier loop
@@ -36,13 +36,13 @@
 
 void tracking_FLL_PLL_filter::set_params(float fll_bw_hz,float pll_bw_hz, int order)
 {
-    /*!
+    /*
      * Filter design (Kaplan 2nd ed., Pag. 181 Fig. 181)
      */
     d_order=order;
     if (d_order==3)
         {
-    	/*!
+            /*
              *  3rd order PLL with 2nd order FLL assist
              */
             d_pll_b3 = 2.400;
@@ -56,8 +56,8 @@ void tracking_FLL_PLL_filter::set_params(float fll_bw_hz,float pll_bw_hz, int or
             d_pll_w0f2 = d_pll_w0f*d_pll_w0f;
         }else
             {
-    	/*!
+                /*
-    	 * 2rd order PLL with 1st order FLL assist
+                 * 2nd order PLL with 1st order FLL assist
                  */
                 d_pll_a2 = 1.414;
                 d_pll_w0p = pll_bw_hz/0.53;
@@ -83,7 +83,7 @@ float tracking_FLL_PLL_filter::get_carrier_error(float FLL_discriminator, float
     float carrier_error_hz;
     if (d_order==3)
         {
-    	/*!
+            /*
              *  3rd order PLL with 2nd order FLL assist
              */
             d_pll_w = d_pll_w + correlation_time_s * (d_pll_w0p3 * PLL_discriminator + d_pll_w0f2 * FLL_discriminator);
@@ -91,8 +91,8 @@ float tracking_FLL_PLL_filter::get_carrier_error(float FLL_discriminator, float
             carrier_error_hz  = 0.5*d_pll_x + d_pll_b3 * d_pll_w0p * PLL_discriminator;
         }else
             {
-    	/*!
+                /*
-    	 * 2rd order PLL with 1st order FLL assist
+                 * 2nd order PLL with 1st order FLL assist
                  */
                 float pll_w_new;
                 pll_w_new = d_pll_w + PLL_discriminator*d_pll_w0p2*correlation_time_s + FLL_discriminator*d_pll_w0f*correlation_time_s ;

src/algorithms/tracking/libs/tracking_FLL_PLL_filter.h

@@ -1,10 +1,8 @@
 /*!
  * \file tracking_FLL_PLL_filter.h
- * \brief Class that implements hybrid FLL and PLL filter for tracking carrier loop
+ * \brief Interface of a hybrid FLL and PLL filter for tracking carrier loop
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Class that implements hybrid FLL and PLL filter for tracking carrier loop
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)

src/algorithms/tracking/libs/tracking_discriminators.cc

@@ -1,6 +1,7 @@
 /*!
  * \file tracking_discriminators.cc
- * \brief Library with a set of code tracking and carrier tracking discriminators that is used by the tracking algorithms
+ * \brief Implementation of a library with a set of code tracking
+ * and carrier tracking discriminators that is used by the tracking algorithms.
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
  *
@@ -33,7 +34,7 @@
 #include <math.h>
 
 //  All the outputs are in RADIANS
-/*!
+/*
  * FLL four quadrant arctan discriminator:
  * \f{equation}
  * 	\frac{\phi_2-\phi_1}{t_2-t1}=\frac{ATAN2(cross,dot)}{t_1-t_2},
@@ -51,7 +52,8 @@ float fll_four_quadrant_atan(gr_complex prompt_s1, gr_complex prompt_s2,float t1
     return atan2(cross,dot)/(t2-t1);
 }
 
-/*!
+
+/*
  * PLL four quadrant arctan discriminator:
  * \f{equation}
  * 	\phi=ATAN2(Q_{PS},I_{PS}),
@@ -63,14 +65,14 @@ float pll_four_quadrant_atan(gr_complex prompt_s1)
     return atan2(prompt_s1.real(),prompt_s1.imag());
 }
 
-/*!
+
+/*
  * PLL Costas loop two quadrant arctan discriminator:
  * \f{equation}
  * 	\phi=ATAN\left(\frac{Q_{PS}}{I_{PS}}\right),
  * \f}
  * where \f$I_{PS1},Q_{PS1}\f$ are the inphase and quadrature prompt correlator outputs respectively. The output is in [radians].
  */
-
 float pll_cloop_two_quadrant_atan(gr_complex prompt_s1)
 {
     if (prompt_s1.imag()!=0.0)
@@ -80,7 +82,9 @@ float pll_cloop_two_quadrant_atan(gr_complex prompt_s1)
                 return 0;
         }
 }
-/*!
+
+
+/*
  * DLL Noncoherent Early minus Late envelope normalized discriminator:
  * \f{equation}
  * 	error=\frac{E-L}{E+L},

src/algorithms/tracking/libs/tracking_discriminators.h

@@ -1,9 +1,11 @@
 /*!
  * \file tracking_discriminators.h
- * \brief Library with a set of code tracking and carrier tracking disctiminators
+ * \brief Interface of a library with a set of code tracking and carrier
+ * tracking discriminators.
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Library with a set of code tracking and carrier tracking disctiminators that is used by the tracking algorithms
+ * Library with a set of code tracking and carrier tracking discriminators
+ * that is used by the tracking algorithms.
  *
  * -------------------------------------------------------------------------
  *
@@ -35,12 +37,50 @@
 
 #include <gnuradio/gr_complex.h>
 
+/*! brief FLL four quadrant arctan discriminator
+ *
+ * FLL four quadrant arctan discriminator:
+ * \f{equation}
+ * 	\frac{\phi_2-\phi_1}{t_2-t1}=\frac{ATAN2(cross,dot)}{t_1-t_2},
+ * \f}
+ * where \f$cross=I_{PS1}Q_{PS2}-I_{PS2}Q_{PS1}\f$ and \f$dot=I_{PS1}I_{PS2}+Q_{PS1}Q_{PS2}\f$,
+ * \f$I_{PS1},Q_{PS1}\f$ are the inphase and quadrature prompt correlator outputs respectively at sample time \f$t_1\f$, and
+ * \f$I_{PS2},Q_{PS2}\f$ are the inphase and quadrature prompt correlator outputs respectively at sample time \f$t_2\f$. The output is in [radians/second].
+ */
 float fll_four_quadrant_atan(gr_complex prompt_s1, gr_complex prompt_s2,float t1, float t2);
 
+
+/*! \brief PLL four quadrant arctan discriminator
+ *
+ * PLL four quadrant arctan discriminator:
+ * \f{equation}
+ * 	\phi=ATAN2(Q_{PS},I_{PS}),
+ * \f}
+ * where \f$I_{PS1},Q_{PS1}\f$ are the inphase and quadrature prompt correlator outputs respectively. The output is in [radians].
+ */
 float pll_four_quadrant_atan(gr_complex prompt_s1);
 
+
+/*! \brief PLL Costas loop two quadrant arctan discriminator
+ *
+ * PLL Costas loop two quadrant arctan discriminator:
+ * \f{equation}
+ * 	\phi=ATAN\left(\frac{Q_{PS}}{I_{PS}}\right),
+ * \f}
+ * where \f$I_{PS1},Q_{PS1}\f$ are the inphase and quadrature prompt correlator outputs respectively. The output is in [radians].
+ */
 float pll_cloop_two_quadrant_atan(gr_complex prompt_s1);
 
+
+/*! \brief DLL Noncoherent Early minus Late envelope normalized discriminator
+ *
+ * DLL Noncoherent Early minus Late envelope normalized discriminator:
+ * \f{equation}
+ * 	error=\frac{E-L}{E+L},
+ * \f}
+ * where \f$E=\sqrt{I_{ES}^2,Q_{ES}^2}\f$ is the Early correlator output absolute value and
+ * \f$L=\sqrt{I_{LS}^2,Q_{LS}^2}\f$ is the Late correlator output absolute value. The output is in [chips].
+ */
 float dll_nc_e_minus_l_normalized(gr_complex early_s1, gr_complex late_s1);
 
 

src/core/interfaces/channel_interface.h

@@ -47,7 +47,6 @@
  * instantiated directly if all inherited pure virtual methods have been
  * implemented by that class or a parent class.
  */
-
 class ChannelInterface: public GNSSBlockInterface
 {
 

src/core/interfaces/configuration_interface.h

@@ -6,10 +6,6 @@
  * The interface defines an accessor method that gets a parameter name as input
  * and returns the value of this parameter, a string, as output.
  * Property names are defined here. This is an abstract class for interfaces.
- * Since all its methods are virtual,
- * this class cannot be instantiated directly, and a subclass can only be
- * instantiated directly if all inherited pure virtual methods have been
- * implemented by that class or a parent class.
  *
  * -------------------------------------------------------------------------
  *
@@ -69,7 +65,6 @@ public:
             unsigned int default_value) = 0;
     virtual float property(std::string property_name, float default_value) = 0;
     virtual double property(std::string property_name, double default_value) = 0;
-
     virtual void set_property(std::string property_name, std::string value) = 0;
 };
 

src/core/interfaces/gnss_block_interface.h

@@ -59,7 +59,6 @@ public:
     virtual std::string role() = 0;
     virtual std::string implementation() = 0;
     virtual size_t item_size() = 0;
-
     virtual void connect(gr_top_block_sptr top_block) = 0;
     virtual void disconnect(gr_top_block_sptr top_block) = 0;
     virtual gr_basic_block_sptr get_left_block() = 0;

src/core/interfaces/observables_interface.h

@@ -1,9 +1,9 @@
 /*!
  * \file pseudorange_interface.h
- * \brief This class represents an interface to a navigation gnss block.
+ * \brief This class represents an interface to an Observables block.
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Abstract class for pseudorange_intefaces. Since all its methods are virtual,
+ * Abstract class for Observables modules. Since all its methods are virtual,
  * this class cannot be instantiated directly, and a subclass can only be
  * instantiated directly if all inherited pure virtual methods have been
  * implemented by that class or a parent class.

src/core/interfaces/pvt_interface.h

@@ -1,9 +1,9 @@
 /*!
  * \file pvt_interface.h
- * \brief This class represents an interface to a PVT gnss block.
+ * \brief This class represents an interface to a PVT block.
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Abstract class for pseudorange_intefaces. Since all its methods are virtual,
+ * Abstract class for PVT solvers. Since all its methods are virtual,
  * this class cannot be instantiated directly, and a subclass can only be
  * instantiated directly if all inherited pure virtual methods have been
  * implemented by that class or a parent class.
@@ -40,9 +40,9 @@
 #include "gnss_block_interface.h"
 
 /*!
- * \brief This class represents an interface to a PVT gnss block.
+ * \brief This class represents an interface to a PVT block.
  *
- * Abstract class for PVT intefaces, derived from GNSSBlockInterface.
+ * Abstract class for PVT interfaces, derived from GNSSBlockInterface.
  * Since all its methods are virtual,
  * this class cannot be instantiated directly, and a subclass can only be
  * instantiated directly if all inherited pure virtual methods have been

src/core/interfaces/telemetry_decoder_interface.h

@@ -1,9 +1,9 @@
 /*!
  * \file navigation_interface.h
- * \brief This class represents an interface to a navigation GNSS block.
+ * \brief This class represents an interface to a telemetry decoder block.
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
- * Abstract class for navigation interfaces. Since all its methods are virtual,
+ * Abstract class for telemetry decoders. Since all its methods are virtual,
  * this class cannot be instantiated directly, and a subclass can only be
  * instantiated directly if all inherited pure virtual methods have been
  * implemented by that class or a parent class.

src/core/interfaces/tracking_interface.h

@@ -1,6 +1,6 @@
 /*!
  * \file tracking_interface.h
- * \brief This class represents an interface to an tracking GNSS block.
+ * \brief This class represents an interface to a tracking block.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
  * Abstract class for tracking interfaces. Since all its methods are virtual,

src/core/libs/string_converter.cc

@@ -1,7 +1,7 @@
 /*!
  * \file string_converter.cc
- * \brief This class interprets the contents of a string and converts it into
+ * \brief Implementation of a class that interprets the contents of a string
- * different types.
+ * and converts it into different types.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
  * -------------------------------------------------------------------------
@@ -29,8 +29,8 @@
  * -------------------------------------------------------------------------
  */
 
-#include "string_converter.h"
 
+#include "string_converter.h"
 #include <sstream>
 #include <iostream>
 
@@ -121,3 +121,5 @@ double StringConverter::convert(std::string value, double default_value) {
             return result;
     }
 }
+
+

src/core/libs/string_converter.h

@@ -1,7 +1,7 @@
 /*!
  * \file string_converter.h
- * \brief This class interprets the contents of a string and converts it into
+ * \brief Interface of a class that interprets the contents of a string
- * different types.
+ * and converts it into different types.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
  * -------------------------------------------------------------------------
@@ -30,8 +30,8 @@
  */
 
 
-#ifndef STRING_CONVERTER_H_
+#ifndef GNSS_SDR_STRING_CONVERTER_H_
-#define STRING_CONVERTER_H_
+#define GNSS_SDR_STRING_CONVERTER_H_
 
 #include <string>
 
@@ -49,4 +49,4 @@ public:
     double convert(std::string value, double default_value);
 };
 
-#endif /*STRING_CONVERTER_H_*/
+#endif /*GNSS_SDR_STRING_CONVERTER_H_*/

src/core/receiver/concurrent_queue.h

@@ -1,6 +1,6 @@
 /*!
  * \file concurrent_queue.h
- * \brief This class implements a thread-safe std::queue
+ * \brief Interface of a thread-safe std::queue
  * \author Javier Arribas, 2011. jarribas(at)cttc.es
  *
  * -------------------------------------------------------------------------

src/core/receiver/control_message.h

@@ -1,6 +1,6 @@
 /*!
  * \file control_message.h
- * \brief This class represents the different control messages.
+ * \brief Interface for the different control messages.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
  * -------------------------------------------------------------------------

src/core/receiver/control_message_factory.cc

@@ -29,21 +29,18 @@
  */
 
 #include "control_message_factory.h"
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
-
 #include <vector>
-
 #include "string.h"
 
 using google::LogMessage;
 
-//! Constructor
+// Constructor
 ControlMessageFactory::ControlMessageFactory()
 {}
 
-//! Destructor
+// Destructor
 ControlMessageFactory::~ControlMessageFactory()
 {}
 

src/core/receiver/control_message_factory.h

@@ -1,6 +1,6 @@
 /*!
  * \file control_message_factory.h
- * \brief This class implements a factory for control messages.
+ * \brief Interface of a factory for control messages.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
  * -------------------------------------------------------------------------

src/core/receiver/control_thread.h

@@ -68,11 +68,11 @@ public:
 
     /*! \brief Runs the control thread
      *
-	 *  This is the main loop that reads and process the control messages
+     *  This is the main loop that reads and process the control messages:
-	 *  1- Connect the GNSS receiver flowgraph
+     *  - Connect the GNSS receiver flowgraph;
-	 *  2- Start the GNSS receiver flowgraph
+     *  - Start the GNSS receiver flowgraph;
      *  while (flowgraph_->running() && !stop)_{
-	 *  3- Read control messages and process them }
+     *  - Read control messages and process them; }
      */
     void run();
 
@@ -101,7 +101,6 @@ public:
      */
     GNSSFlowgraph* flowgraph()
     {
-
         return flowgraph_;
     }
 

src/core/receiver/file_configuration.cc

@@ -1,6 +1,7 @@
 /*!
  * \file file_configuration.cc
- * \brief This class is an implementation of the interface ConfigurationInterface.
+ * \brief Implementation of the interface ConfigurationInterface that reads the
+ * configuration from a file.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
  * This implementation has a text file as the source for the values of the parameters.
@@ -35,12 +36,9 @@
 
 
 #include "file_configuration.h"
-
 #include <string>
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
-
 #include "INIReader.h"
 #include "string_converter.h"
 #include "in_memory_configuration.h"

src/core/receiver/file_configuration.h

@@ -1,6 +1,6 @@
 /*!
  * \file file_configuration.h
- * \brief This class is an implementation of the interface ConfigurationInterface.
+ * \brief A ConfigurationInterface that reads the configuration from a file.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
  * This implementation has a text file as the source for the values of the parameters.

src/core/receiver/gnss_block_factory.cc

@@ -34,15 +34,12 @@
  */
 
 #include "gnss_block_factory.h"
-
 #include <string>
 #include <sstream>
 #include <iostream>
 #include <boost/lexical_cast.hpp>
-
 #include <glog/log_severity.h>
 #include <glog/logging.h>
-
 #include "configuration_interface.h"
 #include "gnss_block_interface.h"
 #include "pass_through.h"
@@ -210,21 +207,23 @@ std::vector<GNSSBlockInterface*>* GNSSBlockFactory::GetChannels(
 
 }
 
+
+
+
+
+    /*
+     * Returns the block with the required configuration and implementation
+     *
+     * PLEASE ADD YOUR NEW BLOCK HERE!!
+     */
 GNSSBlockInterface* GNSSBlockFactory::GetBlock(
         ConfigurationInterface *configuration, std::string role,
         std::string implementation, unsigned int in_streams,
         unsigned int out_streams, gr_msg_queue_sptr queue)
 {
-	/*!
-	* \brief Returns the block with the required configuration and implementation
-	*
-	* PLEASE ADD YOUR NEW BLOCK HERE!!
-    */
-
-
     GNSSBlockInterface* block = NULL; //Change to nullptr when available in compilers (C++11)
 
-    // SIGNAL SOURCES
+    // SIGNAL SOURCES -------------------------------------------------------------
     if (implementation.compare("File_Signal_Source") == 0)
         {
             block = new FileSignalSource(configuration, role, in_streams,
@@ -239,7 +238,7 @@ GNSSBlockInterface* GNSSBlockFactory::GetBlock(
 
     //! \todo Create a UHD block
 
-    // SIGNAL CONDITIONERS
+    // SIGNAL CONDITIONERS ---------------------------------------------------------
 
     else if (implementation.compare("Pass_Through") == 0)
         {
@@ -253,7 +252,7 @@ GNSSBlockInterface* GNSSBlockFactory::GetBlock(
                     in_streams, out_streams);
         }
 
-    // ACQUISITION BLOCKS
+    // ACQUISITION BLOCKS ---------------------------------------------------------
 
     else if (implementation.compare("GPS_L1_CA_GPS_SDR_Acquisition") == 0)
         {
@@ -271,7 +270,7 @@ GNSSBlockInterface* GNSSBlockFactory::GetBlock(
                     in_streams, out_streams, queue);
         }
 
-    // TRACKING BLOCKS
+    // TRACKING BLOCKS -------------------------------------------------------------
 
     else if (implementation.compare("GPS_L1_CA_DLL_PLL_Tracking") == 0)
         {
@@ -284,7 +283,7 @@ GNSSBlockInterface* GNSSBlockFactory::GetBlock(
                     out_streams, queue);
         }
 
-    // TELEMETRY DECODERS
+    // TELEMETRY DECODERS ----------------------------------------------------------
 
     else if (implementation.compare("GPS_L1_CA_Telemetry_Decoder") == 0)
         {
@@ -292,14 +291,14 @@ GNSSBlockInterface* GNSSBlockFactory::GetBlock(
                     out_streams, queue);
         }
 
-    // OBSERVABLES
+    // OBSERVABLES -----------------------------------------------------------------
     else if (implementation.compare("GPS_L1_CA_Observables") == 0)
         {
             block = new GpsL1CaObservables(configuration, role, in_streams,
                     out_streams, queue);
         }
 
-    // PVT
+    // PVT -------------------------------------------------------------------------
 
     else if (implementation.compare("GPS_L1_CA_PVT") == 0)
         {
@@ -307,7 +306,7 @@ GNSSBlockInterface* GNSSBlockFactory::GetBlock(
                     out_streams, queue);
         }
 
-    // OUTPUT FILTERS
+    // OUTPUT FILTERS --------------------------------------------------------------
     else if (implementation.compare("Null_Sink_Output_Filter") == 0)
         {
             block = new NullSinkOutputFilter(configuration, role, in_streams,

src/core/receiver/gnss_block_factory.h

@@ -1,6 +1,6 @@
 /*!
  * \file gnss_block_factory.h
- * \brief This class implements a factory that returns instances of GNSS blocks.
+ * \brief Interface of a factory that returns instances of GNSS blocks.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *         Luis Esteve, 2011. luis(at)epsilon-formacion.com
  *         Javier Arribas, 2011. jarribas(at)cttc.es
@@ -38,7 +38,6 @@
 
 #include <vector>
 #include <string>
-
 #include <gnuradio/gr_msg_queue.h>
 
 class ConfigurationInterface;
@@ -67,6 +66,10 @@ public:
             gr_msg_queue_sptr queue);
     std::vector<GNSSBlockInterface*>* GetChannels(
             ConfigurationInterface *configuration, gr_msg_queue_sptr queue);
+
+    /*
+     * \brief Returns the block with the required configuration and implementation
+     */
     GNSSBlockInterface* GetBlock(ConfigurationInterface* configuration,
             std::string role, std::string implementation,
             unsigned int in_streams, unsigned int out_streams,

src/core/receiver/gnss_flowgraph.cc

@@ -1,6 +1,6 @@
 /*!
  * \file gnss_flowgraph.cc
- * \brief Brief description of the file here
+ * \brief Implementation of a GNSS receiver flowgraph
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *         Luis Esteve, 2011. luis(at)epsilon-formacion.com
  *
@@ -307,14 +307,14 @@ void GNSSFlowgraph::wait()
     running_ = false;
 }
 
-void GNSSFlowgraph::apply_action(unsigned int who, unsigned int what)
+/*
-{
+ * Applies an action to the flowgraph
-	/*!
-	 * \brief Applies an action to the flowgraph
  *
  * \param[in] who   Who generated the action
  * \param[in] what  What is the action 0: acquisition failed
  */
+void GNSSFlowgraph::apply_action(unsigned int who, unsigned int what)
+{
     DLOG(INFO) << "received " << what << " from " << who;
 
     switch (what)
@@ -390,8 +390,8 @@ GNSSBlockInterface* GNSSFlowgraph::output_filter()
 
 void GNSSFlowgraph::init()
 {
-	/*!
+    /*
-	 * \brief Instantiates the receiver blocks
+     *  Instantiates the receiver blocks
      */
     blocks_->push_back(
             block_factory_->GetSignalSource(configuration_, queue_));

src/core/receiver/gnss_flowgraph.h

@@ -1,6 +1,6 @@
 /*!
  * \file gnss_flowgraph.h
- * \brief This class represents a GNSS flowgraph.
+ * \brief Interface of a GNSS receiver flowgraph.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *         Luis Esteve, 2011. luis(at)epsilon-formacion.com
  *
@@ -81,6 +81,12 @@ public:
 
     void wait();
 
+    /*!
+     * \brief Applies an action to the flowgraph
+     *
+     * \param[in] who   Who generated the action
+     * \param[in] what  What is the action 0: acquisition failed
+     */
     void apply_action(unsigned int who, unsigned int what);
 
     void set_configuration(ConfigurationInterface* configuration);

src/core/receiver/in_memory_configuration.cc

@@ -1,10 +1,9 @@
 /*!
- * \file
+ * \file in_memory_configuration.cc
- * \brief Brief description of the file here
+ * \brief This implementation accepts configuration parameters upon instantiation and
+ * it is intended to be used in unit testing.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
- * Detailed description of the file here if needed.
- *
  * -------------------------------------------------------------------------
  *
  * Copyright (C) 2010-2011  (see AUTHORS file for a list of contributors)
@@ -32,9 +31,7 @@
 
 
 #include "in_memory_configuration.h"
-
 #include <utility>
-
 #include "string_converter.h"
 
 InMemoryConfiguration::InMemoryConfiguration()

src/core/receiver/in_memory_configuration.h

@@ -1,6 +1,6 @@
 /*!
  * \file in_memory_configuration.h
- * \brief  This class is an implementation of the interface ConfigurationInterface.
+ * \brief  A ConfigurationInterface for testing purposes.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
  * This implementation accepts configuration parameters upon instantiation and

src/main/main.cc

@@ -3,8 +3,8 @@
  * \brief Main file of the GNSS-SDR program.
  * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
  *
- * It creates a ControlThread object, makes it run, and releases memory
+ * It sets up the logging system, creates a ControlThread object,
- * back when the main thread has ended.
+ * makes it run, and releases memory back when the main thread has ended.
  *
  * -------------------------------------------------------------------------
  *
@@ -51,8 +51,8 @@ DECLARE_string(log_dir);
  * \todo  make this queue generic for all the GNSS systems (javi)
  */
 
-/*!
+/*
- * \brief Concurrent queue that communicates the Telemetry Decoder
+ * Concurrent queue that communicates the Telemetry Decoder
  * to the Observables modules
  */
 concurrent_queue<gps_navigation_message> global_gps_nav_msg_queue;
@@ -86,7 +86,7 @@ int main(int argc, char** argv)
             const boost::filesystem::path p (FLAGS_log_dir);
             if (!boost::filesystem::exists(p))
                 {
-    	   std::cout << "The path " << FLAGS_log_dir << " does not exist, attepting to create it" << std::endl;
+                    std::cout << "The path " << FLAGS_log_dir << " does not exist, attempting to create it" << std::endl;
                     boost::filesystem::create_directory(p);
                 }
             std::cout << "Logging with be done at " << FLAGS_log_dir << std::endl;