Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  def +(other: String): String

   Implicit

   This member is added by an implicit conversion from (ModelFactory.this)#RootPackageImpl to any2stringadd[(ModelFactory.this)#RootPackageImpl] performed by method any2stringadd in scala.Predef.

   Definition Classes

   any2stringadd

4.  def ->[B](y: B): ((ModelFactory.this)#RootPackageImpl, B)

   Implicit

   This member is added by an implicit conversion from (ModelFactory.this)#RootPackageImpl to ArrowAssoc[(ModelFactory.this)#RootPackageImpl] performed by method ArrowAssoc in scala.Predef.

   Definition Classes

   ArrowAssoc

   Annotations

   @inline()

5.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

6.  def abstractTypes: List[AbstractType]

   All abstract types that are members of this template.

   All abstract types that are members of this template.

   Definition Classes

   DocTemplateImpl → DocTemplateEntity

7.  def aliasTypes: List[AliasType]

   All type aliases that are members of this template.

   All type aliases that are members of this template.

   Definition Classes

   DocTemplateImpl → DocTemplateEntity

8.  def annotations: List[Annotation]

   The annotations attached to this entity, if any.

   The annotations attached to this entity, if any.

   Definition Classes

   EntityImpl → Entity

9.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

10.  def byConversion: Option[(ModelFactory.this)#ImplicitConversionImpl]

    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

    MemberImpl → MemberEntity

11.  def clone(): AnyRef

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @native() @throws( ... )

12.  lazy val comment: Option[Comment]

    The comment attached to this member, if any.

    The comment attached to this member, if any.

    Definition Classes

    MemberImpl → MemberEntity

13.  def commentCarryingSymbol(sym: Global.Symbol): Global.Symbol

    Attributes

    protected[this]

    Definition Classes

    MemberImpl

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

    DocTemplateImpl → DocTemplateEntity

15.  def completeModel(): Unit

    This is the final point in the core model creation: no DocTemplates are created after the model has finished, but inherited templates and implicit members are added to the members at this point.

    This is the final point in the core model creation: no DocTemplates are created after the model has finished, but inherited templates and implicit members are added to the members at this point.

    Definition Classes

    DocTemplateImpl

16.  def constructors: List[(ModelFactory.this)#MemberImpl with Constructor]

    All constructors of this class, including the primary constructor.

    All constructors of this class, including the primary constructor.

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

17.  def contentDiagram: Option[Diagram]

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

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

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

18.  val conversions: List[(ModelFactory.this)#ImplicitConversionImpl]

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

19.  lazy val 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

    MemberTemplateImpl → MemberEntity

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

    MemberImpl → MemberEntity

21.  def directSubClasses: List[DocTemplateEntity]

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

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

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

22.  def ensuring(cond: ((ModelFactory.this)#RootPackageImpl) ⇒ Boolean, msg: ⇒ Any): (ModelFactory.this)#RootPackageImpl

    Implicit

    This member is added by an implicit conversion from (ModelFactory.this)#RootPackageImpl to Ensuring[(ModelFactory.this)#RootPackageImpl] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

23.  def ensuring(cond: ((ModelFactory.this)#RootPackageImpl) ⇒ Boolean): (ModelFactory.this)#RootPackageImpl

    Implicit

    This member is added by an implicit conversion from (ModelFactory.this)#RootPackageImpl to Ensuring[(ModelFactory.this)#RootPackageImpl] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

24.  def ensuring(cond: Boolean, msg: ⇒ Any): (ModelFactory.this)#RootPackageImpl

    Implicit

    This member is added by an implicit conversion from (ModelFactory.this)#RootPackageImpl to Ensuring[(ModelFactory.this)#RootPackageImpl] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

25.  def ensuring(cond: Boolean): (ModelFactory.this)#RootPackageImpl

    Implicit

    This member is added by an implicit conversion from (ModelFactory.this)#RootPackageImpl to Ensuring[(ModelFactory.this)#RootPackageImpl] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

26.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

27.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

28.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

29.  def flags: collection.immutable.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

    MemberImpl → MemberEntity

30.  def formatted(fmtstr: String): String

    Implicit

    This member is added by an implicit conversion from (ModelFactory.this)#RootPackageImpl to StringFormat[(ModelFactory.this)#RootPackageImpl] performed by method StringFormat in scala.Predef.

    Definition Classes

    StringFormat

    Annotations

    @inline()

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

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

32.  def group: String

    The group this member is from

    The group this member is from

    Definition Classes

    MemberImpl → MemberEntity

33.  def groupDescription(group: String): Option[Body]

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

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

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

34.  def groupName(group: String): String

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

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

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

35.  def groupPriority(group: String): Int

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

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

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

36.  def groupSearch[T](extractor: (Comment) ⇒ Option[T]): Option[T]

    Definition Classes

    DocTemplateImpl

37.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

38.  var implicitsShadowing: Map[MemberEntity, ImplicitMemberShadowing]

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

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

    MemberImpl → MemberEntity

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

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

    DocTemplateImpl → DocTemplateEntity

42.  def inTemplate: (ModelFactory.this)#PackageImpl

    The package of which this package is a member.

    The package of which this package is a member.

    Definition Classes

    PackageImpl → Package → MemberImpl → MemberEntity → EntityImpl → Entity

43.  val inTpl: (ModelFactory.this)#TemplateImpl

    Definition Classes

    EntityImpl

44.  def incomingImplicitlyConvertedClasses: List[((ModelFactory.this)#DocTemplateImpl, (ModelFactory.this)#ImplicitConversionImpl)]

    Classes that can be implicitly converted to this class

    Classes that can be implicitly converted to this class

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

45.  def inheritanceDiagram: Option[Diagram]

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

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

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

46.  def isAbstract: Boolean

    Whether this member is abstract.

    Whether this member is abstract.

    Definition Classes

    MemberImpl → MemberEntity

47.  def isAbstractType: Boolean

    Whether this member is an abstract type.

    Whether this member is an abstract type.

    Definition Classes

    MemberImpl → MemberEntity

48.  def isAliasType: Boolean

    Whether this member is an alias type.

    Whether this member is an alias type.

    Definition Classes

    MemberImpl → MemberEntity

49.  def isAmbiguousImplicit: Boolean

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

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

    Definition Classes

    MemberImpl → MemberEntity

50.  def isCaseClass: Boolean

    Whether this template is a case class.

    Whether this template is a case class.

    Definition Classes

    TemplateImpl → TemplateEntity

51.  def isClass: Boolean

    Whether this template is a class.

    Whether this template is a class.

    Definition Classes

    TemplateImpl → TemplateEntity

52.  def isConstructor: Boolean

    Whether this member is a constructor.

    Whether this member is a constructor.

    Definition Classes

    MemberImpl → MemberEntity

53.  def isDef: Boolean

    Whether this member is a method.

    Whether this member is a method.

    Definition Classes

    MemberImpl → MemberEntity

54.  def isDocTemplate: Boolean

    Whether documentation is available for this template.

    Whether documentation is available for this template.

    Definition Classes

    DocTemplateImpl → MemberTemplateImpl → TemplateEntity

55.  def isImplicitlyInherited: Boolean

    Indicates whether the member is inherited by implicit conversion

    Indicates whether the member is inherited by implicit conversion

    Definition Classes

    MemberImpl → MemberEntity

56.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

57.  def isLazyVal: Boolean

    Whether this member is a lazy value.

    Whether this member is a lazy value.

    Definition Classes

    MemberImpl → MemberEntity

58.  def isObject: Boolean

    Whether this template is an object.

    Whether this template is an object.

    Definition Classes

    TemplateImpl → TemplateEntity

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

60.  def isRootPackage: Boolean

    Whether this template is the root package.

    Whether this template is the root package.

    Definition Classes

    TemplateImpl → TemplateEntity

61.  def isShadowedImplicit: Boolean

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

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

    Definition Classes

    MemberImpl → MemberEntity

62.  def isShadowedOrAmbiguousImplicit: Boolean

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

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

    Definition Classes

    MemberImpl → MemberEntity

63.  def isTrait: Boolean

    Whether this template is a trait.

    Whether this template is a trait.

    Definition Classes

    TemplateImpl → TemplateEntity

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

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

    MemberImpl → MemberEntity

66.  def isVar: Boolean

    Whether this member is a variable.

    Whether this member is a variable.

    Definition Classes

    MemberImpl → MemberEntity

67.  def kind: String

    The kind of the entity

    The kind of the entity

    Definition Classes

    Package → Entity

68.  lazy val linearizationTemplates: collection.immutable.List[(ModelFactory.this)#TemplateImpl]

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

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

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

69.  lazy val linearizationTypes: collection.immutable.List[TypeEntity]

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

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

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

70.  def linkTarget: (ModelFactory.this)#DocTemplateImpl

    Definition Classes

    DocTemplateImpl → MemberImpl

71.  lazy val memberSyms: List[Global.Symbol]

    Definition Classes

    DocTemplateImpl

72.  val memberSymsEager: collection.immutable.List[Global.Symbol]

    Definition Classes

    DocTemplateImpl

73.  val memberSymsLazy: collection.immutable.List[Global.Symbol]

    Definition Classes

    DocTemplateImpl

74.  var members: List[(ModelFactory.this)#MemberImpl]

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

75.  def methods: List[Def]

    All methods that are members of this template.

    All methods that are members of this template.

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

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

    MemberImpl → MemberEntity

77.  val name: String

    Definition Classes

    EntityImpl → Entity

78.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

79.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

80.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

81.  lazy val outgoingImplicitlyConvertedClasses: List[(TemplateEntity, TypeEntity, (ModelFactory.this)#ImplicitConversionImpl)]

    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

    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

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

82.  val ownMembers: collection.immutable.List[(ModelFactory.this)#MemberImpl]

    Definition Classes

    DocTemplateImpl

83.  def packages: List[Package]

    All packages that are member of this package.

    All packages that are member of this package.

    Definition Classes

    PackageImpl → Package

84.  def parentTypes: List[(TemplateEntity, TypeEntity)]

    TODO, these are now only computed for DocTemplates

    TODO, these are now only computed for DocTemplates

    Definition Classes

    MemberTemplateImpl → MemberTemplateEntity

85.  def primaryConstructor: Option[(ModelFactory.this)#MemberImpl with Constructor]

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

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

    Definition Classes

    DocTemplateImpl → DocTemplateEntity

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

87.  def registerImplicitlyConvertibleClass(dtpl: (ModelFactory.this)#DocTemplateImpl, conv: (ModelFactory.this)#ImplicitConversionImpl): Unit

    Definition Classes

    DocTemplateImpl

88.  def registerSubClass(sc: DocTemplateEntity): Unit

    Definition Classes

    DocTemplateImpl

89.  def reprSymbol: Global.Symbol

    Definition Classes

    PackageImpl → DocTemplateImpl

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

    MemberImpl → MemberEntity

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

92.  def signature: String

    The identity of this member, used for linking

    The identity of this member, used for linking

    Definition Classes

    MemberImpl → MemberEntity

93.  lazy val signatureCompat: String

    Compatibility signature, will be removed from future versions

    Compatibility signature, will be removed from future versions

    Definition Classes

    MemberImpl → MemberEntity

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

    DocTemplateImpl → DocTemplateEntity

95.  val sym: Global.Symbol

    Definition Classes

    EntityImpl

96.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

97.  def templates: List[TemplateEntity with MemberEntity]

    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

    DocTemplateImpl → DocTemplateEntity

98.  def toRoot: List[(ModelFactory.this)#PackageImpl]

    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

    PackageImpl → Package → DocTemplateImpl → DocTemplateEntity → MemberImpl → MemberEntity → EntityImpl → Entity

99.  def toString(): String

    The qualified name of this entity.

    The qualified name of this entity.

    Definition Classes

    Entity → AnyRef → Any

100.  def typeParams: List[TypeParam]

     The type parameters of this entity.

     The type parameters of this entity.

     Definition Classes

     HigherKindedImpl → HigherKinded

101.  val universe: Universe

     Definition Classes

     EntityImpl → Entity

102.  def useCaseOf: Option[(ModelFactory.this)#MemberImpl]

     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

     MemberImpl → MemberEntity

103.  def valueParams: List[List[ValueParam]]

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

     The value parameters of this case class, or an empty list if this class is not a case class. As case class value parameters cannot be curried, the outer list has exactly one element.

     Definition Classes

     DocTemplateImpl → MemberTemplateImpl → MemberTemplateEntity

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

     DocTemplateImpl → DocTemplateEntity

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

     MemberImpl → MemberEntity

106.  final def wait(): Unit

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

108.  final def wait(arg0: Long): Unit

     Definition Classes

     AnyRef

     Annotations

     @native() @throws( ... )

109.  def →[B](y: B): ((ModelFactory.this)#RootPackageImpl, B)

     Implicit

     This member is added by an implicit conversion from (ModelFactory.this)#RootPackageImpl to ArrowAssoc[(ModelFactory.this)#RootPackageImpl] performed by method ArrowAssoc in scala.Predef.

     Definition Classes

     ArrowAssoc