t

scala.tools.nsc.doc.model

TemplateEntity

trait TemplateEntity extends Entity

A template, which is either a class, trait, object or package. Depending on whether documentation is available or not, the template will be modeled as a [scala.tools.nsc.doc.model.NoDocTemplate] or a [scala.tools.nsc.doc.model.DocTemplateEntity].

Source
Entity.scala
Linear Supertypes
Entity, AnyRef, Any
Known Subclasses
AbstractType, AliasType, AnnotationClass, Class, DocTemplateEntity, MemberTemplateEntity, DocTemplateImpl, MemberTemplateImpl, NoDocTemplateImpl, PackageImpl, RootPackageImpl, TemplateImpl, NoDocTemplate, Object, Package, RootPackage, Trait
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TemplateEntity
  2. Entity
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def annotations: List[Annotation]

    The annotations attached to this entity, if any.

    The annotations attached to this entity, if any.

    Definition Classes
    Entity
  2. 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
  3. abstract def inTemplate: TemplateEntity

    The template of which this entity is a member.

    The template of which this entity is a member.

    Definition Classes
    Entity
  4. abstract def isCase: Boolean

    Whether this template is a case class or a case object.

  5. abstract def isClass: Boolean

    Whether this template is a class.

  6. abstract def isDocTemplate: Boolean

    Whether documentation is available for this template.

  7. abstract def isObject: Boolean

    Whether this template is an object.

  8. abstract def isPackage: Boolean

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

  9. abstract def isRootPackage: Boolean

    Whether this template is the root package.

  10. abstract def isTrait: Boolean

    Whether this template is a trait.

  11. 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
  12. abstract def kind: String

    The kind of the entity

    The kind of the entity

    Definition Classes
    Entity
  13. 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 qualifiedName instead.

    Definition Classes
    Entity
  14. 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
  15. abstract def selfType: Option[TypeEntity]

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

  16. abstract def toRoot: List[Entity]

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

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

    Definition Classes
    Entity
  17. 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

Concrete Value Members

  1. def toString(): String

    The qualified name of this entity.

    The qualified name of this entity.

    Definition Classes
    Entity → AnyRef → Any