.ModelicaReference.Annotations.DocumentationClass

Information

Annotation for defining documentation classes

Syntax

documentation class_annotation:
   annotation"(" DocumentationClass "=" true ")"

Description

Only allowed as class annotation on any kind of class and implies that this class and all classes within it are treated as having the annotation preferredView="info". If the annotation preferredView is explicitly set for a class, it has precedence over a DocumentationClass annotation.

[A tool may display such classes in special ways. For example, the description texts of the classes might be displayed instead of the class names, and if no icon is defined, a special information default icon may be displayed in the package browser.]