Documentation annotations
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 all elements of CIF specifications that support annotations.
The annotation has the following constraints, in addition to the general constraints that apply to all annotations:
-
The annotation must have at least one argument.
-
All arguments must be unnamed arguments.
-
All arguments must have a
string-typed value. -
It must be possible for the argument values to be statically evaluated.
-
Evaluation of the argument values must not result in an evaluation error.