doc update, 1st trial

This commit is contained in:
maliakal_d 2020-08-19 16:37:21 +02:00
parent 096b0c424d
commit 9bae97ec4c
2 changed files with 17 additions and 1 deletions

View File

@ -985,6 +985,14 @@ class Detector(CppDetectorApi):
@property
def adcphase(self):
"""[Gotthard][Jungfrau][CTB][Moench] Sets phase shift of ADC clock.
Note
-----
| [Jungfrau] Absolute phase shift. Changing Speed also resets adcphase to recommended defaults.
| [Ctb][Moench] Absolute phase shift. Changing adcclk also resets adcphase and sets it to previous values.
| [Gotthard] Relative phase shift.
"""
return element_if_equal(self.getADCPhase())
@adcphase.setter
@ -1001,6 +1009,8 @@ class Detector(CppDetectorApi):
@property
def adcclk(self):
"""[Ctb][Moench] Sets ADC clock frequency in MHz.
"""
return element_if_equal(self.getADCClock())
@adcclk.setter

View File

@ -241,7 +241,13 @@ class Detector {
/** [Gotthard][Jungfrau][CTB][Moench] */
Result<int> getADCPhase(Positions pos = {}) const;
/** [Gotthard][Jungfrau][CTB][Moench] */
/** [Gotthard][Jungfrau][CTB][Moench]
* [Jungfrau] Absolute phase shift. Changing Speed also resets adcphase to
* recommended defaults. \n
* [Ctb][Moench] Absolute phase shift. Changing adcclk also resets adcphase
* and sets it to previous values. \n
* [Gotthard] Relative phase shift
*/
void setADCPhase(int value, Positions pos = {});
/** [Jungfrau][CTB][Moench] */