From c6549694a85954dc9af2ec59083e488974952235 Mon Sep 17 00:00:00 2001 From: Dhanya Maliakal Date: Thu, 17 Aug 2017 14:16:54 +0200 Subject: [PATCH] command line docu. more coming up --- .../slsDetector/slsDetectorCommand.cpp | 24 ++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp b/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp index 96fc6b284..497c50610 100644 --- a/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp +++ b/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp @@ -954,12 +954,21 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) { - /* trim/cal directories */ + /*! \page settings Detector settings commands Commands to setup the settings of the detector + - \ref settingsdir "Settings, trim & cal Directories": commands to setup settings/trim/cal directories + - \ref settingssett "Settings and Threshold": commands to configure settings and threshold of detector + - \ref settingsdacs "DACs": commands to configure DACs of detector + - \ref settingsadcs "ADCs": commands to readout ADCs of detector */ + /* trim/cal directories */ + /*! \page settings + \section settingsdir Settings, trim & cal Directories + commands to setup settings/trim/cal directories + */ /*! \page settings - settingsdir [dir] Sets/gets the directory where the settings files are located (string) */ @@ -988,6 +997,10 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) { i++; /* settings, threshold */ + /*! \page settings + \section settingssett Settings and Threshold + commands to configure settings and threshold of detector + */ /*! \page settings - settings [s] sets/gets the settings of the detector. Options: \c standard, \c fast, \c highgain, \c dynamicgain, \c lowgain, \c mediumgain, \c veryhighgain, @@ -1043,6 +1056,11 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) { /* pots */ + /*! \page settings + \section settingsdacs DACs + commands to configure DACs of detector + */ + /*! \page settings - vthreshold [i] [mv] Sets/gets detector threshold voltage for single photon counters. Normally in DAC units unless \c mv is specified at the end of the command line (int) */ @@ -1399,6 +1417,10 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) { i++; /* r/w timers */ + /*! \page settings + \section settingsadcs ADCs + commands to readout ADCs of detector + */ /*! \page settings - temp_adc Gets the ADC temperature (int)