Package org.eclipse.aether.tools

Class ConfigurationCollectorDoclet

java.lang.Object

org.eclipse.aether.tools.ConfigurationCollectorDoclet

All Implemented Interfaces:

Doclet

public class ConfigurationCollectorDoclet
extends Object
implements Doclet

A custom Javadoc Doclet that scans constant fields for configuration metadata declared via custom Javadoc block tags (e.g. @configurationSource) and writes the discovered keys into an intermediate Properties file. That file is subsequently consumed by CollectConfiguration to render the documentation via Velocity templates.

The intermediate file uses an indexed layout:

 keys.count=N
 keys.0.key=...
 keys.0.description=...
 ...
 

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Doclet

Doclet.Option

Constructor Summary

Constructors

Constructor	Description
ConfigurationCollectorDoclet()

Method Summary

Modifier and Type	Method	Description
String	getName()
Set<? extends Doclet.Option>	getSupportedOptions()
SourceVersion	getSupportedSourceVersion()
void	init(Locale locale, Reporter reporter)
boolean	run(DocletEnvironment environment)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConfigurationCollectorDoclet

public ConfigurationCollectorDoclet()

Method Details

init

public void init(Locale locale,
 Reporter reporter)

Specified by:

init in interface Doclet

getName

public String getName()

Specified by:

getName in interface Doclet

getSupportedOptions

public Set<? extends Doclet.Option> getSupportedOptions()

Specified by:

getSupportedOptions in interface Doclet

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Doclet

run

public boolean run(DocletEnvironment environment)

Specified by:

run in interface Doclet