dotty.tools.dotc.core.Comments

Comment

Related Docs: object Comment | package Comments

abstract case class Comment(pos: Position, raw: String) extends Product with Serializable

A Comment contains the unformatted docstring as well as a position

The Comment contains functionality to create versions of itself without @usecase sections as well as functionality to map the raw docstring

Self Type
Comment
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Comment
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Comment(pos: Position, raw: String)

Abstract Value Members

  1. abstract def isExpanded: Boolean

  2. abstract def usecases: List[UseCase]

Concrete Value Members

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

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  5. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  7. def expand(f: (String) ⇒ String): Comment

  8. def finalize(): Unit

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

  9. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  10. val isDocComment: Boolean

  11. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  15. val pos: Position

  16. val raw: String

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

    Definition Classes
    AnyRef

  18. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. def withUsecases(implicit ctx: Context): Comment

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped