diff --git a/javadoc/xdocs/faq.fml b/javadoc/xdocs/faq.fml index 57fbeb3a..db20722b 100644 --- a/javadoc/xdocs/faq.fml +++ b/javadoc/xdocs/faq.fml @@ -53,5 +53,49 @@ maven.javadoc.offlineLinks= \ maven.javadoc.additionalparam=-J-DproxyHost=${maven.proxy.host} -J-DproxyPort=${maven.proxy.port} + + How do I generate class diagrams on Javadoc pages using free tools ? + +

+ One solution is to use UMLGraph and dot (part of Graphviz). +

+

+ When running the javadoc goal with the below configuration, + the UmlGraphDoc doclet generates class diagrams + into the package and class pages. +

    +
  1. Put latest jar in repo/depend on UmlGraph jar, e.g.
  2. + + gr.spinellis + UmlGraph + 4.6 + +]]> + +
  3. Set Maven properties:
  4. + +maven.javadoc.doclet=gr.spinellis.umlgraph.doclet.UmlGraphDoc +maven.javadoc.docletpath=${maven.repo.local}/gr.spinellis/jars/UmlGraph-4.6.jar +maven.javadoc.usestandardparameters=true + + +
  5. + Install dot (in Graphviz) + and put on PATH (so UmlGraphDoc can run it); e.g. for Windows: +
  6. + +GRAPHVIZ_HOME=(the path) +PATH=%PATH%;%GRAPHVIZ_HOME%\bin + +
+

+

+ Refer to + UMLGraph + docs for its custom Javadoc tags that enhance the generated diagrams. +

+
+
\ No newline at end of file diff --git a/javadoc/xdocs/properties.xml b/javadoc/xdocs/properties.xml index 57fbe0cd..e7dbd1a1 100644 --- a/javadoc/xdocs/properties.xml +++ b/javadoc/xdocs/properties.xml @@ -63,6 +63,8 @@ Specifies the doclet to use when calling javadoc. See the ant javadoc task documentation for more detail. + See Class Diagrams FAQ + as an example.