From fd664080dffcf4278eddd31ce7693880642dc770 Mon Sep 17 00:00:00 2001 From: Apelete Seketeli Date: Tue, 10 Oct 2023 11:04:29 +0200 Subject: [PATCH] Update documentation using doc strings Signed-off-by: Apelete Seketeli --- CI/gen_doc/docs/sysobjs.json | 89 ++++++++++++++++++++++++++---------- 1 file changed, 65 insertions(+), 24 deletions(-) diff --git a/CI/gen_doc/docs/sysobjs.json b/CI/gen_doc/docs/sysobjs.json index 7524757..667beda 100644 --- a/CI/gen_doc/docs/sysobjs.json +++ b/CI/gen_doc/docs/sysobjs.json @@ -5,7 +5,7 @@ "props": [ { "prop_name": "EnabledChannels", - "prop_title": " EnabledChannels Enabled Channels", + "prop_title": " EnabledChannels Enabled Channels", "prop_description": "Indexs of channels to be enabled. Input should be a [1xN] vector with the indexes of channels to be enabled. Order is irrelevant" }, { @@ -31,7 +31,7 @@ "props": [ { "prop_name": "EnabledChannels", - "prop_title": " EnabledChannels Enabled Channels", + "prop_title": " EnabledChannels Enabled Channels", "prop_description": "Indexs of channels to be enabled. Input should be a [1xN] vector with the indexes of channels to be enabled. Order is irrelevant" }, { @@ -62,7 +62,7 @@ }, { "prop_name": "EnabledChannels", - "prop_title": " EnabledChannels Enabled Channels", + "prop_title": " EnabledChannels Enabled Channels", "prop_description": "Indexs of channels to be enabled. Input should be a [1xN] vector with the indexes of channels to be enabled. Order is irrelevant" }, { @@ -88,23 +88,23 @@ "props": [ { "prop_name": "EnabledChannels", - "prop_title": " EnabledChannels Enabled Channels", + "prop_title": " EnabledChannels Enabled Channels", "prop_description": "Indexs of channels to be enabled. Input should be a [1xN] vector with the indexes of channels to be enabled. Order is irrelevant" }, { "prop_name": "SampleAveragingLength", - "prop_title": " SampleAveragingLength", - "prop_description": "Block length of samples to be averaged. Applied in the Averaging Mode register only when OUT_DATA_MD is set to 30-bit averaged differential modeHelp for adi.AD4030.Rx/SampleAveragingLength is inherited from superclass adi.AD463x.Base" + "prop_title": "SampleAveragingLength", + "prop_description": "Block length of samples to be averaged. Applied in the Averaging Mode register only when OUT_DATA_MD is set to 30-bit averaged differential mode" }, { "prop_name": "SampleRate", - "prop_title": " SampleRate Sample Rate", - "prop_description": "Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4030.Rx/SampleRate is inherited from superclass adi.AD463x.Base" + "prop_title": "SampleRate - Sample Rate", + "prop_description": "Baseband sampling rate in Hz, specified as a scalar in samples per second." }, { "prop_name": "SamplesPerFrame", - "prop_title": " SamplesPerFrame Samples Per Frame", - "prop_description": "Number of samples per frame, specified as an even positive integer.Help for adi.AD4030.Rx/SamplesPerFrame is inherited from superclass adi.AD463x.Base" + "prop_title": " Frame size", + "prop_description": "Size of the frame in samplesHelp for adi.AD4030.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base" }, { "prop_name": "uri", @@ -119,23 +119,23 @@ "props": [ { "prop_name": "EnabledChannels", - "prop_title": " EnabledChannels Enabled Channels", + "prop_title": " EnabledChannels Enabled Channels", "prop_description": "Indexs of channels to be enabled. Input should be a [1xN] vector with the indexes of channels to be enabled. Order is irrelevant" }, { "prop_name": "SampleAveragingLength", - "prop_title": " SampleAveragingLength", - "prop_description": "Block length of samples to be averaged. Applied in the Averaging Mode register only when OUT_DATA_MD is set to 30-bit averaged differential modeHelp for adi.AD4630_16.Rx/SampleAveragingLength is inherited from superclass adi.AD463x.Base" + "prop_title": "SampleAveragingLength", + "prop_description": "Block length of samples to be averaged. Applied in the Averaging Mode register only when OUT_DATA_MD is set to 30-bit averaged differential mode" }, { "prop_name": "SampleRate", - "prop_title": " SampleRate Sample Rate", - "prop_description": "Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4630_16.Rx/SampleRate is inherited from superclass adi.AD463x.Base" + "prop_title": "SampleRate - Sample Rate", + "prop_description": "Baseband sampling rate in Hz, specified as a scalar in samples per second." }, { "prop_name": "SamplesPerFrame", - "prop_title": " SamplesPerFrame Samples Per Frame", - "prop_description": "Number of samples per frame, specified as an even positive integer.Help for adi.AD4630_16.Rx/SamplesPerFrame is inherited from superclass adi.AD463x.Base" + "prop_title": " Frame size", + "prop_description": "Size of the frame in samplesHelp for adi.AD4630_16.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base" }, { "prop_name": "uri", @@ -150,23 +150,23 @@ "props": [ { "prop_name": "EnabledChannels", - "prop_title": " EnabledChannels Enabled Channels", + "prop_title": " EnabledChannels Enabled Channels", "prop_description": "Indexs of channels to be enabled. Input should be a [1xN] vector with the indexes of channels to be enabled. Order is irrelevant" }, { "prop_name": "SampleAveragingLength", - "prop_title": " SampleAveragingLength", - "prop_description": "Block length of samples to be averaged. Applied in the Averaging Mode register only when OUT_DATA_MD is set to 30-bit averaged differential modeHelp for adi.AD4630_24.Rx/SampleAveragingLength is inherited from superclass adi.AD463x.Base" + "prop_title": "SampleAveragingLength", + "prop_description": "Block length of samples to be averaged. Applied in the Averaging Mode register only when OUT_DATA_MD is set to 30-bit averaged differential mode" }, { "prop_name": "SampleRate", - "prop_title": " SampleRate Sample Rate", - "prop_description": "Baseband sampling rate in Hz, specified as a scalar in samples per second.Help for adi.AD4630_24.Rx/SampleRate is inherited from superclass adi.AD463x.Base" + "prop_title": "SampleRate - Sample Rate", + "prop_description": "Baseband sampling rate in Hz, specified as a scalar in samples per second." }, { "prop_name": "SamplesPerFrame", - "prop_title": " SamplesPerFrame Samples Per Frame", - "prop_description": "Number of samples per frame, specified as an even positive integer.Help for adi.AD4630_24.Rx/SamplesPerFrame is inherited from superclass adi.AD463x.Base" + "prop_title": " Frame size", + "prop_description": "Size of the frame in samplesHelp for adi.AD4630_24.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base" }, { "prop_name": "uri", @@ -174,5 +174,46 @@ "prop_description": "Hostname or IP address of remote libIIO deviceHelp for adi.AD4630_24.Rx/uri is inherited from superclass matlabshared.libiio.base" } ] + }, + { + "name": "adi.AD4020.Rx", + "dec": " adi.AD4020.Rx Receives data from the AD4020 ADC
The adi.AD4020.Rx System object is a signal source that can receive
data from the AD4020.

rx = adi.AD4020.Rx;
rx = adi.AD4020.Rx('uri','192.168.2.1');

AD4020 Datasheet
Documentation for adi.AD4020.Rx
doc adi.AD4020.Rx
", + "props": [ + { + "prop_name": "EnabledChannels", + "prop_title": " EnabledChannels Enabled Channels", + "prop_description": "Indexs of channels to be enabled. Input should be a [1xN] vector with the indexes of channels to be enabled. Order is irrelevant" + }, + { + "prop_name": "SamplesPerFrame", + "prop_title": " Frame size", + "prop_description": "Size of the frame in samplesHelp for adi.AD4020.Rx/SamplesPerFrame is inherited from superclass matlabshared.libiio.base" + }, + { + "prop_name": "SamplingFrequency", + "prop_title": " SamplingFrequency", + "prop_description": "Sampling Frequency in Hertz." + }, + { + "prop_name": "Voltage", + "prop_title": " Voltage", + "prop_description": "ADC Voltage in mV" + }, + { + "prop_name": "VoltageOffset", + "prop_title": " VoltageOffset Voltage Offset", + "prop_description": "ADC Voltage offset." + }, + { + "prop_name": "VoltageScale", + "prop_title": " VoltageScale Voltage Scale", + "prop_description": "ADC Voltage scale." + }, + { + "prop_name": "uri", + "prop_title": " URI - remote host URI", + "prop_description": "Hostname or IP address of remote libIIO deviceHelp for adi.AD4020.Rx/uri is inherited from superclass matlabshared.libiio.base" + } + ] } ] \ No newline at end of file