Markups

The following chapter is about the markups that are used to create the documentation. The markups used for documentation creation are XML-based.

Example

//!<description> This is a description. </description>

Abbreviated forms of the tags

If a documentation element has only the length of one line, the abbreviated form can be used. In this form, the XML tags are written without square brackets and closing elements. Instead of brackets, a leading @ is used to mark the tags.

Example

Normal form:

//!<summary> Summary by using normal form </summary>

Abbreviated form:

//!@summary Summary by using the abbreviated form