Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

4.  def allHeadings: Seq[Heading]

   Contains all the implemented Heading's.

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

   Helper apply method for named DocToken.

6.  def apply(kind: Kind, body: String): DocToken

   Helper DocToken apply method.

7.  def apply(kind: Kind): DocToken

   Helper DocToken apply method.

8.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

9.  def clone(): AnyRef

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

10.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

11.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

12.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

13.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

14.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

15.  def headingForLevel(level: Int): Option[Heading]

    Obtains a heading by its level if available.

16.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

17.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

18.  final def notify(): Unit

    Definition Classes

    AnyRef

19.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

20.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

21.  val tagTokenKinds: List[TagKind]

    Returns all the labelled token kinds.

22.  def toString(): String

    Definition Classes

    AnyRef → Any

23.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

25.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

26.  object Author extends TagKind with Product with Serializable

    Document an entity to one author.

27.  object CodeBlock extends Kind with Product with Serializable

    Represents an scaladoc code block.

28.  object Constructor extends TagKind with Product with Serializable

    Placed in the class comment will describe the primary constructor.

29.  object Deprecated extends TagKind with Product with Serializable

    Marks an entity as deprecated.

    Marks an entity as deprecated. The message should describe replacement implementation.

30.  object Description extends Kind with Product with Serializable

    Documents an untagged scaladoc description.

31.  object Documentable extends TagKind with Product with Serializable

    Expand a type alias and abstract type into a full template page.

32.  object Example extends TagKind with Product with Serializable

    Provides example code and related descriptions.

33.  object Group extends TagKind with Product with Serializable

    Marks the entity as member of the body group.

34.  object GroupDescription extends TagKind with Product with Serializable

    Adds an optional descriptive text to display under the group name.

35.  object GroupName extends TagKind with Product with Serializable

    Provide an optional name for the group.

36.  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.

37.  object Heading1 extends Heading with Product with Serializable

    Represents a first level heading:

    Represents a first level heading:

    i.e: '=HEADING='

38.  object Heading2 extends Heading with Product with Serializable

    Represents a second level heading:

    Represents a second level heading:

    i.e: '==HEADING=='

39.  object Heading3 extends Heading with Product with Serializable

    Represents a third level heading:

    Represents a third level heading:

    i.e: '===HEADING==='

40.  object Heading4 extends Heading with Product with Serializable

    Represents a fourth level heading:

    Represents a fourth level heading:

    i.e: '====HEADING===='

41.  object Heading5 extends Heading with Product with Serializable

    Represents a fifth level heading:

    Represents a fifth level heading:

    i.e: '=====HEADING====='

42.  object Heading6 extends Heading with Product with Serializable

    Represents a sixth level heading:

    Represents a sixth level heading:

    i.e: '======HEADING======'

43.  object InheritDoc extends Kind with Product with Serializable

    Take comments from a superclass as defaults if comments are not provided locally.

44.  object Migration extends TagKind with Product with Serializable

    Like Deprecated but provides advanced warning of planned changes ahead of deprecation.

45.  object Note extends TagKind with Product with Serializable

    Documents pre- and post-conditions as well as other notable requirements or restrictions.

46.  object OtherTag extends Kind with Product with Serializable

    Represents an unknown tag.

47.  object Paragraph extends Kind with Product with Serializable

    Represents an empty scaladoc line.

48.  object Param extends TagKind with Product with Serializable

    Documents a specific value parameter of a method or class constructor.

49.  object Return extends TagKind with Product with Serializable

    Documents the return value of a method.

50.  object See extends TagKind with Product with Serializable

    Points to other sources of information such as external documentation or related entities in the documentation.

51.  object Since extends TagKind with Product with Serializable

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

52.  object TagKind

    Companion object for TagKind containing its pattern match extractor.

53.  object Throws extends TagKind with Product with Serializable

    Documents an exception type that may be thrown by a method or class constructor.

54.  object Todo extends TagKind with Product with Serializable

    Documents unimplemented features in an entity.

55.  object TypeParam extends TagKind with Product with Serializable

    Documents a specific type parameter of a method, class, trait or abstract type.

56.  object UseCase extends TagKind with Product with Serializable

    Documents a use case of a method, class, trait or abstract type.

57.  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.