trait DocTemplateEntity extends MemberTemplateEntity
A template (class, trait, object or package) for which documentation is available. Only templates for which a source file is given are documented by Scaladoc.
- Source
- Entity.scala
- Alphabetic
- By Inheritance
- DocTemplateEntity
- MemberTemplateEntity
- HigherKinded
- MemberEntity
- TemplateEntity
- Entity
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def abstractTypes: List[AbstractType]
All abstract types that are members of this template.
- abstract def aliasTypes: List[AliasType]
All type aliases that are members of this template.
- abstract def annotations: List[Annotation]
The annotations attached to this entity, if any.
The annotations attached to this entity, if any.
- Definition Classes
- Entity
- abstract 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
- MemberEntity
- abstract def comment: Option[Comment]
The comment attached to this member, if any.
The comment attached to this member, if any.
- Definition Classes
- MemberEntity
- abstract 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.
- abstract def constructors: List[Constructor]
All constructors of this class, including the primary constructor.
- abstract def contentDiagram: Option[Diagram]
If this template contains other templates, such as classes and traits, they will be shown in this diagram
- abstract def conversions: List[ImplicitConversion]
The implicit conversions this template (class or trait, objects and packages are not affected)
- abstract def 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
- MemberEntity
- abstract 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
- MemberEntity
- abstract 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. - abstract 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, andfinal.- Definition Classes
- MemberEntity
- abstract def group: String
The group this member is from
The group this member is from
- Definition Classes
- MemberEntity
- abstract def groupDescription(group: String): Option[Body]
Returns the group description taken either from this template or its linearizationTypes
- abstract def groupName(group: String): String
Returns the group description taken either from this template or its linearizationTypes
- abstract def groupPriority(group: String): Int
Returns the group description taken either from this template or its linearizationTypes
- abstract def implicitsShadowing: Map[MemberEntity, ImplicitMemberShadowing]
The shadowing information for the implicitly added members
- abstract 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 ofinTemplate.- Definition Classes
- MemberEntity
- abstract 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
- Entity
- abstract 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.
- abstract def inTemplate: DocTemplateEntity
The template of which this entity is a member.
The template of which this entity is a member.
- Definition Classes
- MemberEntity → Entity
- abstract def incomingImplicitlyConvertedClasses: List[(DocTemplateEntity, ImplicitConversion)]
Classes that can be implicitly converted to this class
- abstract def inheritanceDiagram: Option[Diagram]
If this template takes place in inheritance and implicit conversion relations, it will be shown in this diagram
- abstract def isAbstract: Boolean
Whether this member is abstract.
Whether this member is abstract.
- Definition Classes
- MemberEntity
- abstract def isAbstractType: Boolean
Whether this member is an abstract type.
Whether this member is an abstract type.
- Definition Classes
- MemberEntity
- abstract def isAliasType: Boolean
Whether this member is an alias type.
Whether this member is an alias type.
- Definition Classes
- MemberEntity
- abstract 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
- MemberEntity
- abstract def isCase: Boolean
Whether this template is a case class or a case object.
Whether this template is a case class or a case object.
- Definition Classes
- TemplateEntity
- abstract def isClass: Boolean
Whether this template is a class.
Whether this template is a class.
- Definition Classes
- TemplateEntity
- abstract def isConstructor: Boolean
Whether this member is a constructor.
Whether this member is a constructor.
- Definition Classes
- MemberEntity
- abstract def isDef: Boolean
Whether this member is a method.
Whether this member is a method.
- Definition Classes
- MemberEntity
- abstract def isDocTemplate: Boolean
Whether documentation is available for this template.
Whether documentation is available for this template.
- Definition Classes
- TemplateEntity
- abstract def isImplicitlyInherited: Boolean
Indicates whether the member is inherited by implicit conversion
Indicates whether the member is inherited by implicit conversion
- Definition Classes
- MemberEntity
- abstract def isLazyVal: Boolean
Whether this member is a lazy value.
Whether this member is a lazy value.
- Definition Classes
- MemberEntity
- abstract def isObject: Boolean
Whether this template is an object.
Whether this template is an object.
- Definition Classes
- TemplateEntity
- abstract 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
- TemplateEntity
- abstract def isRootPackage: Boolean
Whether this template is the root package.
Whether this template is the root package.
- Definition Classes
- TemplateEntity
- abstract 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
- MemberEntity
- abstract 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
- MemberEntity
- abstract def isTrait: Boolean
Whether this template is a trait.
Whether this template is a trait.
- Definition Classes
- TemplateEntity
- abstract 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
- Entity
- abstract 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
- MemberEntity
- abstract def isVar: Boolean
Whether this member is a variable.
Whether this member is a variable.
- Definition Classes
- MemberEntity
- abstract def kind: String
The kind of the entity
The kind of the entity
- Definition Classes
- Entity
- abstract def linearizationTemplates: List[TemplateEntity]
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.
- abstract def linearizationTypes: 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.
- abstract def 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. - abstract def methods: List[Def]
All methods that are members of this template.
- abstract 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
- MemberEntity
- abstract def name: String
The name of the entity.
The name of the entity. Note that the name does not qualify this entity uniquely; use its
qualifiedNameinstead.- Definition Classes
- Entity
- abstract def outgoingImplicitlyConvertedClasses: List[(TemplateEntity, TypeEntity, ImplicitConversion)]
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
- abstract def parentTypes: List[(TemplateEntity, TypeEntity)]
The direct super-type of this template e.g:
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!
- Definition Classes
- MemberTemplateEntity
- abstract def primaryConstructor: Option[Constructor]
The primary constructor of this class, if it has been defined.
- abstract 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
- Entity
- abstract 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
- MemberEntity
- abstract 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
- TemplateEntity
- abstract def signature: String
The identity of this member, used for linking
The identity of this member, used for linking
- Definition Classes
- MemberEntity
- abstract def signatureCompat: String
Compatibility signature, will be removed from future versions
Compatibility signature, will be removed from future versions
- Definition Classes
- MemberEntity
- abstract 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
docsourceurlsetting has been set. - abstract 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. - abstract def toRoot: List[DocTemplateEntity]
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
- DocTemplateEntity → MemberEntity → Entity
- abstract def typeParams: List[TypeParam]
The type parameters of this entity.
The type parameters of this entity.
- Definition Classes
- HigherKinded
- abstract def universe: Universe
The Scaladoc universe of which this entity is a member.
The Scaladoc universe of which this entity is a member.
- Definition Classes
- Entity
- abstract 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
- abstract 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
- MemberTemplateEntity
- abstract def values: List[Val]
All values, lazy values and variables that are members of this template.
- abstract 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
- MemberEntity
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from DocTemplateEntity toany2stringadd[DocTemplateEntity] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (DocTemplateEntity, B)
- Implicit
- This member is added by an implicit conversion from DocTemplateEntity toArrowAssoc[DocTemplateEntity] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (DocTemplateEntity) => Boolean, msg: => Any): DocTemplateEntity
- Implicit
- This member is added by an implicit conversion from DocTemplateEntity toEnsuring[DocTemplateEntity] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (DocTemplateEntity) => Boolean): DocTemplateEntity
- Implicit
- This member is added by an implicit conversion from DocTemplateEntity toEnsuring[DocTemplateEntity] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): DocTemplateEntity
- Implicit
- This member is added by an implicit conversion from DocTemplateEntity toEnsuring[DocTemplateEntity] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): DocTemplateEntity
- Implicit
- This member is added by an implicit conversion from DocTemplateEntity toEnsuring[DocTemplateEntity] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): java.lang.Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
The qualified name of this entity.
The qualified name of this entity.
- Definition Classes
- Entity → AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from DocTemplateEntity toStringFormat[DocTemplateEntity] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (DocTemplateEntity, B)
- Implicit
- This member is added by an implicit conversion from DocTemplateEntity toArrowAssoc[DocTemplateEntity] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
The Scala compiler and reflection APIs.