Documentation annotations

> > > >

Annotations are currently an experimental work-in-progress language feature. Their design may change in a backward incompatible manner.

Documentation annotations can be used to add documentation to CIF elements. For basic information on documentation annotations, see the language tutorial. Here we discuss further details.

Documentation annotations (@doc) can be added to the following elements in CIF specifications:

Algebraic variables.
Constants.
Continuous variables.
Discrete variables.
Input variables.
Locations of automata.

The annotation has the following additional constraints, in addition to the general constraints that apply to all annotations:

The annotation must have exactly one argument, named text. Since text is a keyword in the CIF language, it must be escaped to $text.
The text argument must have a string-typed value.
It must be possible for the value to be statically evaluated.
Evaluation of the value must not result in an evaluation error.