mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-06-20 08:38:00 +02:00
doc warnings fixed
This commit is contained in:
@ -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);
|
||||
|
||||
|
@ -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);
|
||||
|
||||
|
@ -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
|
||||
*/
|
||||
|
@ -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;
|
||||
|
@ -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
|
||||
*/
|
||||
|
@ -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
|
||||
|
Reference in New Issue
Block a user