scala.tools.nsc.ast.Trees

DocDef

case class DocDef(comment: Global.DocComment, definition: Global.Tree) extends Global.Tree with Product with Serializable

Documented definition, eliminated by analyzer

Source
Trees.scala
Linear Supertypes
Serializable, java.io.Serializable, Global.Tree, Global.Attachable, Global.TreeContextApiImpl, Global.TreeContextApi, Global.AttachableApi, Global.TreeApi, Global.TreeBase, Product, Equals, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DocDef
  2. Serializable
  3. Serializable
  4. Tree
  5. Attachable
  6. TreeContextApiImpl
  7. TreeContextApi
  8. AttachableApi
  9. TreeApi
  10. TreeBase
  11. Product
  12. Equals
  13. AnyRef
  14. 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 DocDef(comment: Global.DocComment, definition: Global.Tree)

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.DocDef to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

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

    Implicit information
    This member is added by an implicit conversion from Global.DocDef to ArrowAssoc[Global.DocDef] 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. def addAttachment(attachment: Any): DocDef.this.type

    Definition Classes
    Attachable

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def attachments: Attachments { type Pos = Trees.this.Position }

    Definition Classes
    Attachable

  11. def changeOwner(pairs: (Global.Symbol, Global.Symbol)*): Global.Tree

    Definition Classes
    TreeContextApiImpl

  12. def children: List[Global.Tree]

    Definition Classes
    TreeContextApiImpl → TreeApi

  13. def clone(): AnyRef

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

  14. def collect[T](pf: PartialFunction[Global.Tree, T]): List[T]

    Definition Classes
    TreeContextApiImpl → TreeApi

  15. val comment: Global.DocComment

  16. def correspondsStructure(that: Global.Tree)(f: (Global.Tree, Global.Tree) ⇒ Boolean): Boolean

    Definition Classes
    TreeContextApiImpl

  17. def defineType(tp: Global.Type): DocDef.this.type

    Definition Classes
    Tree → TreeContextApi

  18. val definition: Global.Tree

  19. def duplicate: DocDef.this.type

    Definition Classes
    Tree → TreeApi

  20. def ensuring(cond: (Global.DocDef) ⇒ Boolean, msg: ⇒ Any): Global.DocDef

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

  21. def ensuring(cond: (Global.DocDef) ⇒ Boolean): Global.DocDef

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

  22. def ensuring(cond: Boolean, msg: ⇒ Any): Global.DocDef

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

  23. def ensuring(cond: Boolean): Global.DocDef

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

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

    Definition Classes
    AnyRef

  25. def equals(that: Any): Boolean

    Definition Classes
    Tree → Equals → AnyRef → Any

  26. def equalsStructure(that: Global.Tree): Boolean

    Definition Classes
    TreeContextApiImpl → TreeApi

  27. def exists(p: (Global.Tree) ⇒ Boolean): Boolean

    Definition Classes
    TreeContextApiImpl → TreeApi

  28. def filter(f: (Global.Tree) ⇒ Boolean): List[Global.Tree]

    Definition Classes
    TreeContextApiImpl → TreeApi

  29. def finalize(): Unit

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

  30. def find(p: (Global.Tree) ⇒ Boolean): Option[Global.Tree]

    Definition Classes
    TreeContextApiImpl → TreeApi

  31. def forAll(p: (Global.Tree) ⇒ Boolean): Boolean

    Definition Classes
    TreeContextApiImpl → TreeApi

  32. def foreach(f: (Global.Tree) ⇒ Unit): Unit

    Definition Classes
    TreeContextApiImpl → TreeApi

  33. def foreachPartial(pf: PartialFunction[Global.Tree, Global.Tree]): Unit

    Definition Classes
    TreeContextApiImpl

  34. def formatted(fmtstr: String): String

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

  35. def freeTerms: List[Global.FreeTermSymbol]

    Definition Classes
    TreeContextApiImpl → TreeApi

  36. def freeTypes: List[Global.FreeTypeSymbol]

    Definition Classes
    TreeContextApiImpl → TreeApi

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

    Definition Classes
    AnyRef → Any

  38. def hasSymbol: Boolean

    Definition Classes
    Tree → TreeApi

  39. def hasSymbolWhich(f: (Global.Symbol) ⇒ Boolean): Boolean

    Definition Classes
    TreeContextApiImpl

  40. def hashCode(): Int

    Definition Classes
    Tree → AnyRef → Any

  41. val id: Int

    Definition Classes
    Tree

  42. def isDef: Boolean

    Definition Classes
    DocDef → Tree → TreeBase

  43. def isEmpty: Boolean

    Definition Classes
    Tree → TreeBase

  44. def isErroneous: Boolean

    Definition Classes
    TreeContextApiImpl

  45. def isErrorTyped: Boolean

    Definition Classes
    TreeContextApiImpl

  46. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  47. def isTerm: Boolean

    Definition Classes
    DocDef → Tree → TreeBase

  48. def isType: Boolean

    Definition Classes
    DocDef → Tree → TreeBase

  49. def isTyped: Boolean

    Definition Classes
    TreeContextApiImpl

  50. def modifyType(f: (Global.Type) ⇒ Global.Type): Global.Tree

    Definition Classes
    TreeContextApiImpl

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

    Definition Classes
    AnyRef

  52. final def notify(): Unit

    Definition Classes
    AnyRef

  53. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  54. def orElse(alt: ⇒ Global.Tree): Global.Tree

    Definition Classes
    TreeContextApiImpl → TreeApi

  55. final def pos: Global.Position

    Definition Classes
    Tree → Attachable → TreeApi
    Annotations
    @inline()

  56. def pos_=(pos: Global.Position): Unit

    Definition Classes
    Attachable

  57. var rawatt: Attachments { type Pos = Trees.this.Position }

    Attributes
    protected
    Definition Classes
    Attachable

  58. def removeAttachment[T](implicit arg0: ClassTag[T]): DocDef.this.type

    Definition Classes
    Attachable

  59. def setPos(newpos: Global.Position): DocDef.this.type

    Definition Classes
    Attachable

  60. def setSymbol(sym: Global.Symbol): DocDef.this.type

    Definition Classes
    Tree → TreeContextApi

  61. def setType(tp: Global.Type): DocDef.this.type

    Definition Classes
    Tree → TreeContextApi

  62. def shallowDuplicate: Global.Tree

    Definition Classes
    TreeContextApiImpl

  63. def shortClass: String

    Definition Classes
    TreeContextApiImpl

  64. def substituteSymbols(from: List[Global.Symbol], to: List[Global.Symbol]): Global.Tree

    Definition Classes
    TreeContextApiImpl → TreeApi

  65. def substituteThis(clazz: Global.Symbol, to: Global.Tree): Global.Tree

    Definition Classes
    TreeContextApiImpl → TreeApi

  66. def substituteTypes(from: List[Global.Symbol], to: List[Global.Type]): Global.Tree

    Definition Classes
    TreeContextApiImpl → TreeApi

  67. def summaryString: String

    Definition Classes
    TreeContextApiImpl

  68. def symbol: Global.Symbol

    Definition Classes
    DocDef → Tree → TreeApi

  69. def symbol_=(sym: Global.Symbol): Unit

    Definition Classes
    DocDef → Tree → TreeContextApi

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

    Definition Classes
    AnyRef

  71. def toString(): String

    Definition Classes
    TreeBase → AnyRef → Any

  72. final def tpe: Global.Type

    Definition Classes
    Tree → TreeApi
    Annotations
    @inline()

  73. def tpe_=(t: Global.Type): Unit

    Definition Classes
    Tree → TreeContextApi

  74. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

  77. def withFilter(f: (Global.Tree) ⇒ Boolean): List[Global.Tree]

    Definition Classes
    TreeContextApiImpl → TreeApi

  78. def →[B](y: B): (Global.DocDef, B)

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

Shadowed Implict Value Members

  1. val self: Any

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

  2. val self: Any

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

Deprecated Value Members

  1. def x: Global.DocDef

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Global.DocDef

    Implicit information
    This member is added by an implicit conversion from Global.DocDef to Ensuring[Global.DocDef] 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:
    (docDef: Ensuring[Global.DocDef]).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 Global.Tree

Inherited from Global.Attachable

Inherited from Global.TreeContextApiImpl

Inherited from Global.TreeContextApi

Inherited from Global.AttachableApi

Inherited from Global.TreeApi

Inherited from Global.TreeBase

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Global.DocDef to StringAdd

Inherited by implicit conversion any2stringfmt from Global.DocDef to StringFormat

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

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

No Group