Documentation of additionalOptions about umldoclet HOT 7 OPEN

Not all options that were available in the UmlDoclet v1 are available in the 2.x version since the full rewrite.

This is intentional.
There is a wish for more fine-grained configuration options while reducing the forrest of additional options to pass to the javadoc tool.
This is explained briefly in the following issue: #125

from umldoclet.

Hi, just to save a quick reply to the issue, additional options currently implemented are here: UMLOptions.java

Current implemented options are:

	// Options from Standard doclet that we also support
            "-quiet"
            "-verbose"
            "-docencoding"
            "-encoding"
            "-link";
            "-linkoffline"
            "-private"
            "-package"
            "-protected"
            "-public"
            "--show-members"
            "-d"   // config.destDirName = args.get(0))

       // Our own options
            "--plantuml-server-url -plantumlServerUrl"
            "--delegate-doclet -delegateDoclet"
            "--create-puml-files -createPumlFiles"
            "--uml-image-directory -umlImageDirectory"
            "--uml-image-format -umlImageFormat"
            "--uml-encoding -umlEncoding"
            "--uml-excluded-type-references -umlExcludedTypeReferences"         // adds overriden methods toString() and equals() 
            "--uml-excluded-package-dependencies -umlExcludedPackageDependencies"
            "--uml-custom-directive -umlCustomDirective"
            "--fail-on-cyclic-package-dependencies -failOnCyclicPackageDependencies"
            "--uml-java-bean-properties-as-fields -umlJavaBeanPropertiesAsFields"
            "--uml-timeout -umlTimeout"
  

from umldoclet.

Hi,
I understand the necessity of providing fine-grained configuration options through more powerful mechanisms such as annotations or tags. However, in some use cases, providing general options in a configuration file (as pom.xml) does avoid the necessity of refactoring source code, package by package, class by class, to add such annotations or tags. Moreover, a common configuration file can be reused in different projects without any source code modifications.
From an academic point of view, as is my case, that is the easier way to do.
Thanks a lot.
Joaquín

from umldoclet.

Hi,
I would like an option to ignore the cyclic package dependencies warning if that is possible.
Thanks a lot.
Kas

from umldoclet.

Hi, can enable "-link" option multiple times to include different sites? it only accept 1

from umldoclet.

Hi, can enable "-link" option multiple times to include different sites? it only accept 1

@erickjx Could you create a separate issue for this request? Thanks in advance!

from umldoclet.

Hi, I would like an option to ignore the cyclic package dependencies warning if that is possible. Thanks a lot. Kas

@kasderooi Could you create a separate issue for this request? Thanks in advance!

from umldoclet.