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
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Comment
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
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 contentDiagram: List[String]

    A set of diagram directives for the content diagram

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

  6. abstract def example: List[Body]

    A usage example related to the entity.

  7. abstract def group: Option[String]

    The group this member is part of

  8. abstract def groupDesc: Map[String, Body]

    Member group descriptions

  9. abstract def groupNames: Map[String, String]

    Member group names (overriding the short tag)

  10. abstract def groupPrio: Map[String, Int]

    Member group priorities

  11. abstract def inheritDiagram: List[String]

    A set of diagram directives for the inheritance diagram

  12. abstract def note: List[Body]

    An additional note concerning the contract of the entity.

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

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

  15. abstract def since: Option[Body]

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

  16. abstract def source: Option[String]

    The comment as it appears in the source text.

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

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

  18. abstract def todo: List[Body]

    An annotation as to expected changes on this entity.

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

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

  21. 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. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Comment to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (Comment, B)

    Implicit information
    This member is added by an implicit conversion from Comment to ArrowAssoc[Comment] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

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

  10. def ensuring(cond: (Comment) ⇒ Boolean, msg: ⇒ Any): Comment

    Implicit information
    This member is added by an implicit conversion from Comment to Ensuring[Comment] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: (Comment) ⇒ Boolean): Comment

    Implicit information
    This member is added by an implicit conversion from Comment to Ensuring[Comment] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean, msg: ⇒ Any): Comment

    Implicit information
    This member is added by an implicit conversion from Comment to Ensuring[Comment] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean): Comment

    Implicit information
    This member is added by an implicit conversion from Comment to Ensuring[Comment] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  16. def finalize(): Unit

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

  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Comment to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  24. def short: Inline

    A shorter version of the body.

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

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

    Definition Classes
    AnyRef

  26. def toString(): String

    Definition Classes
    Comment → AnyRef → Any

  27. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

  30. def →[B](y: B): (Comment, B)

    Implicit information
    This member is added by an implicit conversion from Comment to ArrowAssoc[Comment] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Comment to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (comment: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Comment to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (comment: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Comment

    Implicit information
    This member is added by an implicit conversion from Comment to ArrowAssoc[Comment] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (comment: ArrowAssoc[Comment]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Comment

    Implicit information
    This member is added by an implicit conversion from Comment to Ensuring[Comment] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (comment: Ensuring[Comment]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Comment to StringAdd

Inherited by implicit conversion any2stringfmt from Comment to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Comment to ArrowAssoc[Comment]

Inherited by implicit conversion any2Ensuring from Comment to Ensuring[Comment]

No Group