You probably know the difference between the
Unfortunately javadoc doesn't support the concept of a published API. The PublishedApiDoclet tries to leverage this deficiency. It acts as a filtering proxy or decorator for another doclet, that formats the output. The PublishedApiDoclet hides anything, that doesn't belong to the published API from the formating doclet.
The PublishedApiDoclet follows the javadoc doclet
conventions. That is, you need to add the parameters -doclet
de.kruis.padoclet.PublishedApiDoclet
and -docletpath
/path/to/PublishedApiDoclet.jar
to your javadoc command
line. Then you have to set the system property
PublishedApiDoclet.delegate
to the name of the formating
doclet, unless you use the javadoc standard doclet. (A system property
is used, because the PublishedApiDoclet needs the name of the formating
doclet to parse the command line.) Several command line options
controll the behaviour of the PublishedApiDoclet. Use the option -padHelp
to get an overview over the options.
Unfortunately, I didn't write a more complete documentation yet. But have a look at the example subpackage.
@pad.include src @pad.exclude sample9