Skip to content

Commit

Permalink
docs: Add fixes for all drivers
Browse files Browse the repository at this point in the history 
Signed-off-by: RibhuDP <[email protected]>
  • Loading branch information
@ribdp
ribdp committed Apr 2, 2024
1 parent 42f12c3 commit 52b803f
Show file tree
Hide file tree
Showing 31 changed files with 183 additions and 159 deletions.
11 changes: 6 additions & 5 deletions +adi/+AD2S1210/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.common.Rx & matlabshared.libiio.base & adi.common.Attribute
% AD2S1210 Resolver-to-Digital Converter Class
%
% adi.AD2S1210.Rx Receives data from the AD2S1210 Resolver
% The adi.AD2S1210.Rx System object is a signal source that can receive
% data from the AD2S1210.
% The adi.AD2S1210.Rx System object is a signal source that can receive
% data from the AD2S1210.
%
% rx = adi.AD2S1210.Rx;
% rx = adi.AD2S1210.Rx('uri','192.168.2.1');
% `rx = adi.AD2S1210.Rx;`
% `rx = adi.AD2S1210.Rx('uri','192.168.2.1');`
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad2s1210.pdf">AD2S1210 Datasheet</a>
% `AD2S1210 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad2s1210.pdf>`_

properties (Nontunable)
% SamplesPerFrame Samples Per Frame
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4000/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute
% AD4000 Precision ADC Class
%
% adi.AD4000.Rx Receives data from the AD4000 ADC
% The adi.AD4000.Rx System object is a signal source that can receive
% data from the AD4000.
% The adi.AD4000.Rx System object is a signal source that can receive
% data from the AD4000.
%
% rx = adi.AD4000.Rx;
% rx = adi.AD4000.Rx('uri','192.168.2.1');
% `rx = adi.AD4000.Rx;`
% `rx = adi.AD4000.Rx('uri','192.168.2.1');`
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4000-4004-4008.pdf">AD4000 Datasheet</a>
% `AD4000 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4000-4004-4008.pdf>`_

methods
%% Constructor
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4001/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute
% AD4001 Precision ADC Class
%
% adi.AD4001.Rx Receives data from the AD4001 ADC
% The adi.AD4001.Rx System object is a signal source that can receive
% data from the AD4001.
% The adi.AD4001.Rx System object is a signal source that can receive
% data from the AD4001.
%
% rx = adi.AD4001.Rx;
% rx = adi.AD4001.Rx('uri','192.168.2.1');
% `rx = adi.AD4001.Rx;`
% `rx = adi.AD4001.Rx('uri','192.168.2.1');`
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4001-4005.pdf">AD4001 Datasheet</a>
% `AD4001 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4001-4005.pdf>`_

methods
%% Constructor
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4002/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute
% AD4002 Precision ADC Class
%
% adi.AD4002.Rx Receives data from the AD4002 ADC
% The adi.AD4002.Rx System object is a signal source that can receive
% data from the AD4002.
% The adi.AD4002.Rx System object is a signal source that can receive
% data from the AD4002.
%
% rx = adi.AD4002.Rx;
% rx = adi.AD4002.Rx('uri','192.168.2.1');
% `rx = adi.AD4002.Rx;`
% `rx = adi.AD4002.Rx('uri','192.168.2.1');`
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4002-4006-4010.pdf">AD4002 Datasheet</a>
% `AD4002 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4002-4006-4010.pdf>`_

methods
%% Constructor
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4003/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute
% AD4003 Precision ADC Class
%
% adi.AD4003.Rx Receives data from the AD4003 ADC
% The adi.AD4003.Rx System object is a signal source that can receive
% data from the AD4003.
% The adi.AD4003.Rx System object is a signal source that can receive
% data from the AD4003.
%
% rx = adi.AD4003.Rx;
% rx = adi.AD4003.Rx('uri','192.168.2.1');
% `rx = adi.AD4003.Rx;`
% `rx = adi.AD4003.Rx('uri','192.168.2.1');`
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4003-4007-4011.pdf">AD4003 Datasheet</a>
% `AD4003 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4003-4007-4011.pdf>`_

methods
%% Constructor
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4004/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute
% AD4004 Precision ADC Class
%
% adi.AD4004.Rx Receives data from the AD4004 ADC
% The adi.AD4004.Rx System object is a signal source that can receive
% data from the AD4004.
% The adi.AD4004.Rx System object is a signal source that can receive
% data from the AD4004.
%
% rx = adi.AD4004.Rx;
% rx = adi.AD4004.Rx('uri','192.168.2.1');
% `rx = adi.AD4004.Rx;`
% `rx = adi.AD4004.Rx('uri','192.168.2.1');`
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4000-4004-4008.pdf">AD4004 Datasheet</a>
% `AD4004 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4000-4004-4008.pdf>`_

