abstract class Comment extends AnyRef
A Scaladoc comment and all its tags.
Note: the only instantiation site of this class is in model.CommentFactory.
- Source
- Comment.scala
- Alphabetic
- By Inheritance
- Comment
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Comment()
Abstract Value Members
-
abstract
def
authors: List[Body]
A list of authors.
A list of authors. The empty list is used when no author is defined.
-
abstract
def
body: Body
The main body of the comment that describes what the entity does and is.
-
abstract
def
constructor: Option[Body]
A description for the primary constructor
-
abstract
def
contentDiagram: List[String]
A set of diagram directives for the content diagram
-
abstract
def
deprecated: Option[Body]
Whether the entity is deprecated.
Whether the entity is deprecated. Using the
@deprecated
Scala attribute is preferable to using this Scaladoc tag. -
abstract
def
example: List[Body]
A usage example related to the entity.
-
abstract
def
group: Option[String]
The group this member is part of
-
abstract
def
groupDesc: Map[String, Body]
Member group descriptions
-
abstract
def
groupNames: Map[String, String]
Member group names (overriding the short tag)
-
abstract
def
groupPrio: Map[String, Int]
Member group priorities
-
abstract
def
hideImplicitConversions: List[String]
A list of implicit conversions to hide
-
abstract
def
inheritDiagram: List[String]
A set of diagram directives for the inheritance diagram
-
abstract
def
note: List[Body]
An additional note concerning the contract of the entity.
-
abstract
def
result: Option[Body]
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.
-
abstract
def
see: List[Body]
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 mentioned.
-
abstract
def
shortDescription: Option[Text]
A short description used in the entity-view and search results
-
abstract
def
since: Option[Body]
A version number of a containing entity where this member-entity was introduced.
-
abstract
def
throws: Map[String, Body]
A map of exceptions that the entity can throw when accessed, and a description of what they mean.
-
abstract
def
todo: List[Body]
An annotation as to expected changes on this entity.
-
abstract
def
typeParams: Map[String, Body]
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.
-
abstract
def
valueParams: Map[String, Body]
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.
-
abstract
def
version: Option[Body]
The version number of the entity.
The version number of the entity. There is no formatting or further meaning attached to this value.
The Scala compiler and reflection APIs.