From 42067b3de30fe8d70994355d5f6c037532d9a1eb Mon Sep 17 00:00:00 2001 From: Dhanya Thattil Date: Wed, 19 Aug 2020 17:27:04 +0200 Subject: [PATCH] WIP doc --- python/slsdet/detector.py | 8 ++++++++ slsDetectorSoftware/include/Detector.h | 3 ++- slsDetectorSoftware/src/CmdProxy.cpp | 2 +- 3 files changed, 11 insertions(+), 2 deletions(-) diff --git a/python/slsdet/detector.py b/python/slsdet/detector.py index 1a4bc5d03..9e4019bfe 100755 --- a/python/slsdet/detector.py +++ b/python/slsdet/detector.py @@ -620,6 +620,14 @@ class Detector(CppDetectorApi): return self._register @property + """[Jungfrau][Ctb][Moench][Gotthard] Writes to an adc register + + Note + ----- + Advanced user Function! + + :getter: Not implemented + """ def adcreg(self): return self._adc_register diff --git a/slsDetectorSoftware/include/Detector.h b/slsDetectorSoftware/include/Detector.h index ab7598910..ad05c64b6 100644 --- a/slsDetectorSoftware/include/Detector.h +++ b/slsDetectorSoftware/include/Detector.h @@ -1427,7 +1427,8 @@ class Detector { /** [Gotthard][Jungfrau][Mythen3][Gotthard2][CTB][Moench] */ void executeBusTest(Positions pos = {}); - /** [Gotthard][Jungfrau][CTB][Moench] not possible to read back*/ + /** [Gotthard][Jungfrau][CTB][Moench] Advanced user Function. not possible + * to read back */ void writeAdcRegister(uint32_t addr, uint32_t value, Positions pos = {}); bool getInitialChecks() const; diff --git a/slsDetectorSoftware/src/CmdProxy.cpp b/slsDetectorSoftware/src/CmdProxy.cpp index ca6251625..7f30df6c8 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." + "register in hex. Advanced user Function." << '\n'; } else if (action == defs::GET_ACTION) { throw sls::RuntimeError("Cannot get.");