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
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. NoDocTemplate
  2. TemplateEntity
  3. Entity
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
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 id: Int

    Similar to symbols, so we can track entities

    Similar to symbols, so we can track entities

    Definition Classes
    Entity
  3. 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
  4. 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
  5. abstract def isCaseClass: Boolean

    Whether this template is a case class.

    Whether this template is a case class.

    Definition Classes
    TemplateEntity
  6. abstract def isClass: Boolean

    Whether this template is a class.

    Whether this template is a class.

    Definition Classes
    TemplateEntity
  7. abstract def isDocTemplate: Boolean

    Whether documentation is available for this template.

    Whether documentation is available for this template.

    Definition Classes
    TemplateEntity
  8. abstract def isNoDocMemberTemplate: Boolean

    Whether documentation is available for this template.

    Whether documentation is available for this template.

    Definition Classes
    TemplateEntity
  9. abstract def isObject: Boolean

    Whether this template is an object.

    Whether this template is an object.

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

    Whether this template is the root package.

    Whether this template is the root package.

    Definition Classes
    TemplateEntity
  12. abstract def isTerm: Boolean

    Indicates whether this entity lives in the terms namespace (objects, packages, methods, values)

    Indicates whether this entity lives in the terms namespace (objects, packages, methods, values)

    Definition Classes
    Entity
  13. abstract def isTrait: Boolean

    Whether this template is a trait.

    Whether this template is a trait.

    Definition Classes
    TemplateEntity
  14. 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
  15. 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
  16. 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
  17. 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
  18. 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
  19. 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. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from NoDocTemplate to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (NoDocTemplate, B)

    Implicit information
    This member is added by an implicit conversion from NoDocTemplate to ArrowAssoc[NoDocTemplate] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  10. def ensuring(cond: (NoDocTemplate) ⇒ Boolean, msg: ⇒ Any): NoDocTemplate

    Implicit information
    This member is added by an implicit conversion from NoDocTemplate to Ensuring[NoDocTemplate] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (NoDocTemplate) ⇒ Boolean): NoDocTemplate

    Implicit information
    This member is added by an implicit conversion from NoDocTemplate to Ensuring[NoDocTemplate] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): NoDocTemplate

    Implicit information
    This member is added by an implicit conversion from NoDocTemplate to Ensuring[NoDocTemplate] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): NoDocTemplate

    Implicit information
    This member is added by an implicit conversion from NoDocTemplate to Ensuring[NoDocTemplate] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from NoDocTemplate to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. def kind: String

    The kind of the entity

    The kind of the entity

    Definition Classes
    NoDocTemplateEntity
  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  26. def toString(): String

    The qualified name of this entity.

    The qualified name of this entity.

    Definition Classes
    Entity → AnyRef → Any
  27. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  28. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  29. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  30. def [B](y: B): (NoDocTemplate, B)

    Implicit information
    This member is added by an implicit conversion from NoDocTemplate to ArrowAssoc[NoDocTemplate] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from NoDocTemplate to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (noDocTemplate: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from NoDocTemplate to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (noDocTemplate: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: NoDocTemplate

    Implicit information
    This member is added by an implicit conversion from NoDocTemplate to ArrowAssoc[NoDocTemplate] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (noDocTemplate: ArrowAssoc[NoDocTemplate]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: NoDocTemplate

    Implicit information
    This member is added by an implicit conversion from NoDocTemplate to Ensuring[NoDocTemplate] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (noDocTemplate: Ensuring[NoDocTemplate]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from TemplateEntity

Inherited from Entity

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from NoDocTemplate to StringAdd

Inherited by implicit conversion any2stringfmt from NoDocTemplate to StringFormat

Inherited by implicit conversion any2ArrowAssoc from NoDocTemplate to ArrowAssoc[NoDocTemplate]

Inherited by implicit conversion any2Ensuring from NoDocTemplate to Ensuring[NoDocTemplate]

Ungrouped