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 DiagramFactory with CommentFactory with TreeFactory
Source
ModelFactory.scala
Linear Supertypes
AnyRef, Any
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 MemberImpl with TemplateImpl with HigherKindedImpl 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 EntityImpl with MemberEntity

  5. class NoDocTemplateImpl extends EntityImpl with TemplateImpl with HigherKindedImpl with NoDocTemplate

    A template that is not documented at all.

  6. class NoDocTemplateMemberImpl extends MemberImpl with TemplateImpl with HigherKindedImpl with NoDocTemplateMemberEntity

    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 NoDocTemplateMemberImpl -- that is, U has a member for it but C doesn't get its own page

  7. abstract class NonTemplateMemberImpl extends MemberImpl with NonTemplateMemberEntity

  8. abstract class NonTemplateParamMemberImpl extends NonTemplateMemberImpl

  9. abstract class PackageImpl extends DocTemplateImpl with Package

  10. abstract class ParameterImpl extends ParameterEntity

  11. abstract class RootPackageImpl extends PackageImpl with RootPackage

  12. trait TemplateImpl extends 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  11. val docTemplatesCache: LinkedHashMap[Symbol, DocTemplateImpl]

    Attributes
    protected

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

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

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

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

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

    Definition Classes
    AnyRef

  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  18. def finalize(): Unit

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

  19. def findMember(aSym: Symbol, inTpl: DocTemplateImpl): Option[MemberImpl]

  20. def findTemplate(query: String): Option[DocTemplateImpl]

  21. def findTemplateMaybe(aSym: Symbol): Option[DocTemplateImpl]

  22. 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()

  23. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  24. val global: Global

  25. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  26. var ids: Int

  27. def implicitExcluded(convertorMethod: String): Boolean

  28. def inOriginalOnwer(aSym: Symbol, inTpl: TemplateImpl): Boolean

  29. def isEmptyJavaObject(aSym: Symbol): Boolean

  30. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  31. def isPureBridge(sym: 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

  32. def localShouldDocument(aSym: Symbol): Boolean

  33. def makeAnnotation(annot: AnnotationInfo): Annotation

  34. def makeMember(aSym: Symbol, implConv: ImplicitConversionImpl, inTpl: DocTemplateImpl): List[MemberImpl]

  35. def makeModel: Option[Universe]

  36. def makeParentTypes(aType: Type, tpl: Option[DocTemplateImpl], inTpl: TemplateImpl): List[(TemplateEntity, TypeEntity)]

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

  37. def makeRootPackage: PackageImpl

    Get the root package

  38. def makeTemplate(aSym: Symbol): TemplateImpl

  39. def makeType(aType: Type, inTpl: TemplateImpl): TypeEntity

  40. def makeTypeInTemplateContext(aType: Type, inTpl: TemplateImpl, dclSym: Symbol): TypeEntity

  41. def makeTypeParam(aSym: Symbol, inTpl: TemplateImpl): TypeParam

  42. def makeValueParam(aSym: Symbol, inTpl: DocTemplateImpl, newName: String): ValueParam

  43. def makeValueParam(aSym: Symbol, inTpl: DocTemplateImpl): ValueParam

  44. def membersShouldDocument(sym: Symbol, inTpl: TemplateImpl): Boolean

  45. object modelCreation

    These are all model construction methods.

  46. def modelFinished: Boolean

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

    Definition Classes
    AnyRef

  48. val noDocTemplatesCache: LinkedHashMap[Symbol, NoDocTemplateImpl]

    Attributes
    protected

  49. def normalizeOwner(aSym: Symbol): Symbol

  50. def normalizeTemplate(aSym: Symbol): Symbol

  51. final def notify(): Unit

    Definition Classes
    AnyRef

  52. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  53. def optimize(str: String): String

  54. val settings: Settings

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

    Definition Classes
    AnyRef

  56. def templateShouldDocument(aSym: Symbol, inTpl: TemplateImpl): Boolean

  57. def templatesCount: Int

  58. def toString(): String

    Definition Classes
    AnyRef → Any

  59. var typeCache: LinkedHashMap[Type, TypeEntity]

    Attributes
    protected

  60. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

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