methods
%% Constructor
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4005/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute
% AD4005 Precision ADC Class
%
% adi.AD4005.Rx Receives data from the AD4005 ADC
% The adi.AD4005.Rx System object is a signal source that can receive
% data from the AD4005.
% The adi.AD4005.Rx System object is a signal source that can receive
% data from the AD4005.
%
% rx = adi.AD4005.Rx;
% rx = adi.AD4005.Rx('uri','192.168.2.1');
% `rx = adi.AD4005.Rx;`
% `rx = adi.AD4005.Rx('uri','192.168.2.1');`
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4001-4005.pdf">AD4005 Datasheet</a>
% `AD4005 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4001-4005.pdf>`_

methods
%% Constructor
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4006/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute
% AD4006 Precision ADC Class
%
% adi.AD4006.Rx Receives data from the AD4006 ADC
% The adi.AD4006.Rx System object is a signal source that can receive
% data from the AD4006.
% The adi.AD4006.Rx System object is a signal source that can receive
% data from the AD4006.
%
% rx = adi.AD4006.Rx;
% rx = adi.AD4006.Rx('uri','192.168.2.1');
% `rx = adi.AD4006.Rx;`
% `rx = adi.AD4006.Rx('uri','192.168.2.1');`
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4002-4006-4010.pdf">AD4006 Datasheet</a>
% `AD4006 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4002-4006-4010.pdf>`_

methods
%% Constructor
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4007/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute
% AD4007 Precision ADC Class
%
% adi.AD4007.Rx Receives data from the AD4007 ADC
% The adi.AD4007.Rx System object is a signal source that can receive
% data from the AD4007.
% The adi.AD4007.Rx System object is a signal source that can receive
% data from the AD4007.
%
% rx = adi.AD4007.Rx;
% rx = adi.AD4007.Rx('uri','192.168.2.1');
% `rx = adi.AD4007.Rx;`
% `rx = adi.AD4007.Rx('uri','192.168.2.1');`
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4003-4007-4011.pdf">AD4007 Datasheet</a>
% `AD4007 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4003-4007-4011.pdf>`_

methods
%% Constructor
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4008/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute
% AD4008 Precision ADC Class
%
% adi.AD4008.Rx Receives data from the AD4008 ADC
% The adi.AD4008.Rx System object is a signal source that can receive
% data from the AD4008.
% The adi.AD4008.Rx System object is a signal source that can receive
% data from the AD4008.
%
% rx = adi.AD4008.Rx;
% rx = adi.AD4008.Rx('uri','192.168.2.1');
% `rx = adi.AD4008.Rx;`
% `rx = adi.AD4008.Rx('uri','192.168.2.1');`
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4000-4004-4008.pdf">AD4008 Datasheet</a>
% `AD4008 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4000-4004-4008.pdf>`_

methods
%% Constructor
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4010/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute
% AD4010 Precision ADC Class
%
% adi.AD4010.Rx Receives data from the AD4010 ADC
% The adi.AD4010.Rx System object is a signal source that can receive
% data from the AD4010.
% The adi.AD4010.Rx System object is a signal source that can receive
% data from the AD4010.
%
% rx = adi.AD4010.Rx;
% rx = adi.AD4010.Rx('uri','192.168.2.1');
% `rx = adi.AD4010.Rx;`
% `rx = adi.AD4010.Rx('uri','192.168.2.1');`
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4002-4006-4010.pdf">AD4010 Datasheet</a>
% `AD4010 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4002-4006-4010.pdf>`_

methods
%% Constructor
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4011/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute
% AD4011 Precision ADC Class
%
% adi.AD4011.Rx Receives data from the AD4011 ADC
% The adi.AD4011.Rx System object is a signal source that can receive
% data from the AD4011.
% The adi.AD4011.Rx System object is a signal source that can receive
% data from the AD4011.
%
% rx = adi.AD4011.Rx;
% rx = adi.AD4011.Rx('uri','192.168.2.1');
% `rx = adi.AD4011.Rx;`
% `rx = adi.AD4011.Rx('uri','192.168.2.1');`
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4003-4007-4011.pdf">AD4011 Datasheet</a>
% `AD4011 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4003-4007-4011.pdf>`_

methods
%% Constructor
Expand Down
7 changes: 4 additions & 3 deletions +adi/+AD4020/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute
% AD4020 Precision ADC Class
%
% 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.
% 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');
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4020-4021-4022.pdf">AD4020 Datasheet</a>
% `AD4020 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4020-4021-4022.pdf>`_

methods
%% Constructor
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4021/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute
% AD4021 Precision ADC Class
%
% adi.AD4021.Rx Receives data from the AD4021 ADC
% The adi.AD4021.Rx System object is a signal source that can receive
% data from the AD4021.
% The adi.AD4021.Rx System object is a signal source that can receive
% data from the AD4021.
%
% rx = adi.AD4021.Rx;
% rx = adi.AD4021.Rx('uri','192.168.2.1');
% `rx = adi.AD4021.Rx;`
% `rx = adi.AD4021.Rx('uri','192.168.2.1');`
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4020-4021-4022.pdf">AD4021 Datasheet</a>
% `AD4021 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4020-4021-4022.pdf>`_

