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
Class, DocTemplateEntity, DocTemplateImpl, NoDocTemplate, NoDocTemplateImpl, Object, Package, PackageImpl, RootPackage, RootPackageImpl, TemplateImpl, Trait
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. TemplateEntity
  2. Entity
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Abstract Value Members

  1. def annotations : List[Annotation]

    The annotations attached to this entity, if any.

    The annotations attached to this entity, if any.

    Attributes
    abstract
    Definition Classes
    Entity

  2. def inTemplate : TemplateEntity

    The template of which this entity is a member.

    The template of which this entity is a member.

    Attributes
    abstract
    Definition Classes
    Entity

  3. def isCaseClass : Boolean

    Whether this template is a case class.

    Whether this template is a case class.

    Attributes
    abstract

  4. def isClass : Boolean

    Whether this template is a class.

    Whether this template is a class.

    Attributes
    abstract

  5. def isDocTemplate : Boolean

    Whether documentation is available for this template.

    Whether documentation is available for this template.

    Attributes
    abstract

  6. def isObject : Boolean

    Whether this template is an object.

    Whether this template is an object.

    Attributes
    abstract

  7. def isPackage : Boolean

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

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

    Attributes
    abstract

  8. def isRootPackage : Boolean

    Whether this template is the root package.

    Whether this template is the root package.

    Attributes
    abstract

  9. def isTrait : Boolean

    Whether this template is a trait.

    Whether this template is a trait.

    Attributes
    abstract

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

    Attributes
    abstract
    Definition Classes
    Entity

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

    Attributes
    abstract
    Definition Classes
    Entity

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

    Attributes
    abstract

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

    Attributes
    abstract
    Definition Classes
    Entity

  14. def universe : Universe

    The Scaladoc universe of which this entity is a member.

    The Scaladoc universe of which this entity is a member.

    Attributes
    abstract
    Definition Classes
    Entity

Concrete Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  7. def clone (): AnyRef

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

  8. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  9. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize (): Unit

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

  11. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any

  12. def hashCode (): Int

    Definition Classes
    AnyRef → Any

  13. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  14. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  15. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  16. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  17. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  18. def toString (): String

    The qualified name of this entity.

    The qualified name of this entity.

    Definition Classes
    Entity → AnyRef → Any

  19. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  21. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Entity

Inherited from AnyRef

Inherited from Any