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 CommentFactory with TreeFactory
Source
ModelFactory.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. ModelFactory
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All

Instance Constructors

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

Type Members

  1. class DocTemplateImpl extends MemberImpl with TemplateImpl with HigherKindedImpl with DocTemplateEntity

    Provides a default implementation for instances of the TemplateEntity type.

  2. class EntityImpl extends Entity

    Provides a default implementation for instances of the Entity type.

  3. trait HigherKindedImpl extends EntityImpl with HigherKinded

  4. class MemberImpl extends EntityImpl with MemberEntity

    Provides a default implementation for instances of the MemberEntity type.

  5. class NoDocTemplateImpl extends EntityImpl with TemplateImpl with NoDocTemplate

    Provides a default implementation for instances of the WeakTemplateEntity type.

  6. class NonTemplateMemberImpl extends MemberImpl with NonTemplateMemberEntity

    Attributes
    abstract

  7. class NonTemplateParamMemberImpl extends NonTemplateMemberImpl

    Attributes
    abstract

  8. class PackageImpl extends DocTemplateImpl with Package

    Attributes
    abstract

  9. class ParameterImpl extends EntityImpl with ParameterEntity

    Attributes
    abstract

  10. class RootPackageImpl extends PackageImpl with RootPackage

    Attributes
    abstract

  11. trait TemplateImpl extends EntityImpl with TemplateEntity

    Provides a default implementation for instances of the WeakTemplateEntity type.

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

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

    Attributes
    final
    Definition Classes
    Any

  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  7. def clone (): AnyRef

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

  8. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  9. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize (): Unit

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

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

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

    Attributes
    final
    Definition Classes
    AnyRef → Any

  13. val global : Global

  14. def hashCode (): Int

    Definition Classes
    AnyRef → Any

  15. def isEmptyJavaObject (aSym: Symbol): Boolean

  16. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  17. def localShouldDocument (aSym: Symbol): Boolean

  18. def makeAnnotation (annot: AnnotationInfo): Annotation

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

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

  21. def makeModel : Option[Universe]

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

  23. def makeRootPackage : Option[PackageImpl]

  24. def makeTemplate (aSym: Symbol): TemplateImpl

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

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

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

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

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

  30. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  31. def normalizeTemplate (aSym: Symbol): Symbol

  32. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  33. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  34. def optimize (str: String): String

  35. val settings : Settings

  36. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  37. def templateShouldDocument (aSym: Symbol): Boolean

  38. val templatesCache : LinkedHashMap[Symbol, DocTemplateImpl]

    Attributes
    protected

  39. def templatesCount : Int

  40. def toString (): String

    Definition Classes
    AnyRef → Any

  41. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  43. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from AnyRef

Inherited from Any