methods
%% Constructor
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4022/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.AD400x.Base & matlabshared.libiio.base & adi.common.Attribute
% AD4022 Precision ADC Class
%
% adi.AD4022.Rx Receives data from the AD4022 ADC
% The adi.AD4022.Rx System object is a signal source that can receive
% data from the AD4022.
% The adi.AD4022.Rx System object is a signal source that can receive
% data from the AD4022.
%
% rx = adi.AD4022.Rx;
% rx = adi.AD4022.Rx('uri','192.168.2.1');
% `rx = adi.AD4022.Rx;`
% `rx = adi.AD4022.Rx('uri','192.168.2.1');`
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4020-4021-4022.pdf">AD4022 Datasheet</a>
% `AD4022 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4020-4021-4022.pdf>`_

methods
%% Constructor
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4030/Rx.m
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@
& adi.AD463x.Base

% AD4030-24 Precision ADC Class
%
% adi.AD4030.Rx Receives data from the AD4030-24 ADC
% The adi.AD4030.Rx System object is a signal source that can receive
% data from the AD4030-24.
% The adi.AD4030.Rx System object is a signal source that can receive
% data from the AD4030-24.
%
% rx = adi.AD4030.Rx;
% rx = adi.AD4030.Rx('uri','192.168.2.1');
% `rx = adi.AD4030.Rx;`
% `rx = adi.AD4030.Rx('uri','192.168.2.1');`
%
% <a href="http://www.analog.com/media/en/technical-documentation/data-sheets/AD4030-24.pdf">AD4030-24 Datasheet</a>
% `AD4030-24 Datasheet <http://www.analog.com/media/en/technical-documentation/data-sheets/AD4030-24.pdf>`_

properties (Nontunable, Hidden, Constant)
Type = 'Rx'
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4630_16/Rx.m
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@
& adi.AD463x.Base

% AD4630-16 Precision ADC Class
%
% adi.AD4630_16.Rx Receive data from the AD4630-16 ADC
% The adi.AD4630_16.Rx System object is a signal source that can receive
% data from the AD4630-16.
% The adi.AD4630_16.Rx System object is a signal source that can receive
% data from the AD4630-16.
%
% rx = adi.AD4630_16.Rx;
% rx = adi.AD4630_16.Rx('uri','192.168.2.1');
% `rx = adi.AD4630_16.Rx;`
% `rx = adi.AD4630_16.Rx('uri','192.168.2.1');`
%
% <a href="http://www.analog.com/media/en/technical-documentation/data-sheets/AD4630-16.pdf">AD4630-16 Datasheet</a>
% `AD4630-16 Datasheet <http://www.analog.com/media/en/technical-documentation/data-sheets/AD4630-16.pdf>`_

properties (Nontunable, Hidden, Constant)
Type = 'Rx'
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4630_24/Rx.m
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@
& adi.AD463x.Base

% AD4630-24 Precision ADC Class
%
% adi.AD4630_24.Rx Receive data from the AD4630-24 ADC
% The adi.AD4630_24.Rx System object is a signal source that can receive
% data from the AD4630-24.
% The adi.AD4630_24.Rx System object is a signal source that can receive
% data from the AD4630-24.
%
% rx = adi.AD4630_24.Rx;
% rx = adi.AD4630_24.Rx('uri','192.168.2.1');
% `rx = adi.AD4630_24.Rx;`
% `rx = adi.AD4630_24.Rx('uri','192.168.2.1');`
%
% <a href="http://www.analog.com/media/en/technical-documentation/data-sheets/AD4630-24.pdf">AD4630-24 Datasheet</a>
% `AD4630-24 Datasheet <http://www.analog.com/media/en/technical-documentation/data-sheets/AD4630-24.pdf>`_

properties (Nontunable, Hidden, Constant)
Type = 'Rx'
Expand Down
11 changes: 6 additions & 5 deletions +adi/+AD4858/Rx.m
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
classdef Rx < adi.common.Rx & matlabshared.libiio.base & adi.common.Attribute
% AD4858 Precision ADC Class
%
% adi.AD4858.Rx Receives data from the AD4858 ADC
% The adi.AD4858.Rx System object is a signal source that can receive
% data from the AD4858.
% The adi.AD4858.Rx System object is a signal source that can receive
% data from the AD4858.
%
% rx = adi.AD4858.Rx;
% rx = adi.AD4858.Rx('uri','192.168.2.1');
% `rx = adi.AD4858.Rx;`
% `rx = adi.AD4858.Rx('uri','192.168.2.1');`
%
% <a href="https://www.analog.com/media/en/technical-documentation/data-sheets/ad4858.pdf">AD4858 Datasheet</a>
% `AD4858 Datasheet <https://www.analog.com/media/en/technical-documentation/data-sheets/ad4858.pdf>`_

properties (Nontunable)
% SampleRate Sample Rate
Expand Down
Loading

0 comments on commit 52b803f

Please sign in to comment.