scala.tools.nsc.doc.model

DocTemplateEntity

trait DocTemplateEntity extends TemplateEntity with MemberEntity

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
Linear Supertypes
MemberEntity, TemplateEntity, Entity, AnyRef, Any
Known Subclasses
Class, DocTemplateImpl, Object, Package, PackageImpl, RootPackage, RootPackageImpl, Trait
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. DocTemplateEntity
  2. MemberEntity
  3. TemplateEntity
  4. Entity
  5. AnyRef
  6. Any
Visibility
  1. Public
  2. All

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

    Attributes
    abstract

  2. def aliasTypes : List[AliasType]

    All type aliases that are members of this template.

    All type aliases that are members of this template.

    Attributes
    abstract

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

  4. def comment : Option[Comment]

    The comment attached to this member, if any.

    The comment attached to this member, if any.

    Attributes
    abstract
    Definition Classes
    MemberEntity

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

    Attributes
    abstract

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

    Attributes
    abstract
    Definition Classes
    MemberEntity

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

    Attributes
    abstract
    Definition Classes
    MemberEntity

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

    Attributes
    abstract
    Definition Classes
    MemberEntity

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

    Attributes
    abstract
    Definition Classes
    MemberEntity

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

    Attributes
    abstract

  11. def inTemplate : DocTemplateEntity

    The template of which this entity is a member.

    The template of which this entity is a member.

    Attributes
    abstract
    Definition Classes
    MemberEntity → Entity

  12. def isAbstract : Boolean

    Whether this member is abstract.

    Whether this member is abstract.

    Attributes
    abstract
    Definition Classes
    MemberEntity

  13. def isAbstractType : Boolean

    Whether this member is an abstract type.

    Whether this member is an abstract type.

    Attributes
    abstract
    Definition Classes
    MemberEntity

  14. def isAliasType : Boolean

    Whether this member is an alias type.

    Whether this member is an alias type.

    Attributes
    abstract
    Definition Classes
    MemberEntity

  15. def isCaseClass : Boolean

    Whether this template is a case class.

    Whether this template is a case class.

    Attributes
    abstract
    Definition Classes
    TemplateEntity

  16. def isClass : Boolean

    Whether this template is a class.

    Whether this template is a class.

    Attributes
    abstract
    Definition Classes
    TemplateEntity

  17. def isConstructor : Boolean

    Whether this member is a constructor.

    Whether this member is a constructor.

    Attributes
    abstract
    Definition Classes
    MemberEntity

  18. def isDef : Boolean

    Whether this member is a method.

    Whether this member is a method.

    Attributes
    abstract
    Definition Classes
    MemberEntity

  19. def isDocTemplate : Boolean

    Whether documentation is available for this template.

    Whether documentation is available for this template.

    Attributes
    abstract
    Definition Classes
    TemplateEntity

  20. def isImplicit : Boolean

    Whether this member is implicit.

    Whether this member is implicit.

    Attributes
    abstract
    Definition Classes
    MemberEntity

  21. def isLazyVal : Boolean

    Whether this member is a lazy value.

    Whether this member is a lazy value.

    Attributes
    abstract
    Definition Classes
    MemberEntity

  22. def isObject : Boolean

    Whether this template is an object.

    Whether this template is an object.

    Attributes
    abstract
    Definition Classes
    TemplateEntity

  23. 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
    Definition Classes
    TemplateEntity

  24. def isRootPackage : Boolean

    Whether this template is the root package.

    Whether this template is the root package.

    Attributes
    abstract
    Definition Classes
    TemplateEntity

  25. def isTemplate : Boolean

    Whether this member is a template.

    Whether this member is a template.

    Attributes
    abstract
    Definition Classes
    MemberEntity

  26. def isTrait : Boolean

    Whether this template is a trait.

    Whether this template is a trait.

    Attributes
    abstract
    Definition Classes
    TemplateEntity

  27. def isVal : Boolean

    Whether this member is a value (this excludes lazy values).

    Whether this member is a value (this excludes lazy values).

    Attributes
    abstract
    Definition Classes
    MemberEntity

  28. def isVar : Boolean

    Whether this member is a variable.

    Whether this member is a variable.

    Attributes
    abstract
    Definition Classes
    MemberEntity

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

    Attributes
    abstract

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

    Attributes
    abstract

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

    Attributes
    abstract

  32. def methods : List[Def]

    All methods that are members of this template.

    All methods that are members of this template.

    Attributes
    abstract

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

  34. def parentType : Option[TypeEntity]

    The direct super-type of this template.

    The direct super-type of this template.

    Attributes
    abstract

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

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

    Attributes
    abstract
    Definition Classes
    MemberEntity

  37. 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
    Definition Classes
    TemplateEntity

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

    Attributes
    abstract

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

    Attributes
    abstract

  40. def 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.

    Attributes
    abstract

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

    Attributes
    abstract
    Definition Classes
    DocTemplateEntity → MemberEntity → Entity

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

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

    Attributes
    abstract

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

    Attributes
    abstract
    Definition Classes
    MemberEntity

  45. def inheritedFrom : List[TemplateEntity]

    Attributes
    abstract
    Definition Classes
    MemberEntity
    Annotations
    @deprecated
    Deprecated

    Use inDefinitionTemplates instead

  46. def linearization : List[(TemplateEntity, TypeEntity)]

    Attributes
    abstract
    Annotations
    @deprecated
    Deprecated

    Use linearizationTemplates and linearizationTypes instead

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 MemberEntity

Inherited from TemplateEntity

Inherited from Entity

Inherited from AnyRef

Inherited from Any