class Structure "Structure"
extends Modelica.Icons.Information;
annotation (Documentation(info = "<html>\n\n<h4>General</h4>\n\n<ol>\n<li> In the HTML documentation of any Modelica library, the headings <code><h1></code>,\n <code><h2></code> and <code><h3></code> should not be used, because they are utilized by\n the automatically generated documentation.</li>\n<li> The utilized heading format starts with <code><h4></code> and terminates with <code></h4></code>, e.g.,\n <code><h4>Description</h4></code></li>\n<li> The <code><h4></code> and <code><h5></code> headings must not be terminated by a colon (:).</li>\n<li> For additional structuring <code><h5></code> and <code></h5></code> may be used as demonstrated below.</li>\n</ol>\n\n<h4>Structure</h4>\n<p>\nThe following parts should be added to the documentation of each component:\n</p>\n\n<ol>\n<li> General information without additional subsection explains how the class works</li>\n<li> <strong>Syntax</strong> (for functions only): shows syntax of function call with minimum and full input parameters</li>\n<li> <strong>Implementation</strong> (optional): explains how the implementation is made</li>\n<li> <strong>Limitations</strong> (optional): explains the limitations of the component</li>\n<li> <strong>Notes</strong> (optional): if required/useful</li>\n<li> <strong>Examples</strong> (optional): if required/useful</li>\n<li> <strong>Acknowledgments</strong> (optional): if required</li>\n<li> <strong>See also</strong>: shows hyperlinks to related models</li>\n<li> <strong>Revision history</strong> (optional): if required/intended for a package/model, the revision history\n should be placed in <code>annotation(Documentation(revisions="..."));</code></li>\n</ol>\n\n<p>\nThese sections should appear in the listed order. The only exceptions are hierarchically structured notes and examples as explained in the following.\n</p>\n\n<h4>Additional notes and examples</h4>\n\n<p>Some additional notes or examples may require additional <code><h5></code> headings. For either notes or examples the following cases may be applied:</p>\n\n<h5>Example 1</h5>\n<p>\nThis is an example of a single note.\n</p>\n\n<pre>\n<h5>Note</h5>\n<p>This is the note.</p>\n</pre>\n\n<h5>Example 2</h5>\n<p>\nThis is an example of a very simple structure.\n</p>\n\n<pre>\n<h5>Notes</h5>\n<p>This is the first note.</p>\n<p>This is the second note.</p>\n</pre>\n\n<h5>Example 3</h5>\n\n<p>\nThis example shows a more complex structure with enumeration.\n</p>\n\n<pre>\n<h5>Note 1</h5>\n...\n<h5>Note 2</h5>\n...\n</pre>\n<h4>Automatically created documentation</h4>\n<p>\nFor parameters, connectors, as well as inputs and outputs of function automatic documentation is generated by the tool from the quoted comments.\n</p>\n</html>"));
end Structure;