scala.tools.nsc.doc.model

Entity

trait Entity extends AnyRef

An entity in a Scaladoc universe. Entities are declarations in the program and correspond to symbols in the compiler. Entities model the following Scala concepts:

Source
Entity.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
AbstractType, AliasType, Annotation, Class, Constructor, Def, DocTemplateEntity, DocTemplateImpl, EntityImpl, HigherKinded, HigherKindedImpl, MemberEntity, MemberImpl, NoDocTemplate, NoDocTemplateImpl, NonTemplateMemberEntity, NonTemplateMemberImpl, NonTemplateParamMemberImpl, Object, Package, PackageImpl, ParameterEntity, ParameterImpl, RootPackage, RootPackageImpl, TemplateEntity, TemplateImpl, Trait, TypeParam, Val, ValueParam
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Entity
  2. AnyRef
  3. 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

  2. def inTemplate : TemplateEntity

    The template of which this entity is a member.

    The template of which this entity is a member.

    Attributes
    abstract

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

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

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

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

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 AnyRef

Inherited from Any