scala.tools.nsc.doc.model

Package

trait Package extends Object

A package template. A package is in the universe if it is declared as a package object, or if it contains at least one template.

Source
Entity.scala
Linear Supertypes
Object, DocTemplateEntity, MemberEntity, TemplateEntity, Entity, AnyRef, Any
Known Subclasses
PackageImpl, RootPackage, RootPackageImpl
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Package
  2. Object
  3. DocTemplateEntity
  4. MemberEntity
  5. TemplateEntity
  6. Entity
  7. AnyRef
  8. Any
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def abstractTypes: List[AbstractType]

    All abstract types that are members of this template.

    All abstract types that are members of this template.

    Definition Classes
    DocTemplateEntity

  2. abstract def aliasTypes: List[AliasType]

    All type aliases that are members of this template.

    All type aliases that are members of this template.

    Definition Classes
    DocTemplateEntity

  3. abstract def annotations: List[Annotation]

    The annotations attached to this entity, if any.

    The annotations attached to this entity, if any.

    Definition Classes
    Entity

  4. abstract def comment: Option[Comment]

    The comment attached to this member, if any.

    The comment attached to this member, if any.

    Definition Classes
    MemberEntity

  5. abstract def companion: Option[DocTemplateEntity]

    The companion of this template, or none.

    The companion of this template, or none. If a class and an object are defined as a pair of the same name, the other entity of the pair is the companion.

    Definition Classes
    DocTemplateEntity

  6. 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

  7. 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

  8. 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

  9. 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

  10. abstract def inSource: Option[(AbstractFile, Int)]

    The source file in which the current template is defined and the line where the definition starts, if they exist.

    The source file in which the current template is defined and the line where the definition starts, if they exist. A source file exists for all templates, except for those that are generated synthetically by Scaladoc.

    Definition Classes
    DocTemplateEntity

  11. abstract def inTemplate: Package

    The package of which this package is a member.

    The package of which this package is a member.

    Definition Classes
    Package → MemberEntity → Entity

  12. abstract def isAbstract: Boolean

    Whether this member is abstract.

    Whether this member is abstract.

    Definition Classes
    MemberEntity

  13. abstract def isAbstractType: Boolean

    Whether this member is an abstract type.

    Whether this member is an abstract type.

    Definition Classes
    MemberEntity

  14. abstract def isAliasType: Boolean

    Whether this member is an alias type.

    Whether this member is an alias type.

    Definition Classes
    MemberEntity

  15. abstract def isCaseClass: Boolean

    Whether this template is a case class.

    Whether this template is a case class.

    Definition Classes
    TemplateEntity

  16. abstract def isClass: Boolean

    Whether this template is a class.

    Whether this template is a class.

    Definition Classes
    TemplateEntity

  17. abstract def isConstructor: Boolean

    Whether this member is a constructor.

    Whether this member is a constructor.

    Definition Classes
    MemberEntity

  18. abstract def isDef: Boolean

    Whether this member is a method.

    Whether this member is a method.

    Definition Classes
    MemberEntity

  19. abstract def isDocTemplate: Boolean

    Whether documentation is available for this template.

    Whether documentation is available for this template.

    Definition Classes
    TemplateEntity

  20. abstract def isImplicit: Boolean

    Whether this member is implicit.

    Whether this member is implicit.

    Definition Classes
    MemberEntity

  21. abstract def isLazyVal: Boolean

    Whether this member is a lazy value.

    Whether this member is a lazy value.

    Definition Classes
    MemberEntity

  22. abstract def isObject: Boolean

    Whether this template is an object.

    Whether this template is an object.

    Definition Classes
    TemplateEntity

  23. 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

  24. abstract def isRootPackage: Boolean

    Whether this template is the root package.

    Whether this template is the root package.

    Definition Classes
    TemplateEntity

  25. abstract def isTemplate: Boolean

    Whether this member is a template.

    Whether this member is a template.

    Definition Classes
    MemberEntity

  26. abstract def isTrait: Boolean

    Whether this template is a trait.

    Whether this template is a trait.

    Definition Classes
    TemplateEntity

  27. 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

  28. abstract def isVar: Boolean

    Whether this member is a variable.

    Whether this member is a variable.

    Definition Classes
    MemberEntity

  29. abstract def linearizationTemplates: List[TemplateEntity]

    All class, trait and object templates which are part of this template's linearization, in lineratization order.

    All class, trait and object templates which are part of this template's linearization, in lineratization order. This template's linearization contains all of its direct and indirect super-classes and super-traits.

    Definition Classes
    DocTemplateEntity

  30. abstract def linearizationTypes: List[TypeEntity]

    All instantiated types which are part of this template's linearization, in lineratization order.

    All instantiated types which are part of this template's linearization, in lineratization order. This template's linearization contains all of its direct and indirect super-types.

    Definition Classes
    DocTemplateEntity

  31. abstract def members: List[MemberEntity]

    All members of this template.

    All members of this template. If this template is a package, only templates for which documentation is available in the universe (DocTemplateEntity) are listed.

    Definition Classes
    DocTemplateEntity

  32. abstract def methods: List[Def]

    All methods that are members of this template.

    All methods that are members of this template.

    Definition Classes
    DocTemplateEntity

  33. 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

  34. 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

  35. abstract def packages: List[Package]

    All packages that are member of this package.

  36. abstract def parentType: Option[TypeEntity]

    The direct super-type of this template.

    The direct super-type of this template.

    Definition Classes
    DocTemplateEntity

  37. 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

  38. 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

  39. 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

  40. abstract def sourceUrl: Option[URL]

    An HTTP address at which the source of this template is available, if it is available.

    An HTTP address at which the source of this template is available, if it is available. An address is available only if the docsourceurl setting has been set.

    Definition Classes
    DocTemplateEntity

  41. abstract def subClasses: List[DocTemplateEntity]

    All class, trait and object templates for which this template is a direct or indirect super-class or super-trait.

    All class, trait and object templates for which this template is a direct or indirect super-class or super-trait. Only templates for which documentation is available in the universe (DocTemplateEntity) are listed.

    Definition Classes
    DocTemplateEntity

  42. abstract def templates: List[DocTemplateEntity]

    All templates that are members of this template.

    All templates that are members of this template. If this template is a package, only templates for which documentation is available in the universe (DocTemplateEntity) are listed.

    Definition Classes
    DocTemplateEntity

  43. abstract def toRoot: List[Package]

    The package such that each is a member of the package that follows it; the first package is always this package, the last the root package.

    The package such that each is a member of the package that follows it; the first package is always this package, the last the root package.

    Definition Classes
    Package → DocTemplateEntity → MemberEntity → Entity

  44. 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

  45. abstract def values: List[Val]

    All values, lazy values and variables that are members of this template.

    All values, lazy values and variables that are members of this template.

    Definition Classes
    DocTemplateEntity

  46. 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

  47. abstract def inheritedFrom: List[TemplateEntity]

    Definition Classes
    MemberEntity
    Annotations
    @deprecated
    Deprecated

    (Since version 2.9.0) Use inDefinitionTemplates instead

  48. abstract def linearization: List[(TemplateEntity, TypeEntity)]

    Definition Classes
    DocTemplateEntity
    Annotations
    @deprecated
    Deprecated

    (Since version 2.9.0) Use linearizationTemplates and linearizationTypes 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. 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 Object

Inherited from DocTemplateEntity

Inherited from MemberEntity

Inherited from TemplateEntity

Inherited from Entity

Inherited from AnyRef

Inherited from Any