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. 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 comment: Option[Comment]

    The comment attached to this member, if any.

  3. abstract def definitionName: String

    The qualified name of the member in its currently active declaration template.

  4. abstract def deprecation: Option[Body]

    Some deprecation message if this member is deprecated, or none otherwise.

  5. 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, and final.

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

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

  8. abstract def isAbstract: Boolean

    Whether this member is abstract.

  9. abstract def isAbstractType: Boolean

    Whether this member is an abstract type.

  10. abstract def isAliasType: Boolean

    Whether this member is an alias type.

  11. abstract def isConstructor: Boolean

    Whether this member is a constructor.

  12. abstract def isDef: Boolean

    Whether this member is a method.

  13. abstract def isImplicit: Boolean

    Whether this member is implicit.

  14. abstract def isLazyVal: Boolean

    Whether this member is a lazy value.

  15. abstract def isTemplate: Boolean

    Whether this member is a template.

  16. abstract def isVal: Boolean

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

  17. abstract def isVar: Boolean

    Whether this member is a variable.

  18. abstract def migration: Option[Body]

    Some migration warning if this member has a migration annotation, or none otherwise.

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

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

  21. abstract def resultType: TypeEntity

    For members representing values: the type of the value returned by this member; for members representing types: the type itself.

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

    Definition Classes
    MemberEntity → Entity

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

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

  25. abstract def inheritedFrom: List[TemplateEntity]

    Annotations
    @deprecated
    Deprecated

    (Since version 2.9.0) Use inDefinitionTemplates instead

Concrete Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

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

  8. final def eq(arg0: AnyRef): Boolean

    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. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    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. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

  21. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Entity

Inherited from AnyRef

Inherited from Any