APIviz A JavaDoc doclet which extends the Java standard doclet.
Download

APIviz Ranking & Summary

APIviz Tags

class generator UML JavaDoc doclet UML-like class JavaDoc doclet

APIviz Description

A JavaDoc doclet which extends the Java standard doclet. APIviz is a JavaDoc doclet which extends the Java standard doclet. It generates comprehensive UML-like class and package diagrams for quick understanding of the overall API structure.Basic Usage:Set the value of the -doclet option to: net.gleamynode.apiviz.APIvizSet the value of the -docletpath option to: path/to/apiviz-.jarAPIviz automatically discovers the relationship between packages and classes and their stereotype by default. Additionally, you can use the following doclet tags to add more relationships or to make the generated diagram look cleaner.- @apiviz.stereotype - Assigns a stereotype to a class- @apiviz.landmark - Highlight a class or a package- @apiviz.hidden - Hides a class from the package overview diagram- @apiviz.exclude - Excludes the classes that matches the regular expression- @apiviz.inherit - Inherits the exclusion patterns of the package where a class belongs- @apiviz.uses - Adds a dependency relationship- @apiviz.has - Adds a navigability relationship- @apiviz.owns - Adds an aggregation relationship- @apiviz.composedOf - Adds a composition relationship - @see and @deprecated tags are also recognized. Requirements: · GraphViz · Java 2 Standard Edition Runtime Environment What's New in This Release: · Added '-category' option (by Brad Sneade) · Slight tweak on diagram look · Better explanation when Graphviz is not found · Added support for an environment variable 'GRAPHVIZ_HOME' · Fixed a bug where a certain Graphviz version is not recognized

APIviz Related Software