scala.tools.nsc.doc.model

NoDocTemplateMemberEntity

trait NoDocTemplateMemberEntity extends TemplateEntity with MemberEntity

TODO: Document

Source
Entity.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. NoDocTemplateMemberEntity
  2. MemberEntity
  3. TemplateEntity
  4. Entity
  5. AnyRef
  6. 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 byConversion: Option[ImplicitConversion]

    If this member originates from an implicit conversion, we set the implicit information to the correct origin

    If this member originates from an implicit conversion, we set the implicit information to the correct origin

    Definition Classes
    MemberEntity
  3. abstract def comment: Option[Comment]

    The comment attached to this member, if any.

    The comment attached to this member, if any.

    Definition Classes
    MemberEntity
  4. abstract def definitionName: String

    The qualified name of the member in its currently active declaration template.

    The qualified name of the member in its currently active declaration template.

    Definition Classes
    MemberEntity
  5. abstract def deprecation: Option[Body]

    Some deprecation message if this member is deprecated, or none otherwise.

    Some deprecation message if this member is deprecated, or none otherwise.

    Definition Classes
    MemberEntity
  6. abstract def flags: List[Paragraph]

    The flags that have been set for this entity.

    The flags that have been set for this entity. The following flags are supported: implicit, sealed, abstract, and final.

    Definition Classes
    MemberEntity
  7. abstract def id: Int

    Similar to symbols, so we can track entities

    Similar to symbols, so we can track entities

    Definition Classes
    Entity
  8. abstract def inDefinitionTemplates: List[TemplateEntity]

    The templates in which this member has been declared.

    The templates in which this member has been declared. The first element of the list is the template that contains the currently active declaration of this member, subsequent elements are declarations that have been overriden. If the first element is equal to inTemplate, the member is declared locally, if not, it has been inherited. All elements of this list are in the linearization of inTemplate.

    Definition Classes
    MemberEntity
  9. 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
    TemplateEntity
  10. abstract def inTemplate: DocTemplateEntity

    The template of which this entity is a member.

    The template of which this entity is a member.

    Definition Classes
    MemberEntityEntity
  11. abstract def isAbstract: Boolean

    Whether this member is abstract.

    Whether this member is abstract.

    Definition Classes
    MemberEntity
  12. abstract def isAbstractType: Boolean

    Whether this member is an abstract type.

    Whether this member is an abstract type.

    Definition Classes
    MemberEntity
  13. abstract def isAliasType: Boolean

    Whether this member is an alias type.

    Whether this member is an alias type.

    Definition Classes
    MemberEntity
  14. abstract def isCaseClass: Boolean

    Whether this template is a case class.

    Whether this template is a case class.

    Definition Classes
    TemplateEntity
  15. abstract def isClass: Boolean

    Whether this template is a class.

    Whether this template is a class.

    Definition Classes
    TemplateEntity
  16. abstract def isConstructor: Boolean

    Whether this member is a constructor.

    Whether this member is a constructor.

    Definition Classes
    MemberEntity
  17. abstract def isDef: Boolean

    Whether this member is a method.

    Whether this member is a method.

    Definition Classes
    MemberEntity
  18. abstract def isDocTemplate: Boolean

    Whether documentation is available for this template.

    Whether documentation is available for this template.

    Definition Classes
    TemplateEntity
  19. abstract def isImplicit: Boolean

    Whether this member is implicit.

    Whether this member is implicit.

    Definition Classes
    MemberEntity
  20. abstract def isLazyVal: Boolean

    Whether this member is a lazy value.

    Whether this member is a lazy value.

    Definition Classes
    MemberEntity
  21. abstract def isObject: Boolean

    Whether this template is an object.

    Whether this template is an object.

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

    Whether this template is the root package.

    Whether this template is the root package.

    Definition Classes
    TemplateEntity
  24. abstract def isTemplate: Boolean

    Whether this member is a template.

    Whether this member is a template.

    Definition Classes
    MemberEntity
  25. abstract def isTrait: Boolean

    Whether this template is a trait.

    Whether this template is a trait.

    Definition Classes
    TemplateEntity
  26. abstract def isVal: Boolean

    Whether this member is a value (this excludes lazy values).

    Whether this member is a value (this excludes lazy values).

    Definition Classes
    MemberEntity
  27. abstract def isVar: Boolean

    Whether this member is a variable.

    Whether this member is a variable.

    Definition Classes
    MemberEntity
  28. abstract def migration: Option[Body]

    Some migration warning if this member has a migration annotation, or none otherwise.

    Some migration warning if this member has a migration annotation, or none otherwise.

    Definition Classes
    MemberEntity
  29. 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
  30. abstract def ownType: TypeEntity

    The type of this entity, with type members

    The type of this entity, with type members

    Definition Classes
    TemplateEntity
  31. 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
  32. abstract def resultType: TypeEntity

    For members representing values: the type of the value returned by this member; for members representing types: the type itself.

    For members representing values: the type of the value returned by this member; for members representing types: the type itself.

    Definition Classes
    MemberEntity
  33. 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
  34. abstract def toRoot: List[MemberEntity]

    The list of entities such that each is a member of the entity that follows it; the first entity is always this member, 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 member, the last the root package entity.

    Definition Classes
    MemberEntityEntity
  35. 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
  36. abstract def visibility: Visibility

    The visibility of this member.

    The visibility of this member. Note that members with restricted visibility may not be modeled in some universes.

    Definition Classes
    MemberEntity
  37. abstract def inheritedFrom: List[TemplateEntity]

    Definition Classes
    MemberEntity
    Annotations
    @deprecated
    Deprecated

    (Since version 2.9.0) Use inDefinitionTemplates instead

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 NoDocTemplateMemberEntity to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (NoDocTemplateMemberEntity, B)

    Implicit information
    This member is added by an implicit conversion from NoDocTemplateMemberEntity to ArrowAssoc[NoDocTemplateMemberEntity] 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  10. def ensuring(cond: (NoDocTemplateMemberEntity) ⇒ Boolean, msg: ⇒ Any): NoDocTemplateMemberEntity

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

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

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

    Implicit information
    This member is added by an implicit conversion from NoDocTemplateMemberEntity to Ensuring[NoDocTemplateMemberEntity] 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from NoDocTemplateMemberEntity to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): 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
    NoDocTemplateMemberEntityEntity
  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. def useCaseOf: Option[MemberEntity]

    If this symbol is a use case, the useCaseOf will contain the member it was derived from, containing the full signature and the complete parameter descriptions.

    If this symbol is a use case, the useCaseOf will contain the member it was derived from, containing the full signature and the complete parameter descriptions.

    Definition Classes
    MemberEntity
  28. final def wait(): Unit

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

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

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

    Implicit information
    This member is added by an implicit conversion from NoDocTemplateMemberEntity to ArrowAssoc[NoDocTemplateMemberEntity] 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 NoDocTemplateMemberEntity 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:
    (noDocTemplateMemberEntity: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from NoDocTemplateMemberEntity 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:
    (noDocTemplateMemberEntity: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: NoDocTemplateMemberEntity

    Implicit information
    This member is added by an implicit conversion from NoDocTemplateMemberEntity to ArrowAssoc[NoDocTemplateMemberEntity] 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:
    (noDocTemplateMemberEntity: ArrowAssoc[NoDocTemplateMemberEntity]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: NoDocTemplateMemberEntity

    Implicit information
    This member is added by an implicit conversion from NoDocTemplateMemberEntity to Ensuring[NoDocTemplateMemberEntity] 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:
    (noDocTemplateMemberEntity: Ensuring[NoDocTemplateMemberEntity]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from MemberEntity

Inherited from TemplateEntity

Inherited from Entity

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from NoDocTemplateMemberEntity to StringAdd

Inherited by implicit conversion any2stringfmt from NoDocTemplateMemberEntity to StringFormat

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

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