This software is a JavaDoc doclet that expands the capabilities of the standard Java doclet by extending its functionalities.
Using APIviz is relatively straightforward. Firstly, set the value of the -doclet option to "net.gleamynode.apiviz.APIviz," and then set the value of the -docletpath option to the path where the apiviz-.jar file is stored. By default, APIviz automatically discovers the relationship between packages and classes and their stereotype. However, developers can use the software's doclet tags to add more relationships or create cleaner diagrams.
The following doclet tags are available when using APIviz:
- @apiviz.stereotype: Assigns a stereotype to a class
- @apiviz.landmark: Highlights a class or package
- @apiviz.hidden: Hides a class from the package overview diagram
- @apiviz.exclude: Excludes classes that match 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
APIviz also recognizes other tags such as @see and @deprecated. In summary, APIviz is an excellent tool that offers extensive functionality to simplify the API structure's comprehension. With its straightforward setup, following the basic usage steps. And developers can use doclet tags to enhance diagrams further.
Version 1.3.0.GA: N/A