Represents an unknown tag
Provide author information for the following entity
Placed in the class comment will describe the primary constructor
Allows use of
Allows use of
label
in other Scaladoc comments within the same source file which will be expanded to the contents of
definition
.
definition }}}
label }}} be expanded to the contents of
definition
.
definition }}}
Marks an entity as deprecated, describing replacement implementation
Expand a type alias and abstract type into a full template page
Provide example code and related descriptions.
Mark the entity as member of a group
Add optional descriptive text to display under the group name
Provide an optional name for the group
Control the order of the group on the page
Take comments from a superclass as defaults if comments are not provided locally
Like Deprecated but provides advanced warning of planned changes ahead of deprecation.
Add a note for pre or post conditions, or any other notable restrictions or expectations
Detail a value parameter for a method or constructor
Detail the return value from a method
Reference other sources of information like external document links or related entities in the documentation
The version of the system or API that this entity was first defined in
What exceptions (if any) the method or constructor may throw
Documents unimplemented features in an entity
Detail a type parameter for a method, constructor or class
Provide a simplified method definition for when the full method definition is too complex or noisy
The version of the system or API that this entity is a part of
Contains all known tags