<h1>
,
<h2>
and <h3>
should not be used, because they are utilized by
the automatically generated documentation.<h4>
and terminates with </h4>
, e.g.,
<h4>Description</h4>
<h4>
and <h5>
headings must not be terminated by a colon (:).<h5>
and </h5>
may be used as demonstrated below.The following parts should be added to the documentation of each component:
annotation(Documentation(revisions="..."));
These sections should appear in the listed order. The only exceptions are hierarchically structured notes and examples as explained in the following.
Some additional notes or examples may require additional <h5>
headings. For either notes or examples the following cases may be applied:
This is an example of a single note.
<h5>Note</h5> <p>This is the note.</p>
This is an example of a very simple structure.
<h5>Notes</h5> <p>This is the first note.</p> <p>This is the second note.</p>
This example shows a more complex structure with enumeration.
<h5>Note 1</h5> ... <h5>Note 2</h5> ...
For parameters, connectors, as well as inputs and outputs of function automatic documentation is generated by the tool from the quoted comments.