doc warnings fixed

cmk.sh

@@ -271,13 +271,20 @@ if [ $COMPILERTHREADS -gt 0 ]; then
 	BUILDCOMMAND="make -j$COMPILERTHREADS"
 	echo $BUILDCOMMAND
 	eval $BUILDCOMMAND
+	if [ $MANUALS -eq 1 ]; then
+		BUILDCOMMAND="make docs -j$COMPILERTHREADS"
+		echo $BUILDCOMMAND
+		eval $BUILDCOMMAND
+	fi 
 else
+	echo "make"
 	make
+	if [ $MANUALS -eq 1 ]; then
+		echo "make docs"
+		make docs
+	fi 
 fi
 
-if [ $MANUALS -eq 1 ]; then
-	make docs
-fi 
 
 
 

slsDetectorSoftware/include/Detector.h

@@ -550,7 +550,7 @@ class Detector {
      * Validates and sets the receiver.
      * Updates local receiver cache parameters
      * Configures the detector to the receiver as UDP destination
-     * @param receiver receiver hostname or IP address, can include tcp port eg.
+     * receiver is receiver hostname or IP address, can include tcp port eg.
      * hostname:port
      */
     void setRxHostname(const std::string &receiver, Positions pos = {});
@@ -669,7 +669,7 @@ class Detector {
 
     Result<int> getRxZmqFrequency(Positions pos = {}) const;
 
-    /** @param freq nth frame streamed out of receiver.
+    /** freq is nth frame streamed out of receiver.
      * If 0, streaming timer is the timeout,
      * after which current frame sent out. Default is 0 at 200 ms.
      * Default is 1: send every frame.
@@ -863,7 +863,7 @@ class Detector {
      * and temperature control is enabled,
      * power to chip will be switched off and
      * temperature event will be set
-     * @param val value in degrees
+     * val is value in degrees
      */
     void setThresholdTemperature(int temp, Positions pos = {});
 
@@ -924,7 +924,7 @@ class Detector {
      * [Gotthard]
      * Options: Only a single ROI per module
      * Can set only a single ROI at a time
-     * @param module position index
+     * module_id is position index
      */
     void setROI(defs::ROI value, int module_id);
 
@@ -956,8 +956,8 @@ class Detector {
     Result<std::array<int, 2>> getInjectChannel(Positions pos = {});
 
     /** [Gotthard2]
-     * @param offsetChannel starting channel to be injected
-     * @param incrementChannel determines succeeding channels to be injected */
+     * offsetChannel is starting channel to be injected
+     * incrementChannel is determines succeeding channels to be injected */
     void setInjectChannel(const int offsetChannel, const int incrementChannel,
                           Positions pos = {});
 
@@ -1166,8 +1166,8 @@ class Detector {
     /**
      * [CTB] Set Digital IO Delay
      * cannot get
-     * @param digital IO mask to select the pins
-     * @param delay delay in ps(1 bit=25ps, max of 775 ps)
+     * pinMask is IO mask to select the pins
+     * delay is delay in ps(1 bit=25ps, max of 775 ps)
      */
     void setDigitalIODelay(uint64_t pinMask, int delay, Positions pos = {});
 
@@ -1335,11 +1335,10 @@ class Detector {
      * [Jungfrau][Gotthard][CTB][Moench]
      * Updates the firmware, detector server and then reboots detector
      * controller blackfin.
-     * @param sname name of detector server binary found on tftp folder of host
+     * sname is name of detector server binary found on tftp folder of host
      * pc
-     * @param hostname name of pc to tftp from
-     * @param fname programming file name
-     * @param pos detector positions
+     * hostname is name of pc to tftp from
+     * fname is programming file name
      */
     void updateFirmwareAndServer(const std::string &sname,
                                  const std::string &hostname,

slsDetectorSoftware/include/detectorData.h

@@ -11,9 +11,9 @@ class detectorData {
      * Constructor
      * @param progress progress index
      * @param fname file name prefix
-     * @param nx number of detector channels (1D detector) or dimension in x (2D
+     * @param x number of detector channels (1D detector) or dimension in x (2D
      * detector)
-     * @param ny dimension in y (2D detector)
+     * @param y dimension in y (2D detector)
      * @param d pointer to data in char* format
      * @param dbytes number of bytes of image pointed to by cval pointer
      * @param dr dynamic range or bits per pixel

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() {

slsReceiverSoftware/include/CircularFifo.h

@@ -63,7 +63,7 @@ template <typename Element> int CircularFifo<Element>::getFreeValue() const {
  * If queue is full at 'push' operation no update/overwrite
  * will happen, it is up to the caller to handle this case
  *
- * \param item_ copy by reference the input item
+ * \param item copy by reference the input item
  * \param no_block if true, return immediately if fifo is full
  * \return whether operation was successful or not */
 template <typename Element>
@@ -83,7 +83,7 @@ bool CircularFifo<Element>::push(Element *&item, bool no_block) {
  * If queue is empty at 'pop' operation no retrieve will happen
  * It is up to the caller to handle this case
  *
- * \param item_ return by reference the wanted item
+ * \param item return by reference the wanted item
  * \param no_block if true, return immediately if fifo is full
  * \return whether operation was successful or not */
 template <typename Element>
@@ -120,7 +120,7 @@ template <typename Element> bool CircularFifo<Element>::isFull() const {
 /** Increment helper function for index of the circular queue
  * index is incremented or wrapped
  *
- *  \param idx_ the index to the incremented/wrapped
+ *  \param i the index to the incremented/wrapped
  *  \return new value for the index */
 template <typename Element>
 size_t CircularFifo<Element>::increment(size_t i) const {

slsReceiverSoftware/include/Receiver.h

@@ -54,7 +54,7 @@ class Receiver : private virtual slsDetectorDefs {
     /**
      * Call back for acquisition finished
      * callback argument is
-     * @param total frames caught
+     * total frames caught
      */
     void registerCallBackAcquisitionFinished(void (*func)(uint64_t, void *),
                                              void *arg);
@@ -62,9 +62,9 @@ class Receiver : private virtual slsDetectorDefs {
     /**
      * Call back for raw data
      * args to raw data ready callback are
-     * @param sls_receiver_header frame metadata
-     * @param dataPointer is the pointer to the data
-     * @param dataSize in bytes is the size of the data in bytes.
+     * sls_receiver_header frame metadata,
+     * dataPointer is the pointer to the data,
+     * dataSize in bytes is the size of the data in bytes.
      */
     void registerCallBackRawDataReady(void (*func)(char *, char *, uint32_t,
                                                    void *),
@@ -73,9 +73,9 @@ class Receiver : private virtual slsDetectorDefs {
     /**
      * Call back for raw data (modified)
      * args to raw data ready callback are
-     * @param sls_receiver_header frame metadata
-     * @param dataPointer is the pointer to the data
-     * @param revDatasize is the reference of data size in bytes.
+     * sls_receiver_header frame metadata,
+     * dataPointer is the pointer to the data,
+     * revDatasize is the reference of data size in bytes.
      * Can be modified to the new size to be written/streamed. (only smaller
      * value).
      */

slsReceiverSoftware/src/DataProcessor.h

@@ -32,7 +32,7 @@ class DataProcessor : private virtual slsDetectorDefs, public ThreadObject {
      * @param f address of Fifo pointer
      * @param ftype pointer to file format type
      * @param fwenable file writer enable
-     * @apram mfwenable pointer to master file write enable
+     * @param mfwenable pointer to master file write enable
      * @param dsEnable pointer to data stream enable
      * @param dr pointer to dynamic range
      * @param freq pointer to streaming frequency
@@ -104,7 +104,7 @@ class DataProcessor : private virtual slsDetectorDefs, public ThreadObject {
 
     /**
      * Set File Format
-     * @param f file format
+     * @param fs file format
      */
     void SetFileFormat(const fileFormat fs);
 
@@ -200,7 +200,7 @@ class DataProcessor : private virtual slsDetectorDefs, public ThreadObject {
     /**
      * Process an image popped from fifo,
      * write to file if fw enabled & update parameters
-     * @param buffer
+     * @param buf address of pointer
      */
     void ProcessAnImage(char *buf);
 

slsReceiverSoftware/src/DataStreamer.h

@@ -62,13 +62,13 @@ class DataStreamer : private virtual slsDetectorDefs, public ThreadObject {
 
     /**
      * Set number of detectors
-     * @param number of detectors in both dimensions
+     * @param nd number of detectors in both dimensions
      */
     void SetNumberofDetectors(int *nd);
 
     /**
      * Set Flipped data enable across x dimension
-     * @param flipped data enable in x dimension
+     * @param fd data enable in x dimension
      */
     void SetFlippedDataX(int fd);
 
@@ -121,7 +121,7 @@ class DataStreamer : private virtual slsDetectorDefs, public ThreadObject {
     /**
      * Process an image popped from fifo,
      * write to file if fw enabled & update parameters
-     * @param buffer
+     * @param buf address of pointer
      */
     void ProcessAnImage(char *buf);
 

slsReceiverSoftware/src/File.h

@@ -74,6 +74,7 @@ class File : private virtual slsDetectorDefs {
     /**
      * Write data to file
      * @param buffer buffer to write from
+     * @param buffersize size of buffer
      * @param fnum current image number
      * @param nump number of packets caught
      */

slsReceiverSoftware/src/GeneralData.h

@@ -87,7 +87,7 @@ class GeneralData {
     /**
      * Get Adc configured
      * @param index thread index for debugging purposes
-     * @param ROI
+     * @param i
      * @returns adc configured
      */
     virtual int GetAdcConfigured(int index, slsDetectorDefs::ROI i) const {
@@ -138,7 +138,7 @@ class GeneralData {
      * @returns analog data bytes
      */
     virtual int setImageSize(uint32_t a, uint32_t as, uint32_t ds, bool t,
-                             slsDetectorDefs::readoutMode) {
+                             slsDetectorDefs::readoutMode f) {
         LOG(logERROR) << "setImageSize is a generic function that should be "
                          "overloaded by a derived class";
         return 0;
@@ -388,7 +388,7 @@ class JungfrauData : public GeneralData {
 
     /**
      * set number of interfaces (jungfrau)
-     * @param number of interfaces
+     * @param n number of interfaces
      */
     void SetNumberofInterfaces(const int n) {
         // 2 interfaces
@@ -502,7 +502,7 @@ class Gotthard2Data : public GeneralData {
 
     /**
      * set number of interfaces
-     * @param number of interfaces
+     * @param n number of interfaces
      */
     void SetNumberofInterfaces(const int n) {
         // 2 interfaces (+veto)
@@ -662,7 +662,7 @@ class MoenchData : public GeneralData {
      * @returns analog data bytes
      */
     int setImageSize(uint32_t a, uint32_t as, uint32_t ds, bool t,
-                     slsDetectorDefs::readoutMode) {
+                     slsDetectorDefs::readoutMode f) {
 
         // count number of channels in x, each adc has 25 channels each
         int nchanTop = __builtin_popcount(a & 0xF0F0F0F0) * 25;

slsReceiverSoftware/src/Listener.h

@@ -133,7 +133,7 @@ class Listener : private virtual slsDetectorDefs, public ThreadObject {
     /**
      * Listen to the UDP Socket for an image,
      * place them in the right order
-     * @param buffer
+     * @param buf address of buffer
      * @returns number of bytes of relevant data, can be image size or 0 (stop
      * acquisition) or -1 to discard image
      */

slsReceiverSoftware/src/MultiReceiverApp.cpp

@@ -106,7 +106,6 @@ void GetData(char *metadata, char *datapointer, uint32_t datasize, void *p) {
  * for each image call back.
  * @param metadata sls_receiver_header metadata
  * @param datapointer pointer to data
- * @param datasize data size in bytes.
  * @param revDatasize new data size in bytes after the callback.
  * This will be the size written/streamed. (only smaller value is allowed).
  * @param p pointer to object

slsSupportLib/include/ZmqSocket.h

@@ -80,7 +80,7 @@ class ZmqSocket {
     /**
      * Constructor for a client
      * Creates socket, context and connects to server
-     * @param hostname hostname or ip of server
+     * @param hostname_or_ip hostname or ip of server
      * @param portnumber port number
      */
     ZmqSocket(const char *const hostname_or_ip, const uint32_t portnumber);
@@ -88,7 +88,6 @@ class ZmqSocket {
     /**
      * Constructor for a server
      * Creates socket, context and connects to server
-     * @param hostname hostname or ip of server
      * @param portnumber port number
      * @param ethip is the ip of the ethernet interface to stream zmq from
      */
@@ -170,7 +169,7 @@ class ZmqSocket {
      * Parse Header
      * @param index self index for debugging
      * @param length length of message
-     * @param message message
+     * @param buff message
      * @param zHeader filled out zmqHeader structure (parsed from json header)
      * @param version version that has to match, -1 to not care
      * @returns true if successful else false

slsSupportLib/include/file_utils.h

@@ -19,7 +19,7 @@ int readDataFile(std::ifstream &infile, short int *data, int nch,
 
 /** (used by multi and sls)
  * reads a short int rawdata file
- * @param name of the file to be read
+ * @param fname name of the file to be read
  * @param data array of data value
  * @param nch number of channels
  * @returns OK or FAIL if it could not read the file or data=NULL

slsSupportLib/include/sls_detector_defs.h

@@ -535,18 +535,6 @@ struct detParameters {
 
 /**
     @short  structure for a detector module
-
-    should not be used by unexperienced users
-
-    \see  :: moduleRegisterBit ::chipRegisterBit :channelRegisterBit
-
-    @li reg is the module register (e.g. dynamic range? see moduleRegisterBit)
-    @li dacs is the pointer to the array of dac values (in V)
-    @li adcs is the pointer to the array of adc values (in V)
-    @li chipregs is the pointer to the array of chip registers
-    @li chanregs is the pointer to the array of channel registers
-    @li gain is the module gain
-    @li offset is the module offset
 */
 #ifdef __cplusplus
 struct sls_detector_module {