Overview
Below you will find an overview of the markups that are needed for documentation creation.
Normal form | Abbreviated form | Context | Description |
|---|---|---|---|
<description> </description> | @description |
| Text section marked as description. |
<summary> </summary> | @summary |
| Text section marked as summary. |
<example> </example> | @example |
| Text section formatted as an example. |
<h1> </h1> - <h6> </h6> | - | description, summary, example | Headings up to level 6 |
<code> </code> | @code | description, summary, example | Section with source code |
<literal> </literal> | @literal | description, summary, example | Plain text that is not to be interpreted. |
- | $crossreference | description, summary, example | Cross-reference |
<see uri=“”> </see> | @see | description, summary, example | Link within a section of text |
<seealso uri=“”> </seealso> | @seealso | description, summary, example | Link outside any text section |
<param name=“”> </param> | @param |
| Parameter value |
<ul> </ul> | @ul | description, summary, example | Defines an unordered list. |
<ol> </ol> | @ol | description, summary, example | Defines a numbered list. |
<li> </li> | - | description, summary, example | Element of a list |
<table> </table> | - | description, summary, example | Defines a table similar to HTML. |
<th> </th> | - | description, summary, example | Creates a table with header. |
<tr> </tr> | - | description, summary, example | Creates a table row. |
<td> </td> | - | description, summary, example | Creates a table column. |
<audience> </audience> | - |
| Defines a user group for the selected text section. |
<preliminary></preliminary> | @preliminary |
| Marks a section as needing to be changed. |
<note type=“”> </note> | - | description, summary, example | Defines safety instructions (Danger, Warning, Note). |
<image uri=""></image> | - | description, summary, example | Includes an image. |