Comment

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.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def short: Inline

A shorter version of the body.
A shorter version of the body. Either from @shortDescription or the first sentence of the body.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Comment → AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package docstrings

abstract class Comment extends AnyRef

Instance Constructors

new Comment()

Abstract Value Members

abstract def authors: List[Body]

abstract def body: Body

abstract def constructor: Option[Body]

abstract def contentDiagram: List[String]

abstract def deprecated: Option[Body]

abstract def example: List[Body]

abstract def group: Option[String]

abstract def groupDesc: Map[String, Body]

abstract def groupNames: Map[String, String]

abstract def groupPrio: Map[String, Int]

abstract def hideImplicitConversions: List[String]

abstract def inheritDiagram: List[String]

abstract def note: List[Body]

abstract def result: Option[Body]

abstract def see: List[Body]

abstract def shortDescription: Option[Text]

abstract def since: Option[Body]

abstract def throws: Map[String, Body]

abstract def todo: List[Body]

abstract def typeParams: Map[String, Body]

abstract def valueParams: Map[String, Body]

abstract def version: Option[Body]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def short: Inline

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped