How can I disable the Maven Javadoc plugin from the command line?

Question

In pom.xml I have declaration like this

    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <executions>
            <execution>
                <id>attach-javadocs</id>
                <goals>
                    <goal>jar</goal>
                </goals>
            </execution>
        </executions>
    </plugin>

is there any way to turn that off from command line?

I do know I can extract that into a profile, but that is not what I want.

score 557 · Accepted Answer · edited Apr 29 '21 at 10:02

557

The Javadoc generation can be skipped by setting the property maven.javadoc.skip to true [1], i.e.

-Dmaven.javadoc.skip=true

(and not false)

edited Apr 29 '21 at 10:02

BuZZ-dEE

6,075
12
66
96

answered Feb 20 '12 at 11:22

mswientek

5,602
1
16
4

1

See @Christoph-Tobias Schenke answer for approach to take with child modules. – ecoe Jan 26 '18 at 00:30
This argument can also be set directly in jenkins to avoid this problem (in Global MAVEN_OPTS defined in Configure System) – King Midas Mar 28 '18 at 10:37
28

This didn't work for me, but learned that when you use the maven release plugin you need to pass this parameter differently. This worked: ```mvn release:perform -Darguments="-Dmaven.javadoc.skip=true"```. – PatS Sep 28 '18 at 01:57

Christoph-Tobias Schenke · Answer 2 · 2016-04-27T08:22:45.117

233

It seems, that the simple way

-Dmaven.javadoc.skip=true

does not work with the release-plugin. in this case you have to pass the parameter as an "argument"

mvn release:perform -Darguments="-Dmaven.javadoc.skip=true"

edited Apr 27 '16 at 08:22

answered Jan 05 '16 at 13:44

Christoph-Tobias Schenke

3,250
1
11
17

11

If you need to add two arguments you can separate them with a space like this `-Darguments="-DskipTests -Dmaven.javadoc.skip=true"` – Graham Apr 14 '16 at 20:30
5

It also works to add these to the release plugin config in the root-level pom.xml: `-DskipTests -Dmaven.javadoc.skip=true` – nclark May 11 '16 at 14:17
2

In addition, skipTests comes in a stronger flavor that also skips compilation of tests: `-Dmaven.tests.skip=true` – nclark May 11 '16 at 14:28
2

Wow, why does the maven release plugin do this...totally lost some time on this one – jediwompa Oct 16 '20 at 19:48
somehow this didn't work for me – jediz Oct 18 '21 at 15:50

score 145 · Answer 3 · edited Jul 30 '13 at 07:43

145

You can use the maven.javadoc.skip property to skip execution of the plugin, going by the Mojo's javadoc. You can specify the value as a Maven property:

<properties>
    <maven.javadoc.skip>true</maven.javadoc.skip>
</properties>

or as a command-line argument: -Dmaven.javadoc.skip=true, to skip generation of the Javadocs.

edited Jul 30 '13 at 07:43

sleske

81,358
34
189
227

answered Sep 14 '11 at 06:34

Vineet Reynolds

76,006
17
150
174

2

This answer doesnt really answer the question, since in there it states that the switch should be done via the command line. – Sinisha Mihajlovski Dec 16 '16 at 14:15
4

This is the perfect solution for a multi-module project with a few modules not generating any javadoc and causing an error otherwise. – Emmanuel Bourg Jun 13 '17 at 08:58

score 25 · Answer 4 · answered May 13 '16 at 14:14

25

Add to the release plugin config in the root-level pom.xml:

<configuration>
    <arguments>-Dmaven.javadoc.skip=true</arguments>
</configuration>

answered May 13 '16 at 14:14

nclark

1,022
1
11
16

2

this is not properly from command line as required by the question, but it works great if you need to disable permanently the javadoc. – Lorenzo Sciuto Apr 09 '18 at 09:41

score 3 · Answer 5 · answered Mar 02 '20 at 11:53

3

For newbie Powershell users it is important to know that '.' is a syntactic element of Powershell, so the switch has to be enclosed in double quotes:

mvn clean install "-Dmaven.javadoc.skip=true"

answered Mar 02 '20 at 11:53

Det

39
1

1

Thanks for that. I was looking for this, to setup VSCode. – tmoasz Jan 27 '21 at 12:21

score 2 · Answer 6 · answered Oct 14 '22 at 06:40

Dans le pom.xml

1st option : using properties

<properties>
    <maven.javadoc.skip>true</maven.javadoc.skip> 
</properties>

2nd option : using the build > pluginManagement > plugins > plugin > configuration

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-release-plugin</artifactId>
                <version>2.5.3</version>
                <configuration>
                    <goals>deploy</goals>
                    <arguments>-Dmaven.javadoc.skip=true</arguments>
                </configuration>
            </plugin>

3rd option : When invoking mvn (this one did not work for me)

 mvn clean install -Dmaven.javadoc.skip=true

score 1 · Answer 7 · edited Aug 27 '22 at 07:32

1

One important thing is: if you set <skip>false<skip> in configuration of maven-javadoc-plugin in pom.xml, the -Dmaven.javadoc.skip=true will not work, at least for maven-daemon(aka mvndaemon or mvnd).

edited Aug 27 '22 at 07:32

Procrastinator

2,526
30
27
36

answered Aug 23 '22 at 03:43

Robert Minton

21
5

How can I disable the Maven Javadoc plugin from the command line?

7 Answers7

Linked