Skip to content

Commit

Permalink
Update documentation using doc strings
Browse files Browse the repository at this point in the history 
Signed-off-by: Apelete Seketeli <[email protected]>
  • Loading branch information
@apelete @ribdp
apelete authored and ribdp committed Oct 10, 2023
1 parent 58b10df commit b8e990c
Showing 1 changed file with 65 additions and 24 deletions.
89 changes: 65 additions & 24 deletions CI/gen_doc/docs/sysobjs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
{
Expand All @@ -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"
},
{
Expand Down Expand Up @@ -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"
},
{
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -150,29 +150,70 @@
"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",
"prop_title": " URI - remote host URI",
"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<br> The adi.AD4020.Rx System object is a signal source that can receive<br> data from the AD4020.<br> <br> rx = adi.AD4020.Rx;<br> rx = adi.AD4020.Rx('uri','192.168.2.1');<br> <br> <a href=\"https://www.analog.com/media/en/technical-documentation/data-sheets/ad4020-4021-4022.pdf\">AD4020 Datasheet</a><br> Documentation for adi.AD4020.Rx<br> doc adi.AD4020.Rx<br>",
"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"
}
]
}
]

0 comments on commit b8e990c

Please sign in to comment.