detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-06-23 10:07:59 +02:00
Code Issues Actions Packages Releases Activity

doc warnings fixed

Browse Source
This commit is contained in:
maliakal_d
2020-06-23 17:32:56 +02:00
parent cd677e4d97
commit ba7f54744b
17 changed files with 59 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
slsSupportLib/include/ZmqSocket.h
View File

@ -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

2
slsSupportLib/include/file_utils.h
View File

@ -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

12
slsSupportLib/include/sls_detector_defs.h
View File

@ -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 {