Skip to content

Commit

Permalink
Comments formating
Browse files Browse the repository at this point in the history
  • Loading branch information
linev committed Feb 12, 2025
1 parent 1327746 commit 4110f42
Show file tree
Hide file tree
Showing 14 changed files with 37 additions and 63 deletions.
4 changes: 1 addition & 3 deletions plugins/aqua/aqua/ClientOutput.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@

namespace aqua {

/** \brief Client transport for A1 DAQ
*
**/
/** \brief Client transport for A1 DAQ */

struct SendHeader {
int64_t counter;
Expand Down
4 changes: 1 addition & 3 deletions plugins/dim/dim/Monitor.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ namespace dim {

/** \brief Player of DIM data
*
* Module builds hierarchy for discovered DIM variables
*
**/
* Module builds hierarchy for discovered DIM variables */

class Monitor : public mbs::MonitorSlowControl,
public DimInfoHandler {
Expand Down
4 changes: 1 addition & 3 deletions plugins/dofi/dofi/Player.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ namespace dofi {

/** \brief Player of DOFI data
*
* Module provides DOFI command and custom user interface
*
**/
* Module provides DOFI command and custom user interface */

class Player : public dabc::ModuleAsync {
protected:
Expand Down
24 changes: 12 additions & 12 deletions plugins/dofi/dofi/TerminalModule.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ extern "C"
#include <linux/types.h>
#include <linux/spi/spidev.h>
}
/****************************************************************/

/** we use this spi device for communication with muppet fpga */
#define DOFI_SPIDEV_DEFAULT "/dev/spidev1.2"

Expand All @@ -54,8 +54,8 @@ namespace dofi {
*/

class TerminalModule : public dabc::ModuleAsync {


public:

TerminalModule(const std::string &name, dabc::Command cmd = nullptr);
Expand Down Expand Up @@ -89,8 +89,8 @@ class TerminalModule : public dabc::ModuleAsync {
/** fill next values from configuration file into com structure.
* returns -1 if end of config is reached*/
int next_config_values (dofi::Command &com);


/** configure registers from file*/
int configure (dofi::Command &com);

Expand All @@ -117,13 +117,13 @@ class TerminalModule : public dabc::ModuleAsync {
int single_command (dofi::Command &com);


private:
private:



typedef enum
{

DOFI_SPI_WRITE = 0x1,
DOFI_SPI_READ = 0x2,
DOFI_SPI_SCALER_DISABLE = 0x4,
Expand Down Expand Up @@ -155,9 +155,9 @@ typedef enum




std::string fSPI_Device; /**< name of spi device for communication. */

int fFD_spi; /**< file descriptor to driver /dev/spidev1.2"*/

/** parameters for spi transfer: */
Expand Down Expand Up @@ -197,9 +197,9 @@ typedef enum

/*** return message after command execution */
std::string fCommandMessage;




};
}
Expand Down
4 changes: 1 addition & 3 deletions plugins/ezca/ezca/Monitor.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@ namespace ezca {
* Module builds hierarchy for connected FESA classes,
* which could be served via DABC web server in any browser
*
* In addition, module can provide data with stored EPICS records in form of MBS events
*
**/
* In addition, module can provide data with stored EPICS records in form of MBS events */

class Monitor : public mbs::MonitorSlowControl {
protected:
Expand Down
4 changes: 1 addition & 3 deletions plugins/fesa/fesa/Monitor.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ namespace fesa {
*
* Module builds hierarchy for connected FESA classes,
* which could be served via DABC web server in any browser
* Optionally, one able to convert data into MBS events, which could be delivered to analysis
*
**/
* Optionally, one able to convert data into MBS events, which could be delivered to analysis*/

class Monitor : public mbs::MonitorSlowControl {
protected:
Expand Down
4 changes: 1 addition & 3 deletions plugins/fesa/fesa/Player.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,7 @@ namespace fesa {
/** \brief Player of FESA data
*
* Module builds hierarchy for connected FESA classes,
* which could be served via DABC web server in any browser
*
**/
* which could be served via DABC web server in any browser */

class Player : public dabc::ModuleAsync {
protected:
Expand Down
4 changes: 1 addition & 3 deletions plugins/gosip/gosip/Player.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@ namespace gosip {

/** \brief Player of GOSIP data
*
* Module provides GOSIP command and custom user interface
*
**/
* Module provides GOSIP command and custom user interface */

class Player : public dabc::ModuleAsync {
protected:
Expand Down
5 changes: 0 additions & 5 deletions plugins/gosip/gosip/TerminalModule.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,6 @@
#include <sstream>



/****************************************************************/



namespace gosip {

/** \brief Abstract GOSIP terminal module
Expand Down
4 changes: 1 addition & 3 deletions plugins/hadaq/hadaq/MonitorModule.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@ namespace hadaq {
* Module builds hierarchy for connected FESA classes,
* which could be served via DABC web server in any browser
*
* In addition, module can provide data with stored EPICS records in form of MBS events
*
**/
* In addition, module can provide data with stored EPICS records in form of MBS events */

class MonitorModule : public dabc::ModuleAsync {
protected:
Expand Down
7 changes: 2 additions & 5 deletions plugins/mbs/mbs/Monitor.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@

namespace mbs {


/** \brief Addon class to retrieve status record from MBS server **/
/** \brief Addon class to retrieve status record from MBS server */

class DaqStatusAddon : public dabc::SocketIOAddon {

Expand Down Expand Up @@ -217,9 +216,7 @@ namespace mbs {
* used to calculate different rate values.
*
* Details about module usage are described in
* [web interface for MBS](\ref mbs_web_interface).
*
**/
* [web interface for MBS](\ref mbs_web_interface). */

class Monitor : public mbs::MonitorSlowControl {
protected:
Expand Down
4 changes: 1 addition & 3 deletions plugins/mbs/mbs/MonitorSlowControl.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,7 @@ namespace mbs {

/** \brief Base class for monitoring of slow control data
*
* It delivers collected slow-control data to output
*
**/
* It delivers collected slow-control data to output */

class MonitorSlowControl : public dabc::ModuleAsync {
protected:
Expand Down
4 changes: 2 additions & 2 deletions plugins/olmd/mbsapi/f_radware.c
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ int f_radware_out1d(char *pc_file, char *pc_name, float *pr_data, int l_chan, in
strcpy(c_str,"rm ");
strncat(c_str, pc_file, sizeof(c_str)-1);
l_status=system(c_str);
/* JAM 7-5-2024: supress unused result warnings**/
/* JAM 7-5-2024: supress unused result warnings */
if(l_status == -1) printf("Error calling rm old file \n");
}
i32_fd = open(pc_file, O_WRONLY | O_CREAT | O_EXCL, HIS__BASPERM);
Expand Down Expand Up @@ -99,7 +99,7 @@ if(l_over)
strcpy(c_str,"rm ");
strncat(c_str,pc_file, sizeof(c_str)-1);
l_status=system(c_str);
/* JAM 7-5-2024: supress unused result warnings**/
/* JAM 7-5-2024: supress unused result warnings */
if(l_status == -1) printf("Error calling rm old file \n");

}
Expand Down
24 changes: 12 additions & 12 deletions plugins/user/user/Input.h
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,19 @@ namespace user

// These are the actual user readout functions to implement: //

/** Initialize the readout hardware on startup*/
virtual int User_Init ();
/** Initialize the readout hardware on startup */
virtual int User_Init();

/** Fill the data at the buffer pointer. size returns filled size in bytes*/
/** Fill the data at the buffer pointer. size returns filled size in bytes */
virtual int User_Readout (uint32_t* pdat, unsigned long& size);

/** Here any kind of external trigger can be waited for*/
virtual int User_WaitForTrigger ();
virtual int User_WaitForTrigger();

/** Used to clear any kind of external trigger information**/
/** Used to clear any kind of external trigger information */
virtual int User_ResetTrigger();

/** shut down the readout hardware properly at the end*/
/** shut down the readout hardware properly at the end */
virtual int User_Cleanup();


Expand All @@ -75,23 +75,23 @@ namespace user
/** actual payload length of read buffer*/
unsigned int fReadLength;

/** Event number since device init*/
/** Event number since device init */
unsigned int fNumEvents;

/** subevent size for this example*/
/** subevent size for this example */
unsigned int fSubeventSize;

/** For mbsformat: defines subevent sub-crate id for case fSingleSubevent=true*/
/** For mbsformat: defines subevent sub-crate id for case fSingleSubevent=true */
unsigned int fSubeventSubcrate;

/** For mbsformat: defines subevent procid*/
/** For mbsformat: defines subevent procid */
unsigned int fSubeventProcid;

/** For mbsformat: defines subevent control*/
/** For mbsformat: defines subevent control */
unsigned int fSubeventControl;

/** rest the trigger before device buffer has been read out.
* This can speed up things if DAQ is provided with double buffering or external data queues.**/
* This can speed up things if DAQ is provided with double buffering or external data queues. */
bool fEarlyTriggerClear;

/** flag for optional debug output*/
Expand Down

0 comments on commit 4110f42

Please sign in to comment.