scala.tools.nsc.doc.model.ModelFactory

DocTemplateImpl

abstract class DocTemplateImpl extends MemberImpl with TemplateImpl with HigherKindedImpl with DocTemplateEntity

The instantiation of TemplateImpl triggers the creation of the following entities: All ancestors of the template and all non-package members.

Source
ModelFactory.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DocTemplateImpl
  2. DocTemplateEntity
  3. HigherKindedImpl
  4. HigherKinded
  5. TemplateImpl
  6. TemplateEntity
  7. MemberImpl
  8. MemberEntity
  9. EntityImpl
  10. Entity
  11. AnyRef
  12. 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 DocTemplateImpl(sym: Symbol, inTpl: DocTemplateImpl)

Abstract Value Members

  1. abstract def kind: String

    The kind of the entity

    The kind of the entity

    Definition Classes
    Entity

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

    Implicit information
    This member is added by an implicit conversion from DocTemplateImpl to ArrowAssoc[DocTemplateImpl] 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 abstractTypes: List[AbstractType]

    All abstract types that are members of this template.

    All abstract types that are members of this template.

    Definition Classes
    DocTemplateImplDocTemplateEntity
  9. def aliasTypes: List[AliasType]

    All type aliases that are members of this template.

    All type aliases that are members of this template.

    Definition Classes
    DocTemplateImplDocTemplateEntity
  10. def allSubClasses: List[DocTemplateEntity]

    All class, trait and object templates for which this template is a direct or indirect super-class or super-trait.

    All class, trait and object templates for which this template is a direct or indirect super-class or super-trait. Only templates for which documentation is available in the universe (DocTemplateEntity) are listed.

    Definition Classes
    DocTemplateImplDocTemplateEntity
  11. def annotations: List[Annotation]

    The annotations attached to this entity, if any.

    The annotations attached to this entity, if any.

    Definition Classes
    EntityImplEntity
  12. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  13. def byConversion: Option[ImplicitConversion]

    If this member originates from an implicit conversion, we set the implicit information to the correct origin

    If this member originates from an implicit conversion, we set the implicit information to the correct origin

    Definition Classes
    MemberImplMemberEntity
  14. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  15. lazy val comment: Option[Comment]

    Definition Classes
    MemberImplMemberEntity
  16. def companion: Option[DocTemplateEntity]

    The companion of this template, or none.

    The companion of this template, or none. If a class and an object are defined as a pair of the same name, the other entity of the pair is the companion.

    Definition Classes
    DocTemplateImplDocTemplateEntity
  17. def completeModel: Unit

    This is the final point in the core model creation: no DocTemplates are created after the model has finished, but inherited templates and implicit members are added to the members at this point.

  18. lazy val contentDiagram: Option[Diagram]

    Definition Classes
    DocTemplateImplDocTemplateEntity
  19. val conversions: List[ImplicitConversionImpl]

    The implicit conversions this template (class or trait, objects and packages are not affected)

    The implicit conversions this template (class or trait, objects and packages are not affected)

    Definition Classes
    DocTemplateImplDocTemplateEntity
  20. lazy val definitionName: String

    Definition Classes
    DocTemplateImplMemberEntity
  21. def deprecation: Option[Body]

    Some deprecation message if this member is deprecated, or none otherwise.

    Some deprecation message if this member is deprecated, or none otherwise.

    Definition Classes
    MemberImplMemberEntity
  22. def directSubClasses: List[DocTemplateEntity]

    All class, trait and object templates for which this template is a *direct* super-class or super-trait.

    All class, trait and object templates for which this template is a *direct* super-class or super-trait. Only templates for which documentation is available in the universe (DocTemplateEntity) are listed.

    Definition Classes
    DocTemplateImplDocTemplateEntity
  23. def ensuring(cond: (DocTemplateImpl) ⇒ Boolean, msg: ⇒ Any): DocTemplateImpl

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

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

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

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

    Definition Classes
    AnyRef
  28. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  29. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  30. def flags: List[Paragraph]

    The flags that have been set for this entity.

    The flags that have been set for this entity. The following flags are supported: implicit, sealed, abstract, and final.

    Definition Classes
    MemberImplMemberEntity
  31. def formatted(fmtstr: String): String

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

    Definition Classes
    AnyRef → Any
  33. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  34. val id: Int

    Similar to symbols, so we can track entities

    Similar to symbols, so we can track entities

    Definition Classes
    EntityImplEntity
  35. var implicitsShadowing: Map[MemberEntity, ImplicitMemberShadowing]

    The shadowing information for the implicitly added members

    The shadowing information for the implicitly added members

    Definition Classes
    DocTemplateImplDocTemplateEntity
  36. def inDefinitionTemplates: List[TemplateEntity]

    The templates in which this member has been declared.

    The templates in which this member has been declared. The first element of the list is the template that contains the currently active declaration of this member, subsequent elements are declarations that have been overriden. If the first element is equal to inTemplate, the member is declared locally, if not, it has been inherited. All elements of this list are in the linearization of inTemplate.

    Definition Classes
    MemberImplMemberEntity
  37. def inPackageObject: Boolean

    Whether or not the template was defined in a package object

    Whether or not the template was defined in a package object

    Definition Classes
    TemplateImplTemplateEntity
  38. def inSource: Option[(AbstractFile, Int)]

    The source file in which the current template is defined and the line where the definition starts, if they exist.

    The source file in which the current template is defined and the line where the definition starts, if they exist. A source file exists for all templates, except for those that are generated synthetically by Scaladoc.

    Definition Classes
    DocTemplateImplDocTemplateEntity
  39. def inTemplate: DocTemplateImpl

    The template of which this entity is a member.

    The template of which this entity is a member.

    Definition Classes
    MemberImplMemberEntityEntityImplEntity
  40. def incomingImplicitlyConvertedClasses: List[(DocTemplateEntity, ImplicitConversionImpl)]

    Classes that can be implcitly converted to this class

    Classes that can be implcitly converted to this class

    Definition Classes
    DocTemplateImplDocTemplateEntity
  41. lazy val inheritanceDiagram: Option[Diagram]

    Definition Classes
    DocTemplateImplDocTemplateEntity
  42. def inheritedFrom: List[TemplateEntity]

    Definition Classes
    MemberImplMemberEntity
  43. def isAbstract: Boolean

    Whether this member is abstract.

    Whether this member is abstract.

    Definition Classes
    MemberImplMemberEntity
  44. def isAbstractType: Boolean

    Whether this member is an abstract type.

    Whether this member is an abstract type.

    Definition Classes
    MemberImplMemberEntity
  45. def isAliasType: Boolean

    Whether this member is an alias type.

    Whether this member is an alias type.

    Definition Classes
    MemberImplMemberEntity
  46. def isCaseClass: Boolean

    Whether this template is a case class.

    Whether this template is a case class.

    Definition Classes
    TemplateImplTemplateEntity
  47. def isClass: Boolean

    Whether this template is a class.

    Whether this template is a class.

    Definition Classes
    TemplateImplTemplateEntity
  48. def isConstructor: Boolean

    Whether this member is a constructor.

    Whether this member is a constructor.

    Definition Classes
    MemberImplMemberEntity
  49. def isDef: Boolean

    Whether this member is a method.

    Whether this member is a method.

    Definition Classes
    MemberImplMemberEntity
  50. def isDocTemplate: Boolean

    Whether documentation is available for this template.

    Whether documentation is available for this template.

    Definition Classes
    DocTemplateImplTemplateEntity
  51. def isImplicit: Boolean

    Whether this member is implicit.

    Whether this member is implicit.

    Definition Classes
    MemberImplMemberEntity
  52. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  53. def isLazyVal: Boolean

    Whether this member is a lazy value.

    Whether this member is a lazy value.

    Definition Classes
    MemberImplMemberEntity
  54. def isObject: Boolean

    Whether this template is an object.

    Whether this template is an object.

    Definition Classes
    TemplateImplTemplateEntity
  55. def isPackage: Boolean

    Whether this template is a package (including the root package).

    Whether this template is a package (including the root package).

    Definition Classes
    TemplateImplTemplateEntity
  56. def isRootPackage: Boolean

    Whether this template is the root package.

    Whether this template is the root package.

    Definition Classes
    TemplateImplTemplateEntity
  57. def isTemplate: Boolean

    Whether this member is a template.

    Whether this member is a template.

    Definition Classes
    DocTemplateImplMemberImplMemberEntity
  58. def isTrait: Boolean

    Whether this template is a trait.

    Whether this template is a trait.

    Definition Classes
    TemplateImplTemplateEntity
  59. def isVal: Boolean

    Whether this member is a value (this excludes lazy values).

    Whether this member is a value (this excludes lazy values).

    Definition Classes
    MemberImplMemberEntity
  60. def isVar: Boolean

    Whether this member is a variable.

    Whether this member is a variable.

    Definition Classes
    MemberImplMemberEntity
  61. lazy val linearization: List[(TemplateEntity, TypeEntity)]

  62. def linearizationFromSymbol(symbol: Symbol): List[(TemplateEntity, TypeEntity)]

    Attributes
    protected
  63. def linearizationTemplates: List[TemplateEntity]

    All class, trait and object templates which are part of this template's linearization, in lineratization order.

    All class, trait and object templates which are part of this template's linearization, in lineratization order. This template's linearization contains all of its direct and indirect super-classes and super-traits.

    Definition Classes
    DocTemplateImplDocTemplateEntity
  64. def linearizationTypes: List[TypeEntity]

    All instantiated types which are part of this template's linearization, in lineratization order.

    All instantiated types which are part of this template's linearization, in lineratization order. This template's linearization contains all of its direct and indirect super-types.

    Definition Classes
    DocTemplateImplDocTemplateEntity
  65. lazy val memberSyms: List[Symbol]

  66. var memberSymsEager: List[Symbol]

  67. var memberSymsLazy: List[Symbol]

  68. var members: List[MemberImpl]

    All members of this template.

    All members of this template. If this template is a package, only templates for which documentation is available in the universe (DocTemplateEntity) are listed.

    Definition Classes
    DocTemplateImplDocTemplateEntity
  69. def methods: List[Def]

    All methods that are members of this template.

    All methods that are members of this template.

    Definition Classes
    DocTemplateImplDocTemplateEntity
  70. def migration: Option[Body]

    Some migration warning if this member has a migration annotation, or none otherwise.

    Some migration warning if this member has a migration annotation, or none otherwise.

    Definition Classes
    MemberImplMemberEntity
  71. val name: String

    The name of the entity.

    The name of the entity. Note that the name does not qualify this entity uniquely; use its qualifiedName instead.

    Definition Classes
    EntityImplEntity
  72. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  73. final def notify(): Unit

    Definition Classes
    AnyRef
  74. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  75. lazy val outgoingImplicitlyConvertedClasses: List[(TemplateEntity, TypeEntity, ImplicitConversionImpl)]

    Definition Classes
    DocTemplateImplDocTemplateEntity
  76. val ownMembers: List[MemberImpl]

  77. def ownType: TypeEntity

    The type of this entity, with type members

    The type of this entity, with type members

    Definition Classes
    TemplateImplTemplateEntity
  78. def parentTemplates: List[TemplateImpl]

  79. def parentTypes: List[(TemplateEntity, TypeEntity)]

    The direct super-type of this template e.

    The direct super-type of this template e.g:

    class A extends B[C[Int]] with D[E]

    will have two direct parents: class B and D NOTE: we are dropping the refinement here! class A extends B[C[Int]] with D[E] }}} NOTE: we are dropping the refinement here!

    Definition Classes
    DocTemplateImplDocTemplateEntity
  80. def qualifiedName: String

    The qualified name of the entity.

    The qualified name of the entity. This is this entity's name preceded by the qualified name of the template of which this entity is a member. The qualified name is unique to this entity.

    Definition Classes
    TemplateImplEntityImplEntity
  81. def registerImplicitlyConvertibleClass(dtpl: DocTemplateEntity, conv: ImplicitConversionImpl): Unit

  82. def registerSubClass(sc: DocTemplateEntity): Unit

  83. def resultType: TypeEntity

    For members representing values: the type of the value returned by this member; for members representing types: the type itself.

    For members representing values: the type of the value returned by this member; for members representing types: the type itself.

    Definition Classes
    MemberImplMemberEntity
  84. def selfType: Option[TypeEntity]

    The self-type of this template, if it differs from the template type.

    The self-type of this template, if it differs from the template type.

    Definition Classes
    TemplateImplTemplateEntity
  85. def sourceUrl: Option[URL]

    An HTTP address at which the source of this template is available, if it is available.

    An HTTP address at which the source of this template is available, if it is available. An address is available only if the docsourceurl setting has been set.

    Definition Classes
    DocTemplateImplDocTemplateEntity
  86. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  87. def templates: List[DocTemplateEntity]

    All templates that are members of this template.

    All templates that are members of this template. If this template is a package, only templates for which documentation is available in the universe (DocTemplateEntity) are listed.

    Definition Classes
    DocTemplateImplDocTemplateEntity
  88. def toRoot: List[DocTemplateImpl]

    The list of templates such that each is a member of the template that follows it; the first template is always this template, the last the root package entity.

    The list of templates such that each is a member of the template that follows it; the first template is always this template, the last the root package entity.

    Definition Classes
    DocTemplateImplDocTemplateEntityMemberImplMemberEntityEntityImplEntity
  89. def toString(): String

    The qualified name of this entity.

    The qualified name of this entity.

    Definition Classes
    Entity → AnyRef → Any
  90. def typeParams: List[TypeParam]

    The type parameters of this entity.

    The type parameters of this entity.

    Definition Classes
    HigherKindedImplHigherKinded
  91. val universe: Universe

    The Scaladoc universe of which this entity is a member.

    The Scaladoc universe of which this entity is a member.

    Definition Classes
    EntityImplEntity
  92. def useCaseOf: Option[MemberEntity]

    If this symbol is a use case, the useCaseOf will contain the member it was derived from, containing the full signature and the complete parameter descriptions.

    If this symbol is a use case, the useCaseOf will contain the member it was derived from, containing the full signature and the complete parameter descriptions.

    Definition Classes
    MemberEntity
  93. def values: List[Val]

    All values, lazy values and variables that are members of this template.

    All values, lazy values and variables that are members of this template.

    Definition Classes
    DocTemplateImplDocTemplateEntity
  94. def visibility: Visibility

    The visibility of this member.

    The visibility of this member. Note that members with restricted visibility may not be modeled in some universes.

    Definition Classes
    MemberImplMemberEntity
  95. final def wait(): Unit

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

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

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

    Implicit information
    This member is added by an implicit conversion from DocTemplateImpl to ArrowAssoc[DocTemplateImpl] 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 DocTemplateImpl 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:
    (docTemplateImpl: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

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

Deprecated Value Members

  1. def x: DocTemplateImpl

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: DocTemplateImpl

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

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from DocTemplateEntity

Inherited from HigherKindedImpl

Inherited from HigherKinded

Inherited from TemplateImpl

Inherited from TemplateEntity

Inherited from MemberImpl

Inherited from MemberEntity

Inherited from EntityImpl

Inherited from Entity

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from DocTemplateImpl to StringAdd

Inherited by implicit conversion any2stringfmt from DocTemplateImpl to StringFormat

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

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