From 5f23a664fa5e00df12f89244697ad1594b98ffa3 Mon Sep 17 00:00:00 2001
From: Dhanya Thattil <dhanya.thattil@psi.ch>
Date: Wed, 19 Aug 2020 18:45:39 +0200
Subject: [PATCH] wip doc

---
 python/slsdet/detector.py              |  2 +-
 slsDetectorSoftware/include/Detector.h | 29 ++++++++++++++++++--------
 slsDetectorSoftware/src/CmdProxy.cpp   |  2 +-
 3 files changed, 22 insertions(+), 11 deletions(-)

diff --git a/python/slsdet/detector.py b/python/slsdet/detector.py
index 9167245e1..ec876a386 100755
--- a/python/slsdet/detector.py
+++ b/python/slsdet/detector.py
@@ -636,6 +636,7 @@ class Detector(CppDetectorApi):
         return self._register
 
     @property
+    def adcreg(self):
         """[Jungfrau][Ctb][Moench][Gotthard] Writes to an adc register 
 
         Note
@@ -644,7 +645,6 @@ class Detector(CppDetectorApi):
 
         :getter: Not implemented     
         """ 
-    def adcreg(self):
         return self._adc_register
 
     @property
diff --git a/slsDetectorSoftware/include/Detector.h b/slsDetectorSoftware/include/Detector.h
index ad05c64b6..4cb4601be 100644
--- a/slsDetectorSoftware/include/Detector.h
+++ b/slsDetectorSoftware/include/Detector.h
@@ -1382,26 +1382,30 @@ class Detector {
      *                                                *
      * ************************************************/
 
-    /** [Jungfrau][CTB][Moench] fname is a pof file
+    /**  Advanced user Function!
+     * [Jungfrau][CTB][Moench] fname is a pof file
      * [Mythen3][Gotthard2] fname is an rbf file
      */
     void programFPGA(const std::string &fname, Positions pos = {});
 
-    /** [Jungfrau][CTB][Moench] */
+    /** [Jungfrau][CTB][Moench]  Advanced user Function!  */
     void resetFPGA(Positions pos = {});
 
     /** [Jungfrau][Gotthard][CTB][Moench][Mythen3][Gotthard2]
+     * Advanced user Function!
      * Copy detector server fname from tftp folder of hostname to detector
      * Also changes respawn server, which is effective after a reboot.
      */
     void copyDetectorServer(const std::string &fname,
                             const std::string &hostname, Positions pos = {});
 
-    /** [Jungfrau][Gotthard][CTB][Moench][Mythen3][Gotthard2] */
+    /** [Jungfrau][Gotthard][CTB][Moench][Mythen3][Gotthard2] Advanced user
+     * Function! */
     void rebootController(Positions pos = {});
 
     /**
      * [Jungfrau][Gotthard][CTB][Moench]
+     * Advanced user Function!
      * Updates the firmware, detector server and then reboots detector
      * controller blackfin.
      * sname is name of detector server binary found on tftp folder of host
@@ -1413,34 +1417,41 @@ class Detector {
                                  const std::string &hostname,
                                  const std::string &fname, Positions pos = {});
 
+    /** Advanced user Function!  */
     Result<uint32_t> readRegister(uint32_t addr, Positions pos = {}) const;
 
+    /** Advanced user Function!  */
     void writeRegister(uint32_t addr, uint32_t val, Positions pos = {});
 
+    /** Advanced user Function!  */
     void setBit(uint32_t addr, int bitnr, Positions pos = {});
 
+    /** Advanced user Function!  */
     void clearBit(uint32_t addr, int bitnr, Positions pos = {});
 
-    /** [Gotthard][Jungfrau][Mythen3][Gotthard2][CTB][Moench] */
+    /** [Gotthard][Jungfrau][Mythen3][Gotthard2][CTB][Moench] Advanced user
+     * Function! */
     void executeFirmwareTest(Positions pos = {});
 
-    /** [Gotthard][Jungfrau][Mythen3][Gotthard2][CTB][Moench] */
+    /** [Gotthard][Jungfrau][Mythen3][Gotthard2][CTB][Moench] Advanced user
+     * Function! */
     void executeBusTest(Positions pos = {});
 
-    /** [Gotthard][Jungfrau][CTB][Moench] Advanced user Function. not possible
+    /** [Gotthard][Jungfrau][CTB][Moench] Advanced user Function! not possible
      * to read back */
     void writeAdcRegister(uint32_t addr, uint32_t value, Positions pos = {});
 
+    /** Advanced user Function!  */
     bool getInitialChecks() const;
 
     /** initial compaibility and other server start up checks
-     * default enabled */
+     * default enabled Advanced user Function! */
     void setInitialChecks(const bool value);
 
-    /** [CTB][Moench][Jungfrau] */
+    /** [CTB][Moench][Jungfrau] Advanced user Function! */
     Result<uint32_t> getADCInvert(Positions pos = {}) const;
 
-    /** [CTB][Moench][Jungfrau] */
+    /** [CTB][Moench][Jungfrau] Advanced user Function! */
     void setADCInvert(uint32_t value, Positions pos = {});
 
     /**************************************************
diff --git a/slsDetectorSoftware/src/CmdProxy.cpp b/slsDetectorSoftware/src/CmdProxy.cpp
index 7f30df6c8..a0edc608f 100644
--- a/slsDetectorSoftware/src/CmdProxy.cpp
+++ b/slsDetectorSoftware/src/CmdProxy.cpp
@@ -2516,7 +2516,7 @@ std::string CmdProxy::AdcRegister(int action) {
     if (action == defs::HELP_ACTION) {
         os << "[address] [value]\n\t[Jungfrau][Ctb][Moench][Gotthard] Writes "
               "to an adc "
-              "register in hex. Advanced user Function."
+              "register in hex. Advanced user Function!"
            << '\n';
     } else if (action == defs::GET_ACTION) {
         throw sls::RuntimeError("Cannot get.");