Skip to content
Snippets Groups Projects
Commit 7cbd6013 authored by Tim Stadtmann's avatar Tim Stadtmann
Browse files

Test some documentation inline formats

parent b8547226
Branches
Tags
No related merge requests found
......@@ -18,19 +18,26 @@ classdef EV3 < MaskedHandle
% sensor2 (Sensor): Motor-object interfacing port 2
% sensor3 (Sensor): Motor-object interfacing port 3
% sensor4 (Sensor): Motor-object interfacing port 4
% debug (numeric in {0,1,2}): Debug mode. [WRITABLE]
% * 0: Debug turned off
% * 1: (High-level-) Debug turned on for EV3-object - enables feedback in the
% console about what firmware-commands have been called when using a method
% * 2: Low-level-Debug turned on - each packet sent and received is printed to the
% console
% debug (numeric in {0,1,2}): Debug mode. [**WRITABLE**]
%
% - 0: Debug turned off
% - 1: Debug turned on for EV3-object -> enables feedback in the console about what firmware-commands have been called when using a method
% - 2: Low-level-Debug turned on - each packet sent and received is printed to the console
%
% batteryMode (string in {'Percentage', 'Voltage'}): Mode for reading battery charge.
% [WRITABLE]
% [**WRITABLE**]
% batteryValue (numeric): Current battery charge. Depending on batteryMode, the reading
% is either in percentage or voltage. [READ-ONLY]
% isConnected (bool): True if virtual brick-object is connected to physical one. [READ-ONLY]
% is either in percentage or voltage. [**READ-ONLY**]
% isConnected (bool): True if virtual brick-object is connected to physical one. [**READ-ONLY**]
%
% Examples:
% b = EV3(); |br|
% b.connect('usb'); |br|
% ma = b.motorA; |br|
% ma.start(); |br|
% % fun |br|
% ma.stop(); |br|
% delete b; |br|
properties
% batteryMode (string in {'Percentage', 'Voltage'}): Mode for reading battery charge. [WRITABLE]
......@@ -38,10 +45,10 @@ classdef EV3 < MaskedHandle
batteryMode;
% debug (numeric in {0,1,2}): Debug mode. [WRITABLE]
% * 0: Debug turned off
% * 1: (High-level-) Debug turned on for EV3-object - enables feedback in the
% - 0: Debug turned off
% - 1: (High-level-) Debug turned on for EV3-object - enables feedback in the
% console about what firmware-commands have been called when using a method
% * 2: Low-level-Debug turned on - each packet sent and received is printed to the
% - 2: Low-level-Debug turned on - each packet sent and received is printed to the
% console
debug;
end
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment