From 65da9e701b85ccdb0b9bdec3793cfefce1accef4 Mon Sep 17 00:00:00 2001
From: Dhanya Thattil <dhanya.thattil@psi.ch>
Date: Mon, 21 Sep 2020 18:30:33 +0200
Subject: [PATCH] wip, doc

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

diff --git a/python/slsdet/detector.py b/python/slsdet/detector.py
index 70e507db1..0452b0c99 100755
--- a/python/slsdet/detector.py
+++ b/python/slsdet/detector.py
@@ -2361,7 +2361,9 @@ class Detector(CppDetectorApi):
     @property
     def pattern(self):
         """[Mythen3][Moench][Ctb] Loads ASCII pattern file directly to server (instead of executing line by line).
-
+        Note
+        ----
+        :getter: Not Implemented
         Example
         ---------
         >>> d.pattern = '/tmp/pat.txt'
diff --git a/slsDetectorSoftware/include/Detector.h b/slsDetectorSoftware/include/Detector.h
index 4bb7d0771..f8b23d774 100644
--- a/slsDetectorSoftware/include/Detector.h
+++ b/slsDetectorSoftware/include/Detector.h
@@ -1394,7 +1394,8 @@ class Detector {
      *                                                *
      * ************************************************/
 
-    /** [CTB][Moench][Mythen3] */
+    /** [CTB][Moench][Mythen3]  Loads ASCII pattern file directly to server
+     * (instead of executing line by line)*/
     void setPattern(const std::string &fname, Positions pos = {});
 
     /** [CTB][Moench][Mythen3] */
@@ -1409,9 +1410,9 @@ class Detector {
     /** [CTB][Moench][Mythen3] same as executing for ctb and moench */
     Result<uint64_t> getPatternWord(int addr, Positions pos = {});
 
-    /** [CTB] Caution: If word is  -1  reads the addr (same as
+    /** [CTB][Moench] Caution: If word is  -1  reads the addr (same as
      * executing the pattern)
-     * [Mythen3][Moench] */
+     * [Mythen3] */
     void setPatternWord(int addr, uint64_t word, Positions pos = {});
 
     /**[CTB][Moench][Mythen3] Options: level: -1 (complete pattern) and 0-2
@@ -1427,9 +1428,7 @@ class Detector {
                                  Positions pos = {});
 
     /**[CTB][Moench][Mythen3] Options: level: -1 (complete pattern) and 0-2
-     * levels
-     * @returns number of loops
-     */
+     * levels  */
     Result<int> getPatternLoopCycles(int level, Positions pos = {}) const;
 
     /** [CTB][Moench][Mythen3] n: 0-2, level: -1 (complete pattern) and 0-2
diff --git a/slsDetectorSoftware/src/CmdProxy.cpp b/slsDetectorSoftware/src/CmdProxy.cpp
index 103bc7df3..d50d97b6c 100644
--- a/slsDetectorSoftware/src/CmdProxy.cpp
+++ b/slsDetectorSoftware/src/CmdProxy.cpp
@@ -2108,8 +2108,8 @@ std::string CmdProxy::PatternWord(int action) {
     os << cmd << ' ';
     if (action == defs::HELP_ACTION) {
         os << "[step or address] [64 bit mask]\n\t[Ctb][Moench][Mythen3] 64 "
-              "bit pattern at "
-              "address of pattern memory."
+              "bit pattern at address of pattern memory.\n\t[Ctb][Moench] read "
+              "is same as executing pattern"
            << '\n';
     } else if (action == defs::GET_ACTION) {
         if (args.size() != 1) {