Fixed Doxygen warnings on not properly documented methods

src/lasp/device/lasp_daqdata.h

@@ -109,7 +109,7 @@ public:
    * Overwrites any existing available data.
    *
    * @param channel The channel to copy to
-   * @param ptrs Pointers to data from channels
+   * @param ptr Pointers to data from channels
    */
   void copyInFromRaw(const us channel, const byte_t *ptr);
 
@@ -135,7 +135,7 @@ public:
    * column vector of floats. For data that is not already floating-point,
    * the data is scaled back from MAX_INT to +1.0.
    *
-   * @param channel The channel to convert
+   * @param channel_no The channel number to convert
    *
    * @return Array of floats
    */
@@ -146,8 +146,8 @@ public:
    * column vector of floats. For data that is not already floating-point,
    * the data is scaled back from MAX_INT to +1.0.
    *
-   * @param channel The channel to convert
    * @param frame_no The frame number to convert
+   * @param channel_no The channel number to convert
    *
    * @return Float value
    */
@@ -157,9 +157,9 @@ public:
    * @brief Convert to channel data of native type from floating point values.
    * Useful for 'changing' raw data in any way.
    *
-   * @param channel_no
+   * @param frame_no The frame
-   * @param channel_no
+   * @param channel_no The channel
-   * @param data
+   * @param data The value
    */
   void fromFloat(const us frame_no, const us channel_no,
                  const d data);
@@ -169,7 +169,7 @@ public:
    * Useful for 'changing' raw data in any way.
    *
    * @param channel The channel to convert
-   * @param data
+   * @param data Data to convert from float values
    */
   void fromFloat(const us channel, const arma::Col<d> &data);
 

src/lasp/device/lasp_uldaq.h

@@ -13,6 +13,6 @@ std::unique_ptr<Daq> createUlDaqDevice(const DeviceInfo &devinfo,
 /**
  * @brief Fill device info list with UlDaq specific devices, if any.
  *
- * @param devinfolist Info list to append to
+ * @param devinfolist Info list to append to.
  */
-void fillUlDaqDeviceInfo(DeviceInfoList&);
+void fillUlDaqDeviceInfo(DeviceInfoList& devinfolist);

src/lasp/dsp/lasp_fft.cpp

@@ -135,7 +135,7 @@ cmat Fft::fft(const dmat &freqdata) {
   /// * WARNING *. This was source of a serious bug. It is not possible to run
   /// FFT's and IFFT's on the same _impl, as it overwrites the same memory.
   /// Uncommenting the line below results in faulty results.
-  /// #pragma omp parallel for
+  // #pragma omp parallel for
   for (us colno = 0; colno < freqdata.n_cols; colno++) {
     res.col(colno) = _impl->fft(freqdata.col(colno));
   }
@@ -152,7 +152,7 @@ dmat Fft::ifft(const cmat &freqdata) {
   /// * WARNING *. This was source of a serious bug. It is not possible to run
   /// FFT's and IFFT's on the same _impl, as it overwrites the same memory.
   /// Uncommenting the line below results in faulty results.
-  /// #pragma omp parallel for
+  // #pragma omp parallel for
 
   for (us colno = 0; colno < freqdata.n_cols; colno++) {
     res.col(colno) = _impl->ifft(freqdata.col(colno));

src/lasp/dsp/lasp_ppm.h

@@ -84,7 +84,14 @@ class PPMHandler: public ThreadedInDataHandler {
    */
   std::tuple<vd,arma::uvec> getCurrentValue() const;
 
-  bool inCallback_threaded(const DaqData& ) override final;
+  /**
+   * @brief Implements callback on thread
+   *
+   * @param d DaqData to work with
+   *
+   * @return true when stream should continue.
+   */
+  bool inCallback_threaded(const DaqData& d) override final;
   void reset(const Daq*) override final;
 
 };

src/lasp/dsp/lasp_rtaps.h

@@ -42,7 +42,8 @@ public:
    * @param mgr StreamMgr singleton reference
    * @param freqWeightingFilter Optionally: the frequency weighting filter.
    * Nullptr should be given for Z-weighting.
-   * @param For all other arguments, see constructor of AvPowerSpectra
+   * 
+   * For all other arguments, see constructor of AvPowerSpectra
    */
   RtAps(StreamMgr &mgr, const Filter *freqWeightingFilter, const us nfft = 2048,
         const Window::WindowType w = Window::WindowType::Hann,
@@ -57,7 +58,14 @@ public:
    */
   ccube getCurrentValue() const;
 
-  bool inCallback_threaded(const DaqData &) override final;
+  /**
+   * @brief Implements the work to to when new DaqData arrives
+   *
+   * @param d DaqData to use for computing/updating spectra
+   *
+   * @return true if stream should continue.
+   */
+  bool inCallback_threaded(const DaqData & d) override final;
   void reset(const Daq *) override final;
 };
 

src/lasp/dsp/lasp_threadedindatahandler.h

@@ -51,11 +51,11 @@ class ThreadedInDataHandler: public InDataHandler {
    * @brief This function should be overridden with an actual implementation,
    * of what should happen on a different thread.
    *
-   * @param DaqData Input daq data
+   * @param d Input daq data
    *
    * @return true on succes. False when an error occured.
    */
-  virtual bool inCallback_threaded(const DaqData&) = 0;
+  virtual bool inCallback_threaded(const DaqData& d) = 0;
 
 };