api / org.gradle.external.javadoc / CoreJavadocOptions / getJFlags

getJFlags

open fun getJFlags(): MutableList<String>

Overrides MinimalJavadocOptions.getJFlags

-Jflag

Passes flag directly to the runtime system java that runs javadoc. Notice there must be no space between the J and the flag. For example, if you need to ensure that the system sets aside 32 megabytes of memory in which to process the generated documentation, then you would call the -Xmx option of java as follows (-Xms is optional, as it only sets the size of initial memory, which is useful if you know the minimum amount of memory required):

javadoc -J-Xmx32m -J-Xms32m com.mypackage

To tell what version of javadoc you are using, call the "-version" option of java:

javadoc -J-version java version "1.2" Classic VM (build JDK-1.2-V, green threads, sunwjit)

(The version number of the standard doclet appears in its output stream.)