detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-06-23 01:58:00 +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

6
slsReceiverSoftware/include/CircularFifo.h
View File

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

14
slsReceiverSoftware/include/Receiver.h
View File

@ -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).
*/