Packages

c

scala.tools.nsc.doc.model.ModelFactory

NoDocTemplateImpl

class NoDocTemplateImpl extends (ModelFactory.this)#EntityImpl with (ModelFactory.this)#TemplateImpl with (ModelFactory.this)#HigherKindedImpl with NoDocTemplate

A template that is not documented at all. The class is instantiated during lookups, to indicate that the class exists, but should not be documented (either it's not included in the source or it's not visible)

Source
ModelFactory.scala
Linear Supertypes
NoDocTemplate, (ModelFactory.this)#HigherKindedImpl, HigherKinded, (ModelFactory.this)#TemplateImpl, TemplateEntity, (ModelFactory.this)#EntityImpl, Entity, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NoDocTemplateImpl
  2. NoDocTemplate
  3. HigherKindedImpl
  4. HigherKinded
  5. TemplateImpl
  6. TemplateEntity
  7. EntityImpl
  8. Entity
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NoDocTemplateImpl(sym: Global.Symbol, inTpl: (ModelFactory.this)#TemplateImpl)

Value Members

  1. def annotations: List[Annotation]

    The annotations attached to this entity, if any.

    The annotations attached to this entity, if any.

    Definition Classes
    EntityImpl → Entity
  2. 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
    EntityImpl → Entity
  3. def inTemplate: (ModelFactory.this)#TemplateImpl

    The template of which this entity is a member.

    The template of which this entity is a member.

    Definition Classes
    EntityImpl → Entity
  4. val inTpl: (ModelFactory.this)#TemplateImpl
    Definition Classes
    EntityImpl
  5. def isCaseClass: Boolean

    Whether this template is a case class.

    Whether this template is a case class.

    Definition Classes
    TemplateImpl → TemplateEntity
  6. def isClass: Boolean

    Whether this template is a class.

    Whether this template is a class.

    Definition Classes
    TemplateImpl → TemplateEntity
  7. def isDocTemplate: Boolean

    Whether documentation is available for this template.

    Whether documentation is available for this template.

    Definition Classes
    NoDocTemplateImpl → TemplateEntity
  8. def isObject: Boolean

    Whether this template is an object.

    Whether this template is an object.

    Definition Classes
    TemplateImpl → TemplateEntity
  9. 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
    TemplateImpl → TemplateEntity
  10. def isRootPackage: Boolean

    Whether this template is the root package.

    Whether this template is the root package.

    Definition Classes
    TemplateImpl → TemplateEntity
  11. def isTrait: Boolean

    Whether this template is a trait.

    Whether this template is a trait.

    Definition Classes
    TemplateImpl → TemplateEntity
  12. 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
    EntityImpl → Entity
  13. def kind: String

    The kind of the entity

    The kind of the entity

    Definition Classes
    NoDocTemplate → Entity
  14. val 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
    EntityImpl → Entity
  15. 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
    TemplateImpl → EntityImpl → Entity
  16. 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
    TemplateImpl → TemplateEntity
  17. val sym: Global.Symbol
    Definition Classes
    EntityImpl
  18. def toRoot: List[(ModelFactory.this)#EntityImpl]

    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
    EntityImpl → Entity
  19. def toString(): String

    The qualified name of this entity.

    The qualified name of this entity.

    Definition Classes
    Entity → AnyRef → Any
  20. def typeParams: List[TypeParam]

    The type parameters of this entity.

    The type parameters of this entity.

    Definition Classes
    HigherKindedImpl → HigherKinded
  21. val universe: Universe

    The Scaladoc universe of which this entity is a member.

    The Scaladoc universe of which this entity is a member.

    Definition Classes
    EntityImpl → Entity