From cf6a48d7a97e096a92ef33655ee70bb918ca06d6 Mon Sep 17 00:00:00 2001
From: Dhanya Thattil <dhanya.thattil@psi.ch>
Date: Fri, 21 Aug 2020 13:20:32 +0200
Subject: [PATCH] WIP doc

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

diff --git a/python/slsdet/detector.py b/python/slsdet/detector.py
index b0aa1fd2b..61d66149c 100755
--- a/python/slsdet/detector.py
+++ b/python/slsdet/detector.py
@@ -197,6 +197,14 @@ class Detector(CppDetectorApi):
 
     @property
     def frames(self):
+        """Number of frames per acquisition. In trigger mode, number of frames per trigger.
+
+        Notes
+        -----
+        Cannot be set in modular level. ????
+        In scan mode, number of frames is set to number of steps.
+        [Gotthard2] Burst mode has a maximum of 2720 frames.
+        """
         return element_if_equal(self.getNumberOfFrames())
 
     @frames.setter
@@ -472,6 +480,7 @@ class Detector(CppDetectorApi):
 
     @property
     def fwrite(self):
+        """Enable or disable receiver file write. Default is enabled. """
         return element_if_equal(self.getFileWrite())
 
     @fwrite.setter
diff --git a/slsDetectorSoftware/include/Detector.h b/slsDetectorSoftware/include/Detector.h
index 0b8c90dfc..d80fef1e8 100644
--- a/slsDetectorSoftware/include/Detector.h
+++ b/slsDetectorSoftware/include/Detector.h
@@ -170,6 +170,8 @@ class Detector {
 
     Result<int64_t> getNumberOfFrames(Positions pos = {}) const;
 
+    /** In trigger mode, number of frames per trigger. In scan mode, number of
+     * frames is set to number of steps */
     void setNumberOfFrames(int64_t value);
 
     Result<int64_t> getNumberOfTriggers(Positions pos = {}) const;
diff --git a/slsDetectorSoftware/src/CmdProxy.cpp b/slsDetectorSoftware/src/CmdProxy.cpp
index 28a976ab4..2aa1bea24 100644
--- a/slsDetectorSoftware/src/CmdProxy.cpp
+++ b/slsDetectorSoftware/src/CmdProxy.cpp
@@ -203,7 +203,7 @@ std::string CmdProxy::Acquire(int action) {
     return os.str();
 }
 
-std::string CmdProxy::free(int action) {
+std::string CmdProxy::Free(int action) {
     // This  function is purely for help, actual functionality is in the caller
     return "free\n\tFree detector shared memory\n";
 }
diff --git a/slsDetectorSoftware/src/CmdProxy.h b/slsDetectorSoftware/src/CmdProxy.h
index a5ad6662e..470281ec2 100644
--- a/slsDetectorSoftware/src/CmdProxy.h
+++ b/slsDetectorSoftware/src/CmdProxy.h
@@ -635,7 +635,7 @@ class CmdProxy {
 
         /* configuration */
         {"config", &CmdProxy::config},
-        {"free", &CmdProxy::free},
+        {"free", &CmdProxy::Free},
         {"parameters", &CmdProxy::parameters},
         {"hostname", &CmdProxy::Hostname},
         {"virtual", &CmdProxy::VirtualServer},
@@ -1011,7 +1011,7 @@ class CmdProxy {
     /* Commands */
     std::string ListCommands(int action);
     /* configuration */
-    std::string free(int action);
+    std::string Free(int action);
     // std::string config2(int action);
     std::string Hostname(int action);
     std::string VirtualServer(int action);
@@ -1161,9 +1161,10 @@ class CmdProxy {
 
     INTEGER_COMMAND_NOID(
         frames, getNumberOfFrames, setNumberOfFrames, StringTo<int64_t>,
-        "[n_frames]\n\tNumber of frames per aquire. In trigger mode, number of "
-        "frames per trigger."
-        "\n\t[Gotthard2] Burst mode has a maximum of 2720 frames.");
+        "[n_frames]\n\tNumber of frames per acquisition. In "
+        "trigger mode, number of frames per trigger. Cannot be set in modular "
+        "level. In scan mode, number of frames is set to number of "
+        "steps.\n\t[Gotthard2] Burst mode has a maximum of 2720 frames.");
 
     INTEGER_COMMAND_NOID(triggers, getNumberOfTriggers, setNumberOfTriggers,
                          StringTo<int64_t>,