scala.tools.nsc.doc.model.comment

Comment

abstract class Comment extends AnyRef

A Scaladoc comment and all its tags.

Note: the only instantiation site of this class is in CommentFactory.

Source
Comment.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Comment
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Comment()

Abstract Value Members

  1. abstract def authors: List[Body]

    A list of authors.

    A list of authors. The empty list is used when no author is defined.

  2. abstract def body: Body

    The main body of the comment that describes what the entity does and is.

  3. abstract def constructor: Option[Body]

    A description for the primary constructor

  4. abstract def deprecated: Option[Body]

    Whether the entity is deprecated.

    Whether the entity is deprecated. Using the @deprecated Scala attribute is prefereable to using this Scaladoc tag.

  5. abstract def example: List[Body]

    A usage example related to the entity.

  6. abstract def note: List[Body]

    An additional note concerning the contract of the entity.

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

  8. 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 mentionned.

  9. abstract def since: Option[Body]

    A version number of a containing entity where this member-entity was introduced.

  10. abstract def source: Option[String]

    The comment as it appears in the source text.

  11. abstract def throws: Map[String, Body]

    A map of exceptions that the entity can throw when accessed, and a description of what they mean.

  12. abstract def todo: List[Body]

    An annotation as to expected changes on this entity.

  13. 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.

  14. 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.

  15. 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

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  11. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  17. def short: Inline

    A shorter version of the body.

    A shorter version of the body. Usually, this is the first sentence of the body.

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

    Definition Classes
    AnyRef

  19. def toString(): String

    Definition Classes
    Comment → AnyRef → Any

  20. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

  22. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from AnyRef

Inherited from Any