scala.tools.nsc.doc.model.comment

Comment

class Comment extends AnyRef

A Scaladoc comment and all its tags.

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

Attributes
abstract
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. def authors : List[Body]

    A list of authors.

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

    Attributes
    abstract

  2. def body : Body

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

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

    Attributes
    abstract

  3. def constructor : Option[Body]

    A description for the primary constructor

    A description for the primary constructor

    Attributes
    abstract

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

    Attributes
    abstract

  5. def example : List[Body]

    A usage example related to the entity.

    A usage example related to the entity.

    Attributes
    abstract

  6. def note : List[Body]

    An additional note concerning the contract of the entity.

    An additional note concerning the contract of the entity.

    Attributes
    abstract

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

    Attributes
    abstract

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

    Attributes
    abstract

  9. def since : Option[Body]

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

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

    Attributes
    abstract

  10. def source : Option[String]

    The comment as it appears in the source text.

    The comment as it appears in the source text.

    Attributes
    abstract

  11. def throws : Map[String, Body]

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

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

    Attributes
    abstract

  12. def todo : List[Body]

    An annotation as to expected changes on this entity.

    An annotation as to expected changes on this entity.

    Attributes
    abstract

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

    Attributes
    abstract

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

    Attributes
    abstract

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

    Attributes
    abstract

Concrete Value Members

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

    Attributes
    final
    Definition Classes
    AnyRef

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

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

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

    Attributes
    final
    Definition Classes
    AnyRef

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

    Attributes
    final
    Definition Classes
    Any

  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  7. def clone (): AnyRef

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

  8. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    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. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any

  12. def hashCode (): Int

    Definition Classes
    AnyRef → Any

  13. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  14. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  15. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  16. def notifyAll (): Unit

    Attributes
    final
    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. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  19. def toString (): String

    Definition Classes
    Comment → AnyRef → Any

  20. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  22. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from AnyRef

Inherited from Any