I’m porting a project from Maven to Gradle. The javadoc plugin needs an “-X” option passed to it. I don’t see how I can do that with the Gradle javadoc task. The original reference in the Maven pom looks like this: <additionalparam>-Xdoclint:none</additionalparam>

Hi, You can use the options.addStringOption() method in a Javadoc configuration closure. See http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html

Yes, I see it, but getting this to actually work is not going to be obvious at all. If I just do this: addStringOption(‘Xdoclint:none’) It doesn’t get added to the command line. I verified this with the resulting “javadoc.options” file. I then tried doing the following: addStringOption(‘Xdo…

The addStringOption('something') as no effect on the javadoc properties, while addStringOption('key', 'value') works as expected. Command line options become -key value. There was apparently an issue with non valued javadoc options, cause there is commit reverting it: https://github.com/gradle/grad…

@Vampire that doesn’t seem to work for me, I get the following error: No signature of method: org.gradle.external.javadoc.StandardJavadocDocletOptions.addStringOption() is applicable for argument types: (String, Boolean) values: [Xdoclint:none, true] Possible solutions: addStringOption(java.lang.…

You used addStringOption, but I said addBooleanOption :wink:

Aha! Thanks for the correction. I like addBooleanOption better, since it doesn’t require me to also add -quiet or similar.

Yep, that was exactly my point :slight_smile:

Is there a way to specify multiple options with the same name? I’m trying to pass multiple -tag arguments to javadoc, but Gradle is throwing away all of them except the last one. I really wish the Javadoc task would let us configure the ExecSpec, then we’d have full control over all this.

addMultilineStringsOption("tag").setValue(listOf("a", "b", "c"))}

How to send "-X" option to javadoc?

Help/Discuss

Vampire (Björn Kautler) January 25, 2019, 7:11pm 5

If it has no value, it is a boolean option.
Just do addBooleanOption 'Xdoclint:none', true and it works fine.

Topic		Replies	Views
JavadocOptionFile set up Help/Discuss	1	436	June 26, 2017
Add custom Javadoc option that does not take an argument Old Forum Archive	4	4662	September 15, 2013
Partly undo the configuration performed on a task by a plugin Help/Discuss plugins	8	99	August 28, 2025
Passing arguments to compiler and javadoc Old Forum Archive	3	9285	September 27, 2012
Javadoc -tag option Old Forum Archive	4	956	December 21, 2011

How to send "-X" option to javadoc?

Related topics