scala.tools.nsc.doc.model

ModelFactory

class ModelFactory extends AnyRef

This trait extracts all required information for documentation from compilation units

Self Type
ModelFactory with ModelFactoryImplicitSupport with ModelFactoryTypeSupport with DiagramFactory with CommentFactory with TreeFactory with MemberLookup
Source
ModelFactory.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ModelFactory
  2. AnyRef
  3. 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

Instance Constructors

  1. new ModelFactory(global: Global, settings: Settings)

Type Members

  1. abstract class DocTemplateImpl extends (ModelFactory.this)#MemberTemplateImpl with DocTemplateEntity

    The instantiation of TemplateImpl triggers the creation of the following entities: All ancestors of the template and all non-package members.

  2. abstract class EntityImpl extends Entity

  3. trait HigherKindedImpl extends HigherKinded

  4. abstract class MemberImpl extends (ModelFactory.this)#EntityImpl with MemberEntity

  5. abstract class MemberTemplateImpl extends (ModelFactory.this)#MemberImpl with (ModelFactory.this)#TemplateImpl with (ModelFactory.this)#HigherKindedImpl with MemberTemplateEntity

    An inherited template that was not documented in its original owner - example: in classpath: trait T { class C } -- T (and implicitly C) are not documented in the source: trait U extends T -- C appears in U as a MemberTemplateImpl -- that is, U has a member for it but C doesn't get its own page

  6. class NoDocTemplateImpl extends (ModelFactory.this)#EntityImpl with (ModelFactory.this)#TemplateImpl with (ModelFactory.this)#HigherKindedImpl with NoDocTemplate

    A template that is not documented at all.

  7. abstract class NonTemplateMemberImpl extends (ModelFactory.this)#MemberImpl with NonTemplateMemberEntity

  8. abstract class NonTemplateParamMemberImpl extends (ModelFactory.this)#NonTemplateMemberImpl

  9. abstract class PackageImpl extends (ModelFactory.this)#DocTemplateImpl with Package

  10. abstract class ParameterImpl extends ParameterEntity

  11. abstract class RootPackageImpl extends (ModelFactory.this)#PackageImpl with RootPackage

  12. trait TemplateImpl extends (ModelFactory.this)#EntityImpl with TemplateEntity

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 ModelFactory to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (ModelFactory, B)

    Implicit information
    This member is added by an implicit conversion from ModelFactory to ArrowAssoc[ModelFactory] 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 classExcluded(clazz: TemplateEntity): Boolean

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  11. def closestPackage(sym: Global.Symbol): Global.Symbol

    Attributes
    protected

  12. val defaultGroup: String

  13. val defaultGroupDesc: None.type

  14. val defaultGroupName: String

  15. val defaultGroupPriority: Int

  16. val docTemplatesCache: LinkedHashMap[Global.Symbol, (ModelFactory.this)#DocTemplateImpl]

    Attributes
    protected

  17. def ensuring(cond: (ModelFactory) ⇒ Boolean, msg: ⇒ Any): ModelFactory

    Implicit information
    This member is added by an implicit conversion from ModelFactory to Ensuring[ModelFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  18. def ensuring(cond: (ModelFactory) ⇒ Boolean): ModelFactory

    Implicit information
    This member is added by an implicit conversion from ModelFactory to Ensuring[ModelFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  19. def ensuring(cond: Boolean, msg: ⇒ Any): ModelFactory

    Implicit information
    This member is added by an implicit conversion from ModelFactory to Ensuring[ModelFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  20. def ensuring(cond: Boolean): ModelFactory

    Implicit information
    This member is added by an implicit conversion from ModelFactory to Ensuring[ModelFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  21. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  22. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  23. def externalSignature(sym: Global.Symbol): String

  24. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  25. def findExternalLink(name: String): Option[LinkTo]

  26. def findMember(aSym: Global.Symbol, inTpl: (ModelFactory.this)#DocTemplateImpl): Option[(ModelFactory.this)#MemberImpl]

  27. def findTemplateMaybe(aSym: Global.Symbol): Option[(ModelFactory.this)#DocTemplateImpl]

  28. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from ModelFactory to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Definition Classes
    AnyRef → Any

  30. val global: Global

  31. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  32. var ids: Int

  33. def implicitExcluded(convertorMethod: String): Boolean

  34. def inOriginalOwner(aSym: Global.Symbol, inTpl: (ModelFactory.this)#TemplateImpl): Boolean

  35. def isEmptyJavaObject(aSym: Global.Symbol): Boolean

  36. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  37. def isPureBridge(sym: Global.Symbol): Boolean

    Filter '@bridge' methods only if *they don't override non-bridge methods*.

    Filter '@bridge' methods only if *they don't override non-bridge methods*. See SI-5373 for details

  38. def localShouldDocument(aSym: Global.Symbol): Boolean

  39. def makeAnnotation(annot: Global.AnnotationInfo): Annotation

  40. def makeMember(aSym: Global.Symbol, conversion: Option[(ModelFactory.this)#ImplicitConversionImpl], inTpl: (ModelFactory.this)#DocTemplateImpl): List[(ModelFactory.this)#MemberImpl]

  41. def makeModel: Option[Universe]

  42. def makeParentTypes(aType: Global.Type, tpl: Option[(ModelFactory.this)#MemberTemplateImpl], inTpl: (ModelFactory.this)#TemplateImpl): List[(TemplateEntity, TypeEntity)]

    Get the types of the parents of the current class, ignoring the refinements

  43. def makeQualifiedName(sym: Global.Symbol, relativeTo: Option[Global.Symbol] = None): String

  44. def makeRootPackage: (ModelFactory.this)#PackageImpl

    Get the root package

  45. def makeTemplate(aSym: Global.Symbol, inTpl: Option[(ModelFactory.this)#TemplateImpl]): (ModelFactory.this)#TemplateImpl

  46. def makeTemplate(aSym: Global.Symbol): (ModelFactory.this)#TemplateImpl

  47. def makeTypeInTemplateContext(aType: Global.Type, inTpl: (ModelFactory.this)#TemplateImpl, dclSym: Global.Symbol): TypeEntity

  48. def makeTypeParam(aSym: Global.Symbol, inTpl: (ModelFactory.this)#TemplateImpl): TypeParam

  49. def makeValueParam(aSym: Global.Symbol, inTpl: (ModelFactory.this)#DocTemplateImpl, newName: String): ValueParam

  50. def makeValueParam(aSym: Global.Symbol, inTpl: (ModelFactory.this)#DocTemplateImpl): ValueParam

  51. def membersShouldDocument(sym: Global.Symbol, inTpl: (ModelFactory.this)#TemplateImpl): Boolean

  52. object modelCreation

    These are all model construction methods.

  53. def modelFinished: Boolean

  54. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  55. val noDocTemplatesCache: LinkedHashMap[Global.Symbol, (ModelFactory.this)#NoDocTemplateImpl]

    Attributes
    protected

  56. def normalizeTemplate(aSym: Global.Symbol): Global.Symbol

    This method makes it easier to work with the different kinds of symbols created by scalac by stripping down the package object abstraction and placing members directly in the package.

    This method makes it easier to work with the different kinds of symbols created by scalac by stripping down the package object abstraction and placing members directly in the package.

    Here's the explanation of what we do. The code:

    package foo { object package { class Bar } }

    will yield this Symbol structure: +---------+ (2) | | +---------------+ +---------- v ------- | ---+ +--------+ (2) | package foo#1 <---(1)---- module class foo#2 | | | | +---------------+ | +------------------ | -+ | +------------------- v ---+ | | | package object foo#3 <-----(1)---- module class package#4 | | | +----------------------+ | | +---------------------+ | | +--------------------------+ | | class package$Bar#5 | | | | +----------------- | -+ | | +------------------- | ---+ | | | +--------+ (1) sourceModule (2) you get out of owners with .owner

    and normalizeTemplate(Bar.owner) will get us the package, instead of the module class of the package object.

  57. final def notify(): Unit

    Definition Classes
    AnyRef

  58. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  59. def optimize(str: String): String

  60. def packageDropped(tpl: (ModelFactory.this)#DocTemplateImpl): Boolean

  61. val settings: Settings

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

    Definition Classes
    AnyRef

  63. def templateShouldDocument(aSym: Global.Symbol, inTpl: (ModelFactory.this)#DocTemplateImpl): Boolean

  64. def templatesCount: Int

  65. def toString(): String

    Definition Classes
    AnyRef → Any

  66. def typeShouldDocument(bSym: Global.Symbol, inTpl: (ModelFactory.this)#DocTemplateImpl): Boolean

  67. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

  69. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  70. def →[B](y: B): (ModelFactory, B)

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

  2. val self: Any

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

Deprecated Value Members

  1. def findTemplate(query: String): Option[(ModelFactory.this)#DocTemplateImpl]

    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use findLinkTarget instead.

  2. def x: ModelFactory

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

    (Since version 2.10.0) Use leftOfArrow instead

  3. def x: ModelFactory

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

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ModelFactory to StringAdd

Inherited by implicit conversion any2stringfmt from ModelFactory to StringFormat

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

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

Ungrouped