scala.tools.nsc.doc

DocFactory

class DocFactory extends AnyRef

A documentation processor controls the process of generating Scala documentation, which is as follows.

* A simplified compiler instance (with only the front-end phases enabled) is created, and additional sourceless comments are registered. * Documentable files are compiled, thereby filling the compiler's symbol table. * A documentation model is extracted from the post-compilation symbol table. * A generator is used to transform the model into the correct final format (HTML).

A processor contains a single compiler instantiated from the processor's settings. Each call to document uses the same compiler instance with the same symbol table. In particular, this implies that the scaladoc site obtained from a call to run will contain documentation about files compiled during previous calls to the same processor's run method.

Self Type
DocFactory
Source
DocFactory.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. DocFactory
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DocFactory (reporter: Reporter, settings: Settings)

    reporter

    The reporter to which both documentation and compilation errors will be reported.

    settings

    The settings to be used by the documenter and compiler for generating documentation.

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. object NoCompilerRunException extends Throwable with ControlThrowable

  7. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  8. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  9. object compiler extends Global with RangePositions

    The unique compiler instance used by this processor and constructed from its settings.

  10. def document (files: List[String]): Unit

    Generate document(s) for all files containing scaladoc documenataion.

    Generate document(s) for all files containing scaladoc documenataion.

    files

    The list of paths (relative to the compiler's source path, or absolute) of files to document.

  11. val documentError : PartialFunction[Throwable, Unit]

  12. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  13. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  14. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  15. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  16. def hashCode (): Int

    Definition Classes
    AnyRef → Any
  17. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  18. def makeUniverse (files: List[String]): Option[Universe]

    Creates a scaladoc site for all symbols defined in this call's files, as well as those defined in files of previous calls to the same processor.

    Creates a scaladoc site for all symbols defined in this call's files, as well as those defined in files of previous calls to the same processor.

    files

    The list of paths (relative to the compiler's source path, or absolute) of files to document.

  19. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  20. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  21. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  22. val reporter : Reporter

    The reporter to which both documentation and compilation errors will be reported.

  23. val settings : Settings

    The settings to be used by the documenter and compiler for generating documentation.

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

    Attributes
    final
    Definition Classes
    AnyRef
  25. def toString (): String

    Definition Classes
    AnyRef → Any
  26. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  27. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  28. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from AnyRef

Inherited from Any