Documentation style guide

Sphinx Matlab Domain

The code is documented using Sphinx Matlab Domain. To build the documentation, cd to docs and run

make html

Then open docs/_build/index.html with a browser.

Title formatting

Use the following punctuation characters in the section titles:

• * for Chapters
• = for sections (“Heading 1”)
• - for subsections (“Heading 2”)
• ^ for subsubsections (“Heading 3”)
• " for paragraphs (“Heading 4”)

Templates

Object template

class ObjectTemplate(spec, varargin)

Bases: uot.Object

Template class for uot.Object.

Synopsis:

obj = uot.ObjectTemplate(spec,'param1',val1)

Description:

This class is intended as a starting point to develop classes that derive from uot.Object.

We can also itemize

• item 1
• item 2

Parameters:spec (uot.SpecTemplate) – Object specification Keyword Arguments:  ‘param1’ (uot.PCCloadSpec) – Parameter

Note

Possibly add a note here

Example:

object = uot.ObjectTemplate(uot.SpecTemplate())

See also

uot.SpecTemplate

Todo

• Write documentation

ComputeValue(arg_1)

Compute value based on current state

Synopsis:

val = object.ComputeValue()

Description:

Method description

We can also itemize

• item 1
• item 2

Parameters:arg_1 (double) – Argument 1 Returns:

• val_1 (double) - Val1
• val_2 (double) - Val2

Note

Possibly add a note here

Example:

val = object.ComputeValue(arg_1);

See also

uot.SpecTemplate

ObjectTemplate(spec, varargin)

Note: constructor does not have doc (it would repeat what is already in class)

prop_1 = None

Property 1 (double)

prop_2 = None

Property 2 (logical)

Spec template

class SpecTemplate(bus, varargin)

Bases: uot.Spec

Class to specify xx

Synopsis:

obj = uot.SpecTemplate(bus,varargin)

Description:

This class is intended as a starting point to develop classes that derive from uot.Spec.

We can also itemize

• item 1
• item 2

Parameters:bus (char) – Bus name Keyword Arguments:  ‘param1’ – Something.

Note

Possibly add a note here

Example:

object = uot.ObjectTemplate(uot.SpecTemplate())

See also

uot.ObjectTemplate

Todo

• Write documentation

SpecTemplate(bus, varargin)

Note: constructor does not have doc (it would repeat what is already in class)