blob: 14ff8012b894cf207e3c5805495c28706be092c2 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
/* NSC -- new Scala compiler -- Copyright 2007-2009 LAMP/EPFL */
// $Id$
package scala.tools.nsc
package doc
import reporters.Reporter
/** 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 compiler's 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 the `run` method
* 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.
*
* @param reporter The reporter to which both documentation and compilation errors will be reported.
* @param settings The settings to be used by the documenter and compiler for generating documentation.
*
* @author Gilles Dubochet */
class DocFactory(val reporter: Reporter, val settings: doc.Settings) { processor =>
/** The unique compiler instance used by this processor and constructed from its `settings`. */
object compiler extends Global(settings, reporter) {
override protected def computeInternalPhases() {
phasesSet += syntaxAnalyzer
phasesSet += analyzer.namerFactory
phasesSet += analyzer.typerFactory
phasesSet += superAccessors
phasesSet += pickler
phasesSet += refchecks
}
override def onlyPresentation = true
lazy val addSourceless = {
val sless = new SourcelessComments { val global = compiler }
comments ++= sless.comments
}
}
/** 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.
* @param files The list of paths (relative to the compiler's source path, or absolute) of files to document. */
def document(files: List[String]): Unit = {
(new compiler.Run()) compile files
compiler.addSourceless
if (!reporter.hasErrors) {
val modelFactory = (new model.ModelFactory(compiler, settings))
val htmlFactory = (new html.HtmlFactory(reporter, settings))
val docModel = modelFactory.makeModel
println("model contains " + modelFactory.templatesCount + " documentable templates")
htmlFactory generate docModel
}
}
}
|
