Documents a Scaladoc Heading.
Represents a documentation remark.
Represents an documentation code reference.
Represents a labeled documentation remark.
Document an entity to one author.
Represents an scaladoc code block.
Placed in the class comment will describe the primary constructor.
Marks an entity as deprecated.
Marks an entity as deprecated. The message should describe replacement implementation.
Documents an untagged scaladoc description.
Expand a type alias and abstract type into a full template page.
Provides example code and related descriptions.
Marks the entity as member of the body group.
Adds an 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.
Control the order of the group on the page. Defaults to 0. Ungrouped elements have an implicit priority of 1000. Use a value between 0 and 999 to set a relative position to other groups. Low values will appear before high values.
Represents a first level heading:
Represents a first level heading:
i.e: '=HEADING='
Represents a second level heading:
Represents a second level heading:
i.e: '==HEADING=='
Represents a third level heading:
Represents a third level heading:
i.e: '===HEADING==='
Represents a fourth level heading:
Represents a fourth level heading:
i.e: '====HEADING===='
Represents a fifth level heading:
Represents a fifth level heading:
i.e: '=====HEADING====='
Represents a sixth level heading:
Represents a sixth level heading:
i.e: '======HEADING======'
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.
Documents pre- and post-conditions as well as other notable requirements or restrictions.
Represents an unknown tag.
Represents an empty scaladoc line.
Documents a specific value parameter of a method or class constructor.
Documents the return value of a method.
Points to other sources of information such as external documentation or related entities in the documentation.
The version of the system or API that an entity was first defined in.
Companion object for TagKind containing its pattern match extractor.
Documents an exception type that may be thrown by a method or class constructor.
Documents unimplemented features in an entity.
Documents a specific type parameter of a method, class, trait or abstract type.
Documents a use case of a method, class, trait or abstract type.
The version of the system or API that a class, trait, object or package is part of.
Contains all the implemented Heading's.
Helper apply method for named DocToken.
Helper DocToken apply method.
Helper DocToken apply method.
Obtains a heading by its level if available.
Returns all the labelled token kinds.
Companion object containing the classes required for describing an ScalaDoc token.
The available tokens and their documentation are obtained from:
http://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html