doc warnings fixed

slsDetectorSoftware/src/DetectorImpl.h

@@ -68,7 +68,7 @@ class DetectorImpl : public virtual slsDetectorDefs {
   public:
     /**
      * Constructor
-     * @param id multi detector id
+     * @param multi_id multi detector id
      * @param verify true to verify if shared memory version matches existing
      * one
      * @param update true to update last user pid, date etc
@@ -213,7 +213,7 @@ class DetectorImpl : public virtual slsDetectorDefs {
 
     /**
      * Connect to Virtual Detector Servers at local host
-     * @param ndet number of detectors
+     * @param numdet number of detectors
      * @param port starting port number
      */
     void setVirtualDetectorServers(const int numdet, const int port);
@@ -283,8 +283,7 @@ class DetectorImpl : public virtual slsDetectorDefs {
      * [Jungfrau][Ctb] from pof file
      * [Mythen3][Gotthard2] from rbf file
      * @param fname name of pof/rbf file
-     * @param fpgasrc pointer in memory to read programming file to
-     * @returns file size
+     * @returns binary of the program
      */
     std::vector<char> readProgrammingFile(const std::string &fname);
 
@@ -302,7 +301,6 @@ class DetectorImpl : public virtual slsDetectorDefs {
      * Creates shm and initializes shm structure OR
      * Open shm and maps to structure
      * @param verify true to verify if shm size matches existing one
-     * @param update true to update last user pid, date etc
      */
     void initSharedMemory(bool verify = true);
 
@@ -364,7 +362,7 @@ class DetectorImpl : public virtual slsDetectorDefs {
 
     /**
      * Main thread sets if the processing thread should join it
-     * @param v true if it should join, else false
+     * @param value true if it should join, else false
      */
     void setJoinThreadFlag(bool value);
 

slsDetectorSoftware/src/Module.h

@@ -64,12 +64,12 @@ class Module : public virtual slsDetectorDefs {
      * ************************************************/
 
     /** creating new shared memory
-    @param verify if shared memory version matches existing one */
+    verify is if shared memory version matches existing one */
     explicit Module(detectorType type, int det_id = 0, int module_id = 0,
                     bool verify = true);
 
     /** opening existing shared memory
-    @param verify if shared memory version matches existing one */
+    verify is if shared memory version matches existing one */
     explicit Module(int det_id = 0, int module_id = 0, bool verify = true);
 
     virtual ~Module();
@@ -81,7 +81,7 @@ class Module : public virtual slsDetectorDefs {
     bool isFixedPatternSharedMemoryCompatible();
     std::string getHostname() const;
 
-    /** @param initialChecks enable or disable initial compatibility checks and
+    /** initialChecks is enable or disable initial compatibility checks and
     other server start up checks. Enabled by default. Disable only for advanced
     users! */
     void setHostname(const std::string &hostname, const bool initialChecks);
@@ -600,11 +600,11 @@ class Module : public virtual slsDetectorDefs {
     Ret sendToReceiver(int fnum, const Arg &args) const;
 
     /** Get Detector Type from Shared Memory
-    @param verify if shm size matches existing one */
+    verify is if shm size matches existing one */
     detectorType getDetectorTypeFromShm(int det_id, bool verify = true);
 
     /** Initialize shared memory
-     @param verify if shm size matches existing one  */
+    verify is if shm size matches existing one  */
     void initSharedMemory(detectorType type, int det_id, bool verify = true);
 
     /** Initialize detector structure to defaults,
@@ -639,7 +639,7 @@ class Module : public virtual slsDetectorDefs {
      * @param energy energy to trim at
      * @param e1 reference trim value
      * @param e2 reference trim value
-     * @param tb 1 to include trimbits, 0 to exclude (used for eiger)
+     * @param trimbits 1 to include trimbits, 0 to exclude (used for eiger)
      * @returns  the pointer to the module structure with interpolated values or
      * NULL if error
      */

slsDetectorSoftware/src/SharedMemory.h

@@ -92,7 +92,6 @@ template <typename T> class SharedMemory {
 
     /**
      * Verify if it exists
-     * @param name of shared memory
      * @return true if exists, else false
      */
     bool IsExisting() {
@@ -116,7 +115,6 @@ template <typename T> class SharedMemory {
      * Create Shared memory and call MapSharedMemory to map it to an address
      * throws a SharedMemoryError exception on failure to create, ftruncate or
      * map
-     * @param sz of shared memory
      */
     void CreateSharedMemory() {
         fd = shm_open(name.c_str(), O_CREAT | O_TRUNC | O_EXCL | O_RDWR,
@@ -144,7 +142,6 @@ template <typename T> class SharedMemory {
     /**
      * Open existing Shared memory and call MapSharedMemory to map it to an
      * address throws a SharedMemoryError exception on failure to open or map
-     * @param sz of shared memory
      */
     void OpenSharedMemory() {
         fd = shm_open(name.c_str(), O_RDWR, 0);
@@ -248,7 +245,6 @@ template <typename T> class SharedMemory {
     /**
      * Map shared memory to an address
      * throws a SharedMemoryException exception on failure
-     * @param sz of shared memory
      */
 
     T *MapSharedMemory() {