sigProcLib: Fix documentation, sync argument names in .cpp and .h files.

Documentation in sigProcLib.h was noticeably out of sync with the actual
implementation - e.g. not all arguments were documented and arguments
which are already removed are still in the documentation. Also argument
names were different between declaration in .h and implementation in .cpp
which was confusing.

I've fixed this for detect*Burst() functions.

Change-Id: I4dfd07125d9a1e9a42a78b79faff539f003deb16

1 files changed, 12 insertions, 12 deletions

diff --git a/Transceiver52M/sigProcLib.cpp b/Transceiver52M/sigProcLib.cpp
index 2a22e49..c1cf12e 100644
--- a/Transceiver52M/sigProcLib.cpp
+++ b/Transceiver52M/sigProcLib.cpp
@@ -1876,22 +1876,22 @@ int detectGeneralBurst(signalVector &rxBurst,
  *   head: Search 8 symbols before target
  *   tail: Search 8 symbols + maximum expected delay
  */
-int detectRACHBurst(signalVector &rxBurst,
-            float thresh,
+int detectRACHBurst(signalVector &burst,
+            float threshold,
             int sps,
-            complex &amp,
+            complex &amplitude,
             float &toa,
-            unsigned maxTOA)
+            unsigned max_toa)
 {
   int rc, target, head, tail;
   CorrelationSequence *sync;
 
   target = 8 + 40;
   head = 8;
-  tail = 8 + maxTOA;
+  tail = 8 + max_toa;
   sync = gRACHSequence;
 
-  rc = detectGeneralBurst(rxBurst, thresh, sps, amp, toa,
+  rc = detectGeneralBurst(burst, threshold, sps, amplitude, toa,
                           target, head, tail, sync);
 
   return rc;
@@ -1905,8 +1905,8 @@ int detectRACHBurst(signalVector &rxBurst,
  *   head: Search 6 symbols before target
  *   tail: Search 6 symbols + maximum expected delay
  */
-int analyzeTrafficBurst(signalVector &rxBurst, unsigned tsc, float thresh,
-                        int sps, complex &amp, float &toa, unsigned max_toa)
+int analyzeTrafficBurst(signalVector &burst, unsigned tsc, float threshold,
+                        int sps, complex &amplitude, float &toa, unsigned max_toa)
 {
   int rc, target, head, tail;
   CorrelationSequence *sync;
@@ -1919,13 +1919,13 @@ int analyzeTrafficBurst(signalVector &rxBurst, unsigned tsc, float thresh,
   tail = 6 + max_toa;
   sync = gMidambles[tsc];
 
-  rc = detectGeneralBurst(rxBurst, thresh, sps, amp, toa,
+  rc = detectGeneralBurst(burst, threshold, sps, amplitude, toa,
                           target, head, tail, sync);
   return rc;
 }
 
-int detectEdgeBurst(signalVector &rxBurst, unsigned tsc, float thresh,
-                    int sps, complex &amp, float &toa, unsigned max_toa)
+int detectEdgeBurst(signalVector &burst, unsigned tsc, float threshold,
+                    int sps, complex &amplitude, float &toa, unsigned max_toa)
 {
   int rc, target, head, tail;
   CorrelationSequence *sync;
@@ -1938,7 +1938,7 @@ int detectEdgeBurst(signalVector &rxBurst, unsigned tsc, float thresh,
   tail = 6 + max_toa;
   sync = gEdgeMidambles[tsc];
 
-  rc = detectGeneralBurst(rxBurst, thresh, sps, amp, toa,
+  rc = detectGeneralBurst(burst, threshold, sps, amplitude, toa,
                           target, head, tail, sync);
   return rc;
 }