The unique compiler instance used by this processor and constructed from its settings.
Generate document(s) for all files containing scaladoc documenataion.
Generate document(s) for all files containing scaladoc documenataion.
The list of paths (relative to the compiler's source path, or absolute) of files to document.
Creates a scaladoc site for all symbols defined in this call's source,
as well as those defined in sources of previous calls to the same processor.
The reporter to which both documentation and compilation errors will be reported.
The settings to be used by the documenter and compiler for generating documentation.
(docFactory: StringAdd).self
(docFactory: StringFormat).self
(docFactory: ArrowAssoc[DocFactory]).x
(Since version 2.10.0) Use leftOfArrow instead
(docFactory: Ensuring[DocFactory]).x
(Since version 2.10.0) Use resultOfEnsuring instead
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 todocumentuses the same compiler instance with the same symbol table. In particular, this implies that the scaladoc site obtained from a call torunwill contain documentation about files compiled during previous calls to the same processor'srunmethod.