PerDoclet is a
doclet that generates XHTML documents with UML.
A doclet is a software component that alters the output of
Sun's javadoc tool.
PerDoclet is open source.
Requirements: Java SDK 1.2 or later (?)
javadoc -doclet PerDoclet other parameters
PerDoclet have a bunch of advantages over the standard doclet:
- Better-looking and more compact formatting. Easier to read on screen.
Less pages to print. If you don't like the default formatting, you
can easily change it by editing the CSS file in the document root.
- Class summary as a UML
class diagram. Attributes, operations, visability, parameters,
return types, static elements, abstract elements, stereotypes...
- Less redundancy and smaller files. Standard doclet really likes to copy information which
sometimes makes documentation for a single class huge.
- Output in valid XHTML 1.0 strict format, under the condition that possible tags in code comments are properly nested XHTML tags. Standard doclet generates ugly HTML4 code.
2005-08-08: Version 1.1 was released.
This version makes PerDoclet open source and distributed under GNU GPL.
Download above is source code, you can fetch it compiled too.
2004-05-12: Version 1.0 was released.
Here is a screenshot of a UML class diagram generated by PerDoclet, showing the PerDoclet class itself:
See the full example of documentation for PerDoclet, including private methods.
The full example was generated with this command:
javadoc -private -doclet PerDoclet PerDoclet.java
PerDoclet has some doclet-specific javadoc parameters.
Execute javadoc -doclet PerDoclet to see them.
Note that if you want private members to be shown in the UML class diagram,
you must specify javadoc's -private parameter.