Descriptors

ISDM descriptors

Descriptors let you identify which part of the documentation you are about to write.

Syntax

DESCRIPTOR:
{CONTENT}

A generic descriptor declaration.

Descriptors are always uppercase single-word declarations ending with a colon.
After the descriptor you must write it's content, beginning from the line immediately below. Everything is treated as content until the parser finds another descriptor or reaches the end of the documentation comment. All the tabulations and spaces at the beginning or ending of each line are automatically removed.

The ARGUMENTS descriptor has it's own internal syntax, in order to provide a more powerful way to describe arguments.

Descriptors list

Here is the list of all the available descriptors:

Descriptor	Syntax	Available from version	Status
DESCRIPTION	open	1.0	available
ARGUMENTS	strict	1.0	available
NOTES	open	1.0	available
TODO	open	1.0	available