A series of tests that must be true before generation can be done.
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.
Outputs documentation (as a side effect).
(generator: StringAdd).self
(generator: StringFormat).self
(generator: ArrowAssoc[Generator]).x
(Since version 2.10.0) Use leftOfArrow
instead
(generator: Ensuring[Generator]).x
(Since version 2.10.0) Use resultOfEnsuring
instead
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:Universer
provides aUniverse
data structure representing the interfaces and comments of the documented program.Indexer
provides precalculated indexing information about a universe. To implement this class only requires defining methodgenerateImpl
.