Packages

abstract class DocTemplateImpl extends (ModelFactory.this)#MemberTemplateImpl 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
DocTemplateEntity, (ModelFactory.this)#MemberTemplateImpl, MemberTemplateEntity, (ModelFactory.this)#HigherKindedImpl, HigherKinded, (ModelFactory.this)#TemplateImpl, TemplateEntity, (ModelFactory.this)#MemberImpl, MemberEntity, (ModelFactory.this)#EntityImpl, Entity, AnyRef, Any
Known Subclasses
PackageImpl, RootPackageImpl
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocTemplateImpl
  2. DocTemplateEntity
  3. MemberTemplateImpl
  4. MemberTemplateEntity
  5. HigherKindedImpl
  6. HigherKinded
  7. TemplateImpl
  8. TemplateEntity
  9. MemberImpl
  10. MemberEntity
  11. EntityImpl
  12. Entity
  13. AnyRef
  14. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DocTemplateImpl(sym: Global.Symbol, inTpl: (ModelFactory.this)#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. def abstractTypes: List[AbstractType]

    All abstract types that are members of this template.

    All abstract types that are members of this template.

    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  2. def aliasTypes: List[AliasType]

    All type aliases that are members of this template.

    All type aliases that are members of this template.

    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  3. def annotations: List[Annotation]

    The annotations attached to this entity, if any.

    The annotations attached to this entity, if any.

    Definition Classes
    EntityImpl → Entity
  4. def byConversion: Option[(ModelFactory.this)#ImplicitConversionImpl]

    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
    MemberImpl → MemberEntity
  5. lazy val comment: Option[Comment]

    The comment attached to this member, if any.

    The comment attached to this member, if any.

    Definition Classes
    MemberImpl → MemberEntity
  6. 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
    DocTemplateImpl → DocTemplateEntity
  7. 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.

  8. def constructors: List[(ModelFactory.this)#MemberImpl with Constructor]

    All constructors of this class, including the primary constructor.

    All constructors of this class, including the primary constructor.

    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  9. def contentDiagram: Option[Diagram]

    If this template contains other templates, such as classes and traits, they will be shown in this diagram

    If this template contains other templates, such as classes and traits, they will be shown in this diagram

    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  10. val conversions: List[(ModelFactory.this)#ImplicitConversionImpl]
    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  11. lazy val definitionName: String

    The qualified name of the member in its currently active declaration template.

    The qualified name of the member in its currently active declaration template.

    Definition Classes
    MemberTemplateImpl → MemberEntity
  12. 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
    MemberImpl → MemberEntity
  13. 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
    DocTemplateImpl → DocTemplateEntity
  14. def flags: collection.immutable.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
    MemberImpl → MemberEntity
  15. def group: String

    The group this member is from

    The group this member is from

    Definition Classes
    MemberImpl → MemberEntity
  16. def groupDescription(group: String): Option[Body]

    Returns the group description taken either from this template or its linearizationTypes

    Returns the group description taken either from this template or its linearizationTypes

    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  17. def groupName(group: String): String

    Returns the group description taken either from this template or its linearizationTypes

    Returns the group description taken either from this template or its linearizationTypes

    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  18. def groupPriority(group: String): Int

    Returns the group description taken either from this template or its linearizationTypes

    Returns the group description taken either from this template or its linearizationTypes

    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  19. def groupSearch[T](extractor: (Comment) ⇒ Option[T]): Option[T]
  20. var implicitsShadowing: Map[MemberEntity, ImplicitMemberShadowing]
    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  21. 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 overridden. 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
    MemberImpl → MemberEntity
  22. 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
    EntityImpl → Entity
  23. 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
    DocTemplateImpl → DocTemplateEntity
  24. def inTemplate: (ModelFactory.this)#DocTemplateImpl

    The template of which this entity is a member.

    The template of which this entity is a member.

    Definition Classes
    MemberImpl → MemberEntity → EntityImpl → Entity
  25. val inTpl: (ModelFactory.this)#TemplateImpl
    Definition Classes
    EntityImpl
  26. def incomingImplicitlyConvertedClasses: List[((ModelFactory.this)#DocTemplateImpl, (ModelFactory.this)#ImplicitConversionImpl)]

    Classes that can be implicitly converted to this class

    Classes that can be implicitly converted to this class

    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  27. def inheritanceDiagram: Option[Diagram]

    If this template takes place in inheritance and implicit conversion relations, it will be shown in this diagram

    If this template takes place in inheritance and implicit conversion relations, it will be shown in this diagram

    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  28. def isAbstract: Boolean

    Whether this member is abstract.

    Whether this member is abstract.

    Definition Classes
    MemberImpl → MemberEntity
  29. def isAbstractType: Boolean

    Whether this member is an abstract type.

    Whether this member is an abstract type.

    Definition Classes
    MemberImpl → MemberEntity
  30. def isAliasType: Boolean

    Whether this member is an alias type.

    Whether this member is an alias type.

    Definition Classes
    MemberImpl → MemberEntity
  31. def isAmbiguousImplicit: Boolean

    Indicates whether there are other implicitly inherited members that have similar signatures (and thus they all become ambiguous)

    Indicates whether there are other implicitly inherited members that have similar signatures (and thus they all become ambiguous)

    Definition Classes
    MemberImpl → MemberEntity
  32. def isCaseClass: Boolean

    Whether this template is a case class.

    Whether this template is a case class.

    Definition Classes
    TemplateImpl → TemplateEntity
  33. def isClass: Boolean

    Whether this template is a class.

    Whether this template is a class.

    Definition Classes
    TemplateImpl → TemplateEntity
  34. def isConstructor: Boolean

    Whether this member is a constructor.

    Whether this member is a constructor.

    Definition Classes
    MemberImpl → MemberEntity
  35. def isDef: Boolean

    Whether this member is a method.

    Whether this member is a method.

    Definition Classes
    MemberImpl → MemberEntity
  36. def isDocTemplate: Boolean

    Whether documentation is available for this template.

    Whether documentation is available for this template.

    Definition Classes
    DocTemplateImpl → MemberTemplateImpl → TemplateEntity
  37. def isImplicitlyInherited: Boolean

    Indicates whether the member is inherited by implicit conversion

    Indicates whether the member is inherited by implicit conversion

    Definition Classes
    MemberImpl → MemberEntity
  38. def isLazyVal: Boolean

    Whether this member is a lazy value.

    Whether this member is a lazy value.

    Definition Classes
    MemberImpl → MemberEntity
  39. def isObject: Boolean

    Whether this template is an object.

    Whether this template is an object.

    Definition Classes
    TemplateImpl → TemplateEntity
  40. 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
    TemplateImpl → TemplateEntity
  41. def isRootPackage: Boolean

    Whether this template is the root package.

    Whether this template is the root package.

    Definition Classes
    TemplateImpl → TemplateEntity
  42. def isShadowedImplicit: Boolean

    Indicates whether there is another member with the same name in the template that will take precedence

    Indicates whether there is another member with the same name in the template that will take precedence

    Definition Classes
    MemberImpl → MemberEntity
  43. def isShadowedOrAmbiguousImplicit: Boolean

    Indicates whether the implicitly inherited member is shadowed or ambiguous in its template

    Indicates whether the implicitly inherited member is shadowed or ambiguous in its template

    Definition Classes
    MemberImpl → MemberEntity
  44. def isTrait: Boolean

    Whether this template is a trait.

    Whether this template is a trait.

    Definition Classes
    TemplateImpl → TemplateEntity
  45. def isType: Boolean

    Indicates whether this entity lives in the types namespace (classes, traits, abstract/alias types)

    Indicates whether this entity lives in the types namespace (classes, traits, abstract/alias types)

    Definition Classes
    EntityImpl → Entity
  46. 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
    MemberImpl → MemberEntity
  47. def isVar: Boolean

    Whether this member is a variable.

    Whether this member is a variable.

    Definition Classes
    MemberImpl → MemberEntity
  48. lazy val linearizationTemplates: collection.immutable.List[(ModelFactory.this)#TemplateImpl]

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

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

    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  49. lazy val linearizationTypes: collection.immutable.List[TypeEntity]

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

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

    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  50. def linkTarget: (ModelFactory.this)#DocTemplateImpl
    Definition Classes
    DocTemplateImpl → MemberImpl
  51. lazy val memberSyms: List[Global.Symbol]
  52. val memberSymsEager: collection.immutable.List[Global.Symbol]
  53. val memberSymsLazy: collection.immutable.List[Global.Symbol]
  54. var members: List[(ModelFactory.this)#MemberImpl]
    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  55. def methods: List[Def]

    All methods that are members of this template.

    All methods that are members of this template.

    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  56. 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
    MemberImpl → MemberEntity
  57. val name: String
    Definition Classes
    EntityImpl → Entity
  58. lazy val outgoingImplicitlyConvertedClasses: List[(TemplateEntity, TypeEntity, (ModelFactory.this)#ImplicitConversionImpl)]

    Classes to which this class can be implicitly converted to NOTE: Some classes might not be included in the scaladoc run so they will be NoDocTemplateEntities

    Classes to which this class can be implicitly converted to NOTE: Some classes might not be included in the scaladoc run so they will be NoDocTemplateEntities

    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  59. val ownMembers: collection.immutable.List[(ModelFactory.this)#MemberImpl]
  60. def parentTypes: List[(TemplateEntity, TypeEntity)]

    TODO, these are now only computed for DocTemplates

    TODO, these are now only computed for DocTemplates

    Definition Classes
    MemberTemplateImpl → MemberTemplateEntity
  61. def primaryConstructor: Option[(ModelFactory.this)#MemberImpl with Constructor]

    The primary constructor of this class, if it has been defined.

    The primary constructor of this class, if it has been defined.

    Definition Classes
    DocTemplateImpl → DocTemplateEntity
  62. 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
    TemplateImpl → EntityImpl → Entity
  63. def registerImplicitlyConvertibleClass(dtpl: (ModelFactory.this)#DocTemplateImpl, conv: (ModelFactory.this)#ImplicitConversionImpl): Unit
  64. def registerSubClass(sc: DocTemplateEntity): Unit
  65. 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
    MemberImpl → MemberEntity
  66. 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
    TemplateImpl → TemplateEntity
  67. def signature: String

    The identity of this member, used for linking

    The identity of this member, used for linking

    Definition Classes
    MemberImpl → MemberEntity
  68. lazy val signatureCompat: String

    Compatibility signature, will be removed from future versions

    Compatibility signature, will be removed from future versions

    Definition Classes
    MemberImpl → MemberEntity
  69. 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
    DocTemplateImpl → DocTemplateEntity
  70. val sym: Global.Symbol
    Definition Classes
    EntityImpl
  71. def templates: List[TemplateEntity with MemberEntity]

    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
    DocTemplateImpl → DocTemplateEntity
  72. def toRoot: List[(ModelFactory.this)#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
    DocTemplateImpl → DocTemplateEntity → MemberImpl → MemberEntity → EntityImpl → Entity
  73. def toString(): String

    The qualified name of this entity.

    The qualified name of this entity.

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

    The type parameters of this entity.

    The type parameters of this entity.

    Definition Classes
    HigherKindedImpl → HigherKinded
  75. val universe: Universe
    Definition Classes
    EntityImpl → Entity
  76. def useCaseOf: Option[(ModelFactory.this)#MemberImpl]

    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
    MemberImpl → MemberEntity
  77. def valueParams: List[List[ValueParam]]

    The value parameters of this case class, or an empty list if this class is not a case class.

    The value parameters of this case class, or an empty list if this class is not a case class. As case class value parameters cannot be curried, the outer list has exactly one element.

    Definition Classes
    DocTemplateImpl → MemberTemplateImpl → MemberTemplateEntity
  78. 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
    DocTemplateImpl → DocTemplateEntity
  79. 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
    MemberImpl → MemberEntity