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

  2. def toString(): String
    Definition Classes
    Comment → AnyRef → Any