A list of authors.
A list of authors. The empty list is used when no author is defined.
The main body of the comment that describes what the entity does and is.
A description for the primary constructor
Whether the entity is deprecated.
Whether the entity is deprecated. Using the @deprecated
Scala attribute
is prefereable to using this Scaladoc tag.
A usage example related to the entity.
An additional note concerning the contract of the entity.
A description of the result of the entity.
A description of the result of the entity. Typically, this provides additional information on the domain of the result, contractual post-conditions, etc.
A list of other resources to see, including links to other entities or to external documentation.
A list of other resources to see, including links to other entities or to external documentation. The empty list is used when no other resource is mentionned.
A version number of a containing entity where this member-entity was introduced.
The comment as it appears in the source text.
A map of exceptions that the entity can throw when accessed, and a description of what they mean.
An annotation as to expected changes on this entity.
A map of type parameters, and a description of what they are.
A map of type parameters, and a description of what they are. Typically, this provides additional information on the domain of the parameters.
A map of value parameters, and a description of what they are.
A map of value parameters, and a description of what they are. Typically, this provides additional information on the domain of the parameters, contractual pre-conditions, etc.
The version number of the entity.
The version number of the entity. There is no formatting or further meaning attached to this value.
A shorter version of the body.
A shorter version of the body. Usually, this is the first sentence of the body.
A Scaladoc comment and all its tags.
Note: the only instantiation site of this class is in CommentFactory.