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 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 any2stringfmt
  2. by any2stringadd
  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 EntityImpl with HigherKinded

  4. abstract class MemberImpl extends EntityImpl with MemberEntity

  5. class NoDocTemplateImpl extends EntityImpl with TemplateImpl with NoDocTemplate

  6. abstract class NonTemplateMemberImpl extends MemberImpl with NonTemplateMemberEntity

  7. abstract class NonTemplateParamMemberImpl extends NonTemplateMemberImpl

  8. abstract class PackageImpl extends DocTemplateImpl with Package

  9. abstract class ParameterImpl extends EntityImpl with ParameterEntity

  10. abstract class RootPackageImpl extends PackageImpl with RootPackage

  11. 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 clone(): AnyRef

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

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

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

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

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

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

    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  16. def finalize(): Unit

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

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

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

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

    Definition Classes
    AnyRef → Any

  20. val global: Global

  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  22. def isEmptyJavaObject(aSym: Symbol): Boolean

  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

  25. def localShouldDocument(aSym: Symbol): Boolean

  26. def makeAnnotation(annot: AnnotationInfo): Annotation

  27. def makeDocTemplate(aSym: Symbol, inTpl: ⇒ DocTemplateImpl): DocTemplateImpl

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

  29. def makeModel: Option[Universe]

  30. def makePackage(aSym: Symbol, inTpl: ⇒ PackageImpl): Option[PackageImpl]

    Creates a package entity for the given symbol or returns None if the symbol does not denote a package that contains at least one documentable class, trait or object.

    Creates a package entity for the given symbol or returns None if the symbol does not denote a package that contains at least one documentable class, trait or object. Creating a package entity

  31. def makeRootPackage: Option[PackageImpl]

  32. def makeTemplate(aSym: Symbol): TemplateImpl

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

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

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

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

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

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

    Definition Classes
    AnyRef

  39. def normalizeTemplate(aSym: Symbol): Symbol

  40. final def notify(): Unit

    Definition Classes
    AnyRef

  41. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  42. def optimize(str: String): String

  43. val self: Any

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

  44. val self: Any

    Implicit information
    This member is added by an implicit conversion from ModelFactory to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  45. val settings: Settings

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

    Definition Classes
    AnyRef

  47. def templateShouldDocument(aSym: Symbol): Boolean

  48. val templatesCache: LinkedHashMap[Symbol, DocTemplateImpl]

    Attributes
    protected

  49. def templatesCount: Int

  50. def toString(): String

    Definition Classes
    AnyRef → Any

  51. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

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.
    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.
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringfmt from ModelFactory to StringFormat

Inherited by implicit conversion any2stringadd from ModelFactory to StringAdd

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

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