[hamradio-commits] [gnss-sdr] 36/44: Documenting the new method

[Carles Fernandez]

This is an automated email from the git hooks/post-receive script.

carles_fernandez-guest pushed a commit to branch next
in repository gnss-sdr.

commit 59a158c5760529c233c46dd1fc4ad4310ea8e0c7
Author: Carles Fernandez <carles.fernandez at gmail.com>
Date:   Sat Feb 14 11:32:22 2015 +0100

    Documenting the new method
---
 .../acquisition/adapters/galileo_e1_pcps_ambiguous_acquisition.h    | 3 +++
 .../adapters/galileo_e1_pcps_cccwsr_ambiguous_acquisition.h         | 3 +++
 .../adapters/galileo_e1_pcps_quicksync_ambiguous_acquisition.h      | 3 +++
 .../adapters/galileo_e1_pcps_tong_ambiguous_acquisition.h           | 3 +++
 src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition.h    | 3 +++
 .../acquisition/adapters/gps_l1_ca_pcps_quicksync_acquisition.h     | 3 +++
 .../acquisition/adapters/gps_l1_ca_pcps_tong_acquisition.h          | 6 ++++--
 7 files changed, 22 insertions(+), 2 deletions(-)

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 c69d93d..fb0b098 100644
--- a/src/algorithms/acquisition/adapters/galileo_e1_pcps_ambiguous_acquisition.h
+++ b/src/algorithms/acquisition/adapters/galileo_e1_pcps_ambiguous_acquisition.h
@@ -129,6 +129,9 @@ public:
      */
     void reset();
 
+    /*!
+     * \brief If state = 1, it forces the block to start acquiring from the first sample
+     */
     void set_state(int state);
 
 private:
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 3e82b63..0acfd07 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
@@ -126,6 +126,9 @@ public:
      */
     void reset();
 
+    /*!
+     * \brief If state = 1, it forces the block to start acquiring from the first sample
+     */
     void set_state(int state);
 
 private:
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 00c55ca..ec71e7c 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
@@ -129,6 +129,9 @@ public:
      */
     void reset();
 
+    /*!
+     * \brief If state = 1, it forces the block to start acquiring from the first sample
+     */
     void set_state(int state);
 
 private:
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 b3751df..16c8b1f 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
@@ -129,6 +129,9 @@ public:
      */
     void reset();
 
+    /*!
+     * \brief If state = 1, it forces the block to start acquiring from the first sample
+     */
     void set_state(int state);
 
 private:
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 077a937..5266594 100644
--- a/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition.h
+++ b/src/algorithms/acquisition/adapters/gps_l1_ca_pcps_acquisition.h
@@ -137,6 +137,9 @@ public:
      */
     void reset();
 
+    /*!
+     * \brief If state = 1, it forces the block to start acquiring from the first sample
+     */
     void set_state(int state);
 
 private:
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 7234755..88f1ebe 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
@@ -132,6 +132,9 @@ public:
      */
     void reset();
 
+    /*!
+     * \brief If state = 1, it forces the block to start acquiring from the first sample
+     */
     void set_state(int state);
 private:
     ConfigurationInterface* configuration_;
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 9ca96c8..e4afb6e 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
@@ -127,10 +127,12 @@ public:
 
     /*!
      * \brief Restart acquisition algorithm
-     *///    std::cout << "role " << role_ << std::endl;
-
+     */
     void reset();
 
+    /*!
+     * \brief If state = 1, it forces the block to start acquiring from the first sample
+     */
     void set_state(int state);
 
 private:

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-hamradio/gnss-sdr.git