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
DocTemplateEntity, HigherKindedImpl, HigherKinded, TemplateImpl, TemplateEntity, MemberImpl, MemberEntity, EntityImpl, Entity, AnyRef, Any
Known Subclasses
PackageImpl, RootPackageImpl
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 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 DocTemplateImpl(sym: Symbol, inTpl: ⇒ DocTemplateImpl)

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. val 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

  9. val 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

  10. def annotations: List[Annotation]

    The annotations attached to this entity, if any.

    The annotations attached to this entity, if any.

    Definition Classes
    EntityImpl → Entity

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  12. 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
    MemberImpl → MemberEntity

  13. def clone(): AnyRef

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

  14. lazy val comment: Option[Comment]

    Definition Classes
    MemberImpl → MemberEntity

  15. 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

  16. val conversions: List[ImplicitConversion]

    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
    DocTemplateImpl → DocTemplateEntity

  17. lazy val definitionName: String

    Definition Classes
    DocTemplateImpl → MemberEntity

  18. 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

  19. 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

  20. 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

  21. 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

  22. 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

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

    Definition Classes
    AnyRef

  24. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  25. def finalize(): Unit

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

  26. 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
    MemberImpl → MemberEntity

  27. 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()

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

    Definition Classes
    AnyRef → Any

  29. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  30. 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
    MemberImpl → MemberEntity

  31. 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

  32. def inTemplate: 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

  33. def inheritedFrom: List[TemplateEntity]

    Definition Classes
    MemberImpl → MemberEntity

  34. def isAbstract: Boolean

    Whether this member is abstract.

    Whether this member is abstract.

    Definition Classes
    MemberImpl → MemberEntity

  35. def isAbstractType: Boolean

    Whether this member is an abstract type.

    Whether this member is an abstract type.

    Definition Classes
    MemberImpl → MemberEntity

  36. def isAliasType: Boolean

    Whether this member is an alias type.

    Whether this member is an alias type.

    Definition Classes
    MemberImpl → MemberEntity

  37. def isCaseClass: Boolean

    Whether this template is a case class.

    Whether this template is a case class.

    Definition Classes
    TemplateImpl → TemplateEntity

  38. def isClass: Boolean

    Whether this template is a class.

    Whether this template is a class.

    Definition Classes
    TemplateImpl → TemplateEntity

  39. def isConstructor: Boolean

    Whether this member is a constructor.

    Whether this member is a constructor.

    Definition Classes
    MemberImpl → MemberEntity

  40. def isDef: Boolean

    Whether this member is a method.

    Whether this member is a method.

    Definition Classes
    MemberImpl → MemberEntity

  41. def isDocTemplate: Boolean

    Whether documentation is available for this template.

    Whether documentation is available for this template.

    Definition Classes
    DocTemplateImpl → TemplateEntity

  42. def isImplicit: Boolean

    Whether this member is implicit.

    Whether this member is implicit.

    Definition Classes
    MemberImpl → MemberEntity

  43. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  44. def isLazyVal: Boolean

    Whether this member is a lazy value.

    Whether this member is a lazy value.

    Definition Classes
    MemberImpl → MemberEntity

  45. def isObject: Boolean

    Whether this template is an object.

    Whether this template is an object.

    Definition Classes
    TemplateImpl → TemplateEntity

  46. 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

  47. def isRootPackage: Boolean

    Whether this template is the root package.

    Whether this template is the root package.

    Definition Classes
    TemplateImpl → TemplateEntity

  48. def isTemplate: Boolean

    Whether this member is a template.

    Whether this member is a template.

    Definition Classes
    DocTemplateImpl → MemberImpl → MemberEntity

  49. def isTrait: Boolean

    Whether this template is a trait.

    Whether this template is a trait.

    Definition Classes
    TemplateImpl → TemplateEntity

  50. 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

  51. def isVar: Boolean

    Whether this member is a variable.

    Whether this member is a variable.

    Definition Classes
    MemberImpl → MemberEntity

  52. val linearization: List[(TemplateEntity, TypeEntity)]

    Definition Classes
    DocTemplateImpl → DocTemplateEntity

  53. 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
    DocTemplateImpl → DocTemplateEntity

  54. 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
    DocTemplateImpl → DocTemplateEntity

  55. lazy val memberSyms: List[Symbol]

  56. val members: List[MemberEntity]

    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
    DocTemplateImpl → DocTemplateEntity

  57. val methods: List[Def]

    All methods that are members of this template.

    All methods that are members of this template.

    Definition Classes
    DocTemplateImpl → DocTemplateEntity

  58. 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

  59. 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
    EntityImpl → Entity

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

    Definition Classes
    AnyRef

  61. final def notify(): Unit

    Definition Classes
    AnyRef

  62. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  63. def parentType: Option[TypeEntity]

    The direct super-type of this template.

    The direct super-type of this template.

    Definition Classes
    DocTemplateImpl → DocTemplateEntity

  64. 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

  65. def registerSubClass(sc: DocTemplateEntity): Unit

  66. 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

  67. val self: Any

    Implicit information
    This member is added by an implicit conversion from DocTemplateImpl to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat

  68. val self: Any

    Implicit information
    This member is added by an implicit conversion from DocTemplateImpl to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  69. 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

  70. 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

  71. def subClasses: 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
    DocTemplateImpl → DocTemplateEntity

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

    Definition Classes
    AnyRef

  73. val 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
    DocTemplateImpl → DocTemplateEntity

  74. 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
    DocTemplateImpl → DocTemplateEntity → MemberImpl → MemberEntity → EntityImpl → Entity

  75. def toString(): String

    The qualified name of this entity.

    The qualified name of this entity.

    Definition Classes
    Entity → AnyRef → Any

  76. def typeParams: List[TypeParam]

    The type parameters of this entity.

    The type parameters of this entity.

    Definition Classes
    HigherKindedImpl → HigherKinded

  77. 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
    EntityImpl → Entity

  78. val 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

  80. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

  83. 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

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.
    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.
    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 any2stringfmt from DocTemplateImpl to StringFormat

Inherited by implicit conversion any2stringadd from DocTemplateImpl to StringAdd

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

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