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
- Alphabetic
- By Inheritance
- DocFactory
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
Value Members
-
def
document(files: List[String]): Unit
Generate document(s) for all
files
containing scaladoc documentation.Generate document(s) for all
files
containing scaladoc documentation.- files
The list of paths (relative to the compiler's source path, or absolute) of files to document.
- val documentError: PartialFunction[Throwable, Unit]
-
def
makeUniverse(source: Either[List[String], String]): Option[Universe]
Creates a scaladoc site for all symbols defined in this call's
source
, as well as those defined insources
of previous calls to the same processor.Creates a scaladoc site for all symbols defined in this call's
source
, as well as those defined insources
of previous calls to the same processor.- source
The list of paths (relative to the compiler's source path, or absolute) of files to document or the source code.
- val reporter: Reporter
- val settings: Settings
- object NoCompilerRunException extends Throwable with ControlThrowable
-
object
compiler extends ScaladocGlobal
The unique compiler instance used by this processor and constructed from its
settings
.
The Scala compiler and reflection APIs.