diff --git a/javadoc/plugin.jelly b/javadoc/plugin.jelly index 38caf52b..b9835b6b 100644 --- a/javadoc/plugin.jelly +++ b/javadoc/plugin.jelly @@ -398,10 +398,54 @@ internal_javadoc_src_tmp = [${internal_javadoc_src_tmp}] - - - - + + +=============================================================================== +Processing custom doclet settings - BEGIN +------------------------------------------------------------------------------- + + + + + + + Using doclet param list=${maven.javadoc.doclet.param.list} + + + + ${maven.javadoc.doclet.param.list} + + + + + + + + + + + + For '${item}', adding param name='${param.name}' value='${param.value}' + + + ERROR: Did not find '${param.prop.name}' in properties! + + + WARNING: Did not find '${param.prop.value}' in properties! (this may be intended if the param does not have a value) + + + + + + + + + +------------------------------------------------------------------------------- +Processing custom doclet settings - END +=============================================================================== + + diff --git a/javadoc/xdocs/changes.xml b/javadoc/xdocs/changes.xml index 0681c897..d274975d 100644 --- a/javadoc/xdocs/changes.xml +++ b/javadoc/xdocs/changes.xml @@ -27,6 +27,7 @@ Do not add a directory of sources which doesn't exist. + Add specifying params with alternate doclets. Cannot set -sourcepath to add paths for inherited javadocs. diff --git a/javadoc/xdocs/faq.fml b/javadoc/xdocs/faq.fml index db20722b..84cb4dd2 100644 --- a/javadoc/xdocs/faq.fml +++ b/javadoc/xdocs/faq.fml @@ -79,7 +79,17 @@ 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 - +

+ Maven Javadoc plugin version 1.9 and newer + enables specifying custom doclet parameters. + This makes configuring UMLGraph's doclet possible, + for example, turning on extra class diagram adornments. + Adjust these as desired, referring to the UMLGraph documentation. +

+ +maven.javadoc.doclet.param.list=umlgraph.all +umlgraph.all.name=-all +
  • Install dot (in Graphviz) and put on PATH (so UmlGraphDoc can run it); e.g. for Windows: @@ -88,6 +98,10 @@ maven.javadoc.usestandardparameters=true GRAPHVIZ_HOME=(the path) PATH=%PATH%;%GRAPHVIZ_HOME%\bin +

    + Note that UmgGraphDoc outputs an error message + if it could not run dot. +

    diff --git a/javadoc/xdocs/properties.xml b/javadoc/xdocs/properties.xml index ee90217c..38079d72 100644 --- a/javadoc/xdocs/properties.xml +++ b/javadoc/xdocs/properties.xml @@ -340,10 +340,10 @@ tag2.scope=all]]>

    - + @@ -355,6 +355,7 @@ tag2.scope=all]]> See Class Diagrams FAQ as an example. + @@ -365,6 +366,7 @@ tag2.scope=all]]>the ant javadoc task documentation for more detail. + @@ -378,6 +380,53 @@ tag2.scope=all]]> the plugin does not use the standard doclet parameters unless this property is set. + + + + + + + + + + + + +
    Type Name Optional? DescriptionDefault
    maven.javadoc.doclet(none - calls the JavaDoc standard doclet)
    maven.javadoc.docletpath (none)
    maven.javadoc.usestandardparameters(none)
    maven.javadoc.doclet.param.listYes +

    + Delimeter separated list of property names + (see maven.javadoc.doclet.param.list.delim), + with each property defining a parameter name and value, + to pass to the doclet. + For example: umlgraph.all,property2.abc,property3.def +

    +

    + For every property listed, it expects 2 additional properties: +

    +
    (propertyname).name
    +
    The name of the parameter to pass to the doclet.
    +
    (propertyname).value
    +
    + The value of the parameter to pass to the doclet. + Note that this can be not specified, + if the parameter name is all that is needed. +
    +
    +

    +

    + For example, to specify the "-all" parameter to the doclet + and "-all" does not have a parameter value: + +maven.javadoc.doclet.param.list=umlgraph.all +umlgraph.all.name=-all + +

    +
    (none)
    maven.javadoc.doclet.param.list.delimYes +

    + Property name delimeter for list of parameters specified in + maven.javadoc.doclet.param.list. +

    +
    , (comma)