trait NoDocTemplate extends TemplateEntity
A template (class, trait, object or package) which is referenced in the universe, but for which no further documentation is available. Only templates for which a source file is given are documented by Scaladoc.
- Source
- Entity.scala
- Alphabetic
- By Inheritance
- NoDocTemplate
- TemplateEntity
- Entity
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
annotations: List[Annotation]
The annotations attached to this entity, if any.
The annotations attached to this entity, if any.
- Definition Classes
- Entity
-
abstract
def
inPackageObject: Boolean
Whether or not the template was defined in a package object
Whether or not the template was defined in a package object
- Definition Classes
- Entity
-
abstract
def
inTemplate: TemplateEntity
The template of which this entity is a member.
The template of which this entity is a member.
- Definition Classes
- Entity
-
abstract
def
isCaseClass: Boolean
Whether this template is a case class.
Whether this template is a case class.
- Definition Classes
- TemplateEntity
-
abstract
def
isClass: Boolean
Whether this template is a class.
Whether this template is a class.
- Definition Classes
- TemplateEntity
-
abstract
def
isDocTemplate: Boolean
Whether documentation is available for this template.
Whether documentation is available for this template.
- Definition Classes
- TemplateEntity
-
abstract
def
isObject: Boolean
Whether this template is an object.
Whether this template is an object.
- Definition Classes
- TemplateEntity
-
abstract
def
isPackage: Boolean
Whether this template is a package (including the root package).
Whether this template is a package (including the root package).
- Definition Classes
- TemplateEntity
-
abstract
def
isRootPackage: Boolean
Whether this template is the root package.
Whether this template is the root package.
- Definition Classes
- TemplateEntity
-
abstract
def
isTrait: Boolean
Whether this template is a trait.
Whether this template is a trait.
- Definition Classes
- TemplateEntity
-
abstract
def
isType: Boolean
Indicates whether this entity lives in the types namespace (classes, traits, abstract/alias types)
Indicates whether this entity lives in the types namespace (classes, traits, abstract/alias types)
- Definition Classes
- Entity
-
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
qualifiedNameinstead.- Definition Classes
- Entity
-
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
-
abstract
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.
- Definition Classes
- TemplateEntity
-
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.
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.
- Definition Classes
- Entity
-
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
Concrete Value Members
-
def
kind: String
The kind of the entity
The kind of the entity
- Definition Classes
- NoDocTemplate → Entity
-
def
toString(): String
The qualified name of this entity.
The qualified name of this entity.
- Definition Classes
- Entity → AnyRef → Any
The Scala compiler and reflection APIs.