package doclet
Content Hierarchy
Type Members
- abstract class Generator extends AnyRef
Custom Scaladoc generators must implement the
Generator
class.Custom Scaladoc generators must implement the
Generator
class. A custom generator can be selected in Scaladoc using the-doc-generator
command line option. TheGenerator
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 aUniverse
data structure representing the interfaces and comments of the documented program. To implement this class only requires defining methodgenerateImpl
.
- A
- trait Universer extends Generator
A
Generator
may implement theUniverser
trait to gain access to a model of the documented program
The Scala compiler and reflection APIs.