Package org.pjdbc.doclet

Class CapabilityDoclet

java.lang.Object

org.pjdbc.doclet.CapabilityDoclet

All Implemented Interfaces:

Doclet

public class CapabilityDoclet
extends Object
implements Doclet

Custom Doclet that enhances JavaDocs with driver capability documentation generated from @DriverCapability and @DriverParameter annotations.

This Doclet delegates to the StandardDoclet for normal processing, then post-processes the generated HTML to inject parameter tables for driver classes.

Usage in pom.xml:

 <plugin>
   <artifactId>maven-javadoc-plugin</artifactId>
   <configuration>
     <doclet>org.pjdbc.doclet.CapabilityDoclet</doclet>
     <docletArtifact>
       <groupId>org.pjdbc</groupId>
       <artifactId>pjdbc</artifactId>
       <version>${project.version}</version>
     </docletArtifact>
   </configuration>
 </plugin>
 

Nested Class Summary

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

Doclet.Option

Constructor Summary

Constructors

Constructor	Description
CapabilityDoclet()

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 docEnv)

Methods inherited from class java.lang.Object

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

Constructor Details

CapabilityDoclet

public CapabilityDoclet()

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 docEnv)

Specified by:

run in interface Doclet