scala.tools.nsc.ast.DocComments

DocComment

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

Source
DocComments.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DocComment
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringfmt
  2. by any2stringadd
  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 DocComment(raw: String, pos: Position = DocComments.this.NoPosition)

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 DocComment to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (DocComment, B)

    Implicit information
    This member is added by an implicit conversion from DocComment to ArrowAssoc[DocComment] 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  10. def defineVariables(sym: Symbol): Unit

  11. lazy val defines: List[String]

    Returns: template: the doc comment minus all @define and @usecase sections defines : all define sections (as strings) useCases: all usecase sections (as instances of class UseCase)

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

    Implicit information
    This member is added by an implicit conversion from DocComment to Ensuring[DocComment] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (DocComment) ⇒ Boolean): DocComment

    Implicit information
    This member is added by an implicit conversion from DocComment to Ensuring[DocComment] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): DocComment

    Implicit information
    This member is added by an implicit conversion from DocComment to Ensuring[DocComment] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): DocComment

    Implicit information
    This member is added by an implicit conversion from DocComment to Ensuring[DocComment] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  18. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from DocComment to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]

    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. val pos: Position

  25. val raw: String

  26. val self: Any

    Implicit information
    This member is added by an implicit conversion from DocComment to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
  27. val self: Any

    Implicit information
    This member is added by an implicit conversion from DocComment to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  29. lazy val template: String

    Returns: template: the doc comment minus all @define and @usecase sections defines : all define sections (as strings) useCases: all usecase sections (as instances of class UseCase)

  30. lazy val useCases: List[UseCase]

    Returns: template: the doc comment minus all @define and @usecase sections defines : all define sections (as strings) useCases: all usecase sections (as instances of class UseCase)

  31. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  32. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  33. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  34. def [B](y: B): (DocComment, B)

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

Deprecated Value Members

  1. def x: DocComment

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: DocComment

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

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringfmt from DocComment to StringFormat

Inherited by implicit conversion any2stringadd from DocComment to StringAdd

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

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