scala.tools.nsc.doc.model

MemberEntity

trait MemberEntity extends Entity

An entity that is a member of a template. All entities, including templates, are member of another entity except for parameters and annotations. Note that all members of a template are modelled, including those that are inherited and not declared locally.

Source
Entity.scala
Linear Supertypes
Entity, AnyRef, Any
Known Subclasses
AbstractType, AliasType, Class, Constructor, Def, DocTemplateEntity, DocTemplateImpl, MemberImpl, NonTemplateMemberEntity, NonTemplateMemberImpl, NonTemplateParamMemberImpl, Object, Package, PackageImpl, RootPackage, RootPackageImpl, Trait, Val
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. MemberEntity
  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 comment : Option[Comment]

    The comment attached to this member, if any.

    The comment attached to this member, if any.

    Attributes
    abstract

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

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

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

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

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

  8. def isAbstract : Boolean

    Whether this member is abstract.

    Whether this member is abstract.

    Attributes
    abstract

  9. def isAbstractType : Boolean

    Whether this member is an abstract type.

    Whether this member is an abstract type.

    Attributes
    abstract

  10. def isAliasType : Boolean

    Whether this member is an alias type.

    Whether this member is an alias type.

    Attributes
    abstract

  11. def isConstructor : Boolean

    Whether this member is a constructor.

    Whether this member is a constructor.

    Attributes
    abstract

  12. def isDef : Boolean

    Whether this member is a method.

    Whether this member is a method.

    Attributes
    abstract

  13. def isImplicit : Boolean

    Whether this member is implicit.

    Whether this member is implicit.

    Attributes
    abstract

  14. def isLazyVal : Boolean

    Whether this member is a lazy value.

    Whether this member is a lazy value.

    Attributes
    abstract

  15. def isTemplate : Boolean

    Whether this member is a template.

    Whether this member is a template.

    Attributes
    abstract

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

  17. def isVar : Boolean

    Whether this member is a variable.

    Whether this member is a variable.

    Attributes
    abstract

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

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

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

  21. def toRoot : List[MemberEntity]

    The list of entities such that each is a member of the entity that follows it; the first entity is always this member, 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 member, the last the root package entity.

    Attributes
    abstract
    Definition Classes
    MemberEntity → Entity

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

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

  24. def inheritedFrom : List[TemplateEntity]

    Attributes
    abstract
    Annotations
    @deprecated
    Deprecated

    Use inDefinitionTemplates 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 Entity

Inherited from AnyRef

Inherited from Any