Package

abstract def abstractTypes: List[AbstractType]

All abstract types that are members of this template.

abstract def aliasTypes: List[AliasType]

All type aliases that are members of this template.

abstract def allSubClasses: List[DocTemplateEntity]

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

abstract def annotations: List[Annotation]

The annotations attached to this entity, if any.

abstract def byConversion: Option[ImplicitConversion]

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

abstract def comment: Option[Comment]

The comment attached to this member, if any.

abstract def companion: Option[DocTemplateEntity]

The companion of this template, or none.

abstract def constructors: List[Constructor]

All constructors of this class, including the primary constructor.

abstract def contentDiagram: Option[Diagram]

If this template contains other templates, such as classes and traits, they will be shown in this diagram

abstract def conversions: List[ImplicitConversion]

The implicit conversions this template (class or trait, objects and packages are not affected)

abstract def definitionName: String

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

abstract def deprecation: Option[Body]

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

abstract def directSubClasses: List[DocTemplateEntity]

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

abstract def flags: List[Paragraph]

The flags that have been set for this entity.

abstract def group: String

The group this member is from

abstract def groupDescription(group: String): Option[Body]

Returns the group description taken either from this template or its linearizationTypes

abstract def groupName(group: String): String

Returns the group description taken either from this template or its linearizationTypes

abstract def groupPriority(group: String): Int

Returns the group description taken either from this template or its linearizationTypes

abstract def id: Int

Similar to symbols, so we can track entities

abstract def implicitsShadowing: Map[MemberEntity, ImplicitMemberShadowing]

The shadowing information for the implicitly added members

abstract def inDefinitionTemplates: List[TemplateEntity]

The templates in which this member has been declared.

abstract def inPackageObject: Boolean

Whether or not the template was defined in a package object

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.

abstract def inTemplate: Package

The package of which this package is a member.

abstract def incomingImplicitlyConvertedClasses: List[(DocTemplateEntity, ImplicitConversion)]

Classes that can be implcitly converted to this class

abstract def inheritanceDiagram: Option[Diagram]

If this template takes place in inheritance and implicit conversion relations, it will be shown in this diagram

abstract def isAbstract: Boolean

Whether this member is abstract.

abstract def isAbstractType: Boolean

Whether this member is an abstract type.

abstract def isAliasType: Boolean

Whether this member is an alias type.

abstract def isAmbiguousImplicit: Boolean

Indicates whether there are other implicitly inherited members that have similar signatures (and thus they all become ambiguous)

abstract def isCaseClass: Boolean

Whether this template is a case class.

abstract def isClass: Boolean

Whether this template is a class.

abstract def isConstructor: Boolean

Whether this member is a constructor.

abstract def isDef: Boolean

Whether this member is a method.

abstract def isDocTemplate: Boolean

Whether documentation is available for this template.

abstract def isImplicit: Boolean

Whether this member is implicit.

abstract def isImplicitlyInherited: Boolean

Indicates whether the member is inherited by implicit conversion

abstract def isLazyVal: Boolean

Whether this member is a lazy value.

abstract def isNoDocMemberTemplate: Boolean

Whether documentation is available for this template.

abstract def isObject: Boolean

Whether this template is an object.

abstract def isPackage: Boolean

Whether this template is a package (including the root package).

abstract def isRootPackage: Boolean

Whether this template is the root package.

abstract def isShadowedImplicit: Boolean

Indicates whether there is another member with the same name in the template that will take precendence

abstract def isShadowedOrAmbiguousImplicit: Boolean

Indicates whether the implicitly inherited member is shadowed or ambiguous in its template

abstract def isTemplate: Boolean

Whether this member is a template.

abstract def isTerm: Boolean

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

abstract def isTrait: Boolean

Whether this template is a trait.

abstract def isType: Boolean

Indicates whether this entity lives in the types namespace (classes, traits, abstract/alias types)

abstract def isVal: Boolean

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

abstract def isVar: Boolean

Whether this member is a variable.

abstract def linearizationTemplates: List[TemplateEntity]

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

abstract def linearizationTypes: List[TypeEntity]

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

abstract def members: List[MemberEntity]

All members of this template.

abstract def methods: List[Def]

All methods that are members of this template.

abstract def migration: Option[Body]

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

abstract def name: String

The name of the entity.

abstract def outgoingImplicitlyConvertedClasses: List[(TemplateEntity, TypeEntity, ImplicitConversion)]

Classes to which this class can be implicitly converted to NOTE: Some classes might not be included in the scaladoc run so they will be NoDocTemplateEntities

abstract def packages: List[Package]

All packages that are member of this package.

abstract def parentTypes: List[(TemplateEntity, TypeEntity)]

The direct super-type of this template e.

class A extends B[C[Int]] with D[E]

abstract def primaryConstructor: Option[Constructor]

The primary constructor of this class, if it has been defined.

abstract def qualifiedName: String

The qualified name of the entity.

abstract def resultType: TypeEntity

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

abstract def selfType: Option[TypeEntity]

The self-type of this template, if it differs from the template type.

abstract def signature: String

The identity of this member, used for linking

abstract def signatureCompat: String

Compatibility signature, will be removed from future versions

abstract def sourceUrl: Option[URL]

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

abstract def templates: List[TemplateEntity with MemberEntity]

All templates that are members of this template.

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.

abstract def typeParams: List[TypeParam]

The type parameters of this entity.

abstract def universe: Universe

The Scaladoc universe of which this entity is a member.

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

abstract def valueParams: List[List[ValueParam]]

The value parameters of this case class, or an empty list if this class is not a case class.

abstract def values: List[Val]

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

abstract def visibility: Visibility

The visibility of this member.

abstract def inheritedFrom: List[TemplateEntity]

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Package, B)

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (Package) ⇒ Boolean, msg: ⇒ Any): Package

def ensuring(cond: (Package) ⇒ Boolean): Package

def ensuring(cond: Boolean, msg: ⇒ Any): Package

def ensuring(cond: Boolean): Package

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): java.lang.Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def kind: String

The kind of the entity

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

The qualified name of this entity.

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (Package, B)

val self: Any

val self: Any

def x: Package

def x: Package