scala.tools.nsc.doc.model

NoDocTemplate

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
Linear Supertypes
TemplateEntity, Entity, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. NoDocTemplate
  2. TemplateEntity
  3. Entity
  4. AnyRef
  5. 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 inTemplate: TemplateEntity

    The template of which this entity is a member.

    The template of which this entity is a member.

    Definition Classes
    Entity
  3. abstract def isCaseClass: Boolean

    Whether this template is a case class.

    Whether this template is a case class.

    Definition Classes
    TemplateEntity
  4. abstract def isClass: Boolean

    Whether this template is a class.

    Whether this template is a class.

    Definition Classes
    TemplateEntity
  5. abstract def isDocTemplate: Boolean

    Whether documentation is available for this template.

    Whether documentation is available for this template.

    Definition Classes
    TemplateEntity
  6. abstract def isObject: Boolean

    Whether this template is an object.

    Whether this template is an object.

    Definition Classes
    TemplateEntity
  7. 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
  8. abstract def isRootPackage: Boolean

    Whether this template is the root package.

    Whether this template is the root package.

    Definition Classes
    TemplateEntity
  9. abstract def isTrait: Boolean

    Whether this template is a trait.

    Whether this template is a trait.

    Definition Classes
    TemplateEntity
  10. 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
  11. 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
  12. 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
  13. 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
  14. 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

  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 TemplateEntity

Inherited from Entity

Inherited from AnyRef

Inherited from Any