blob: b4ede6d358feefd0c5660f94e68b5fe1e98c3f9d (
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
|
package scala.tools.nsc.doc
package doclet
import scala.collection._
/** Custom Scaladoc generators must implement the `Generator` class. A custom generator can be selected in Scaladoc
* using the `-doc-generator` command line option.
* The `Generator` class does not provide data about the documented code. A number of data provider traits can be used
* to configure what data is actually available to the generator:
* - A `Universer` provides a `Universe` data structure representing the interfaces and comments of the documented
* program.
* To implement this class only requires defining method `generateImpl`. */
abstract class Generator {
/** A series of tests that must be true before generation can be done. This is used by data provider traits to
* confirm that they have been correctly initialised before allowing generation to proceed. */
protected val checks: mutable.Set[()=>Boolean] =
mutable.Set.empty[()=>Boolean]
/** Outputs documentation (as a side effect). */
def generate(): Unit = {
assert(checks forall { check => check() })
generateImpl()
}
/** Outputs documentation (as a side effect). This method is called only if all `checks` are true. */
protected def generateImpl(): Unit
}
|
