Packages

abstract class Comment extends AnyRef

A Scaladoc comment and all its tags.

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

Source
Comment.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Comment
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
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 preferable 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 hideImplicitConversions: List[String]

    A list of implicit conversions to hide

  12. abstract def inheritDiagram: List[String]

    A set of diagram directives for the inheritance diagram

  13. abstract def note: List[Body]

    An additional note concerning the contract of the entity.

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

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

  16. abstract def shortDescription: Option[Text]

    A short description used in the entity-view and search results

  17. abstract def since: Option[Body]

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

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

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

  19. abstract def todo: List[Body]

    An annotation as to expected changes on this entity.

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

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

  22. 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: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Comment to any2stringadd[Comment] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Comment, B)
    Implicit
    This member is added by an implicit conversion from Comment to ArrowAssoc[Comment] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def ensuring(cond: (Comment) ⇒ Boolean, msg: ⇒ Any): Comment
    Implicit
    This member is added by an implicit conversion from Comment to Ensuring[Comment] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Comment) ⇒ Boolean): Comment
    Implicit
    This member is added by an implicit conversion from Comment to Ensuring[Comment] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): Comment
    Implicit
    This member is added by an implicit conversion from Comment to Ensuring[Comment] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Comment
    Implicit
    This member is added by an implicit conversion from Comment to Ensuring[Comment] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Comment to StringFormat[Comment] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def short: Inline

    A shorter version of the body.

    A shorter version of the body. Either from @shortDescription or the first sentence of the body.

  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    Comment → AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  28. def →[B](y: B): (Comment, B)
    Implicit
    This member is added by an implicit conversion from Comment to ArrowAssoc[Comment] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Comment to any2stringadd[Comment]

Inherited by implicit conversion StringFormat from Comment to StringFormat[Comment]

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

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

Ungrouped