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:

  • classes and traits;
  • objects and package;
  • constructors;
  • methods;
  • values, lazy values, and variables;
  • abstract type members and type aliases;
  • type and value parameters;
  • annotations.
Source
Entity.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
AbstractType, AliasType, Annotation, AnnotationClass, Class, Constructor, Def, DocTemplateEntity, MemberEntity, MemberTemplateEntity, DocTemplateImpl, EntityImpl, MemberImpl, MemberTemplateImpl, NoDocTemplateImpl, NonTemplateMemberImpl, NonTemplateParamMemberImpl, PackageImpl, RootPackageImpl, TemplateImpl, NoDocTemplate, NonTemplateMemberEntity, Object, Package, RootPackage, TemplateEntity, Trait, Val
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Entity
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def annotations: List[Annotation]

    The annotations attached to this entity, if any.

  2. abstract def inPackageObject: Boolean

    Whether or not the template was defined in a package object

  3. abstract def inTemplate: TemplateEntity

    The template of which this entity is a member.

  4. abstract def isType: Boolean

    Indicates whether this entity lives in the types namespace (classes, traits, abstract/alias types)

  5. abstract def kind: String

    The kind of the entity

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

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

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

  9. abstract def universe: Universe

    The Scaladoc universe of which this entity is a member.

Concrete Value Members

  1. def toString(): String

    The qualified name of this entity.

    The qualified name of this entity.

    Definition Classes
    Entity → AnyRef → Any