DocToken

Type Members

abstract class Heading extends Kind

Documents a Scaladoc Heading.
sealed abstract class Kind extends AnyRef

Represents a documentation remark.
final case class Reference(to: String) extends AnyVal with Product with Serializable

Represents an documentation code reference.
sealed abstract class TagKind extends Kind

Represents a labeled documentation remark.

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
object Author extends TagKind with Product with Serializable

Document an entity to one author.
object CodeBlock extends Kind with Product with Serializable

Represents an scaladoc code block.
object Constructor extends TagKind with Product with Serializable

Placed in the class comment will describe the primary constructor.
object Deprecated extends TagKind with Product with Serializable

Marks an entity as deprecated.
Marks an entity as deprecated. The message should describe replacement implementation.
object Description extends Kind with Product with Serializable

Documents an untagged scaladoc description.
object Documentable extends TagKind with Product with Serializable

Expand a type alias and abstract type into a full template page.
object Example extends TagKind with Product with Serializable

Provides example code and related descriptions.
object Group extends TagKind with Product with Serializable

Marks the entity as member of the body group.
object GroupDescription extends TagKind with Product with Serializable

Adds an optional descriptive text to display under the group name.
object GroupName extends TagKind with Product with Serializable

Provide an optional name for the group.
object GroupPriority extends TagKind with Product with Serializable

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.
object Heading1 extends Heading with Product with Serializable

Represents a first level heading:
Represents a first level heading:
i.e: '=HEADING='
object Heading2 extends Heading with Product with Serializable

Represents a second level heading:
Represents a second level heading:
i.e: '==HEADING=='
object Heading3 extends Heading with Product with Serializable

Represents a third level heading:
Represents a third level heading:
i.e: '==HEADING=='
object Heading4 extends Heading with Product with Serializable

Represents a fourth level heading:
Represents a fourth level heading:
i.e: '===HEADING==='
object Heading5 extends Heading with Product with Serializable

Represents a fifth level heading:
Represents a fifth level heading:
i.e: '====HEADING===='
object Heading6 extends Heading with Product with Serializable

Represents a sixth level heading:
Represents a sixth level heading:
i.e: '====HEADING===='
object InheritDoc extends Kind with Product with Serializable

Take comments from a superclass as defaults if comments are not provided locally.
object Migration extends TagKind with Product with Serializable

Like Deprecated but provides advanced warning of planned changes ahead of deprecation.
object Note extends TagKind with Product with Serializable

Documents pre- and post-conditions as well as other notable requirements or restrictions.
object OtherTag extends Kind with Product with Serializable

Represents an unknown tag.
object Paragraph extends Kind with Product with Serializable

Represents an empty scaladoc line.
object Param extends TagKind with Product with Serializable

Documents a specific value parameter of a method or class constructor.
object Return extends TagKind with Product with Serializable

Documents the return value of a method.
object See extends TagKind with Product with Serializable

Points to other sources of information such as external documentation or related entities in the documentation.
object Since extends TagKind with Product with Serializable

The version of the system or API that an entity was first defined in.
object TagKind

Companion object for TagKind containing its pattern match extractor.
object Throws extends TagKind with Product with Serializable

Documents an exception type that may be thrown by a method or class constructor.
object Todo extends TagKind with Product with Serializable

Documents unimplemented features in an entity.
object TypeParam extends TagKind with Product with Serializable

Documents a specific type parameter of a method, class, trait or abstract type.
object UseCase extends TagKind with Product with Serializable

Documents a use case of a method, class, trait or abstract type.
object Version extends TagKind with Product with Serializable

The version of the system or API that a class, trait, object or package is part of.
def allHeadings: Seq[Heading]

Contains all the implemented Heading's.
def apply(kind: TagKind, name: String, body: String): DocToken

Helper apply method for named DocToken.
def apply(kind: Kind, body: String): DocToken

Helper DocToken apply method.
def apply(kind: Kind): DocToken

Helper DocToken apply method.
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
def headingForLevel(level: Int): Option[Heading]

Obtains a heading by its level if available.
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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tagTokenKinds: List[TagKind]

Returns all the labelled token kinds.
def toString(): String

Definition Classes
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 Docs: class DocToken | package contrib

object DocToken extends Serializable

Type Members

abstract class Heading extends Kind

sealed abstract class Kind extends AnyRef

final case class Reference(to: String) extends AnyVal with Product with Serializable

sealed abstract class TagKind extends Kind

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Author extends TagKind with Product with Serializable

object CodeBlock extends Kind with Product with Serializable

object Constructor extends TagKind with Product with Serializable

object Deprecated extends TagKind with Product with Serializable

object Description extends Kind with Product with Serializable

object Documentable extends TagKind with Product with Serializable

object Example extends TagKind with Product with Serializable

object Group extends TagKind with Product with Serializable

object GroupDescription extends TagKind with Product with Serializable

object GroupName extends TagKind with Product with Serializable

object GroupPriority extends TagKind with Product with Serializable

object Heading1 extends Heading with Product with Serializable

object Heading2 extends Heading with Product with Serializable

object Heading3 extends Heading with Product with Serializable

object Heading4 extends Heading with Product with Serializable

object Heading5 extends Heading with Product with Serializable

object Heading6 extends Heading with Product with Serializable

object InheritDoc extends Kind with Product with Serializable

object Migration extends TagKind with Product with Serializable

object Note extends TagKind with Product with Serializable

object OtherTag extends Kind with Product with Serializable

object Paragraph extends Kind with Product with Serializable

object Param extends TagKind with Product with Serializable

object Return extends TagKind with Product with Serializable

object See extends TagKind with Product with Serializable

object Since extends TagKind with Product with Serializable

object TagKind

object Throws extends TagKind with Product with Serializable

object Todo extends TagKind with Product with Serializable

object TypeParam extends TagKind with Product with Serializable

object UseCase extends TagKind with Product with Serializable

object Version extends TagKind with Product with Serializable

def allHeadings: Seq[Heading]

def apply(kind: TagKind, name: String, body: String): DocToken

def apply(kind: Kind, body: String): DocToken

def apply(kind: Kind): DocToken

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

def headingForLevel(level: Int): Option[Heading]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

val tagTokenKinds: List[TagKind]

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped