Update documentation using doc strings

Signed-off-by: Apelete Seketeli <[email protected]>
analogdevicesinc · Oct 13, 2023 · 58dda4b · 58dda4b
1 parent 4250f1c
commit 58dda4b
Showing 1 changed file with 55 additions and 19 deletions.
diff --git a/CI/gen_doc/docs/sysobjs.json b/CI/gen_doc/docs/sysobjs.json
@@ -93,18 +93,18 @@
       },
       {
         "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",
@@ -124,18 +124,18 @@
       },
       {
         "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",
@@ -155,18 +155,18 @@
       },
       {
         "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",
@@ -200,5 +200,41 @@
         "prop_description": "Hostname or IP address of remote libIIO deviceHelp for adi.AD4858.Rx/uri is inherited from superclass matlabshared.libiio.base"
       }
     ]
+  },
+  {
+    "name": "adi.AD2S1210.Rx",
+    "dec": "  adi.AD2S1210.Rx Receives data from the AD2S1210 Resolver<br>    The adi.AD2S1210.Rx System object is a signal source that can receive<br>    data from the AD2S1210.<br> <br>    rx = adi.AD2S1210.Rx;<br>    rx = adi.AD2S1210.Rx('uri','192.168.2.1');<br> <br>    <a href=\"https://www.analog.com/media/en/technical-documentation/data-sheets/ad2s1210.pdf\">AD2S1210 Datasheet</a><br>    Documentation for adi.AD2S1210.Rx<br>       doc adi.AD2S1210.Rx<br>",
+    "props": [
+      {
+        "prop_name": "Angle",
+        "prop_title": "  Angle",
+        "prop_description": "Resolver angle in Degrees."
+      },
+      {
+        "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": "Resolution",
+        "prop_title": "  Resolution",
+        "prop_description": "Resolver resolution in bits."
+      },
+      {
+        "prop_name": "SamplesPerFrame",
+        "prop_title": "  SamplesPerFrame Samples Per Frame",
+        "prop_description": "Number of samples per frame, specified as an even positive integer."
+      },
+      {
+        "prop_name": "Velocity",
+        "prop_title": "  Velocity Angular Velocity",
+        "prop_description": "Resolver velocity in revolutions per second."
+      },
+      {
+        "prop_name": "uri",
+        "prop_title": "  URI - remote host URI",
+        "prop_description": "Hostname or IP address of remote libIIO deviceHelp for adi.AD2S1210.Rx/uri is inherited from superclass matlabshared.libiio.base"
+      }
+    ]
   }
-]
+]