scala.tools.nsc.ast.DocComments

DocComment

case class DocComment(raw: String, pos: Global.Position = DocComments.this.NoPosition, codePos: Global.Position = DocComments.this.NoPosition) extends Product with Serializable

Linear Supertypes
Serializable, java.io.Serializable, Product, Equals, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DocComment
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. 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 DocComment(raw: String, pos: Global.Position = DocComments.this.NoPosition, codePos: Global.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 Global.DocComment to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

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

    Implicit information
    This member is added by an implicit conversion from Global.DocComment to ArrowAssoc[Global.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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. val codePos: Global.Position

  11. def defineVariables(sym: Global.Symbol): Unit

  12. lazy val defines: collection.immutable.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)

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

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

  14. def ensuring(cond: (Global.DocComment) ⇒ Boolean): Global.DocComment

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

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

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

  16. def ensuring(cond: Boolean): Global.DocComment

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

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

    Definition Classes
    AnyRef

  18. def finalize(): Unit

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

  19. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  25. val pos: Global.Position

  26. val raw: String

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

    Definition Classes
    AnyRef

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

  29. lazy val useCases: collection.immutable.List[Global.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)

  30. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. def →[B](y: B): (Global.DocComment, B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Global.DocComment 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:
    (docComment: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Global.DocComment 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:
    (docComment: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Global.DocComment

    Implicit information
    This member is added by an implicit conversion from Global.DocComment to ArrowAssoc[Global.DocComment] 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:
    (docComment: ArrowAssoc[Global.DocComment]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Global.DocComment

    Implicit information
    This member is added by an implicit conversion from Global.DocComment to Ensuring[Global.DocComment] 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:
    (docComment: Ensuring[Global.DocComment]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Global.DocComment to StringAdd

Inherited by implicit conversion any2stringfmt from Global.DocComment to StringFormat

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

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

Ungrouped