Skip to content

Commit 89316c9

Browse files
hgschmiehgschmie
authored
[MJAVADOC-767] javadoc creates invalid --patch-module statements (#225)
Fixes empty --patch-module command line entries When using an exclude filter, it is possible that the plugin creates javadoc --patch-module command line options, that do not actually have a value. This changes skips such empty entries.
1 parent 72c8ee5 commit 89316c9

File tree

10 files changed

+280
-6
lines changed

10 files changed

+280
-6
lines changed

‎src/it/projects/MJAVADOC-767/doc/pom.xml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
~ Licensed under the Apache License, Version 2.0 (the "License");
4+
~ you may not use this file except in compliance with the License.
5+
~ You may obtain a copy of the License at
6+
~
7+
~ http://www.apache.org/licenses/LICENSE-2.0
8+
~
9+
~ Unless required by applicable law or agreed to in writing, software
10+
~ distributed under the License is distributed on an "AS IS" BASIS,
11+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
~ See the License for the specific language governing permissions and
13+
~ limitations under the License.
14+
-->
15+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
16+
<modelVersion>4.0.0</modelVersion>
17+
18+
<parent>
19+
<groupId>org.apache.maven.plugins.javadoc.it</groupId>
20+
<artifactId>mjavadoc767</artifactId>
21+
<version>1.0-SNAPSHOT</version>
22+
</parent>
23+
24+
<artifactId>doc</artifactId>
25+
<packaging>pom</packaging>
26+
27+
<dependencies>
28+
<dependency>
29+
<groupId>org.apache.maven.plugins.javadoc.it</groupId>
30+
<artifactId>thing1</artifactId>
31+
<version>1.0-SNAPSHOT</version>
32+
</dependency>
33+
<dependency>
34+
<groupId>org.apache.maven.plugins.javadoc.it</groupId>
35+
<artifactId>thing2</artifactId>
36+
<version>1.0-SNAPSHOT</version>
37+
</dependency>
38+
</dependencies>
39+
40+
<build>
41+
<plugins>
42+
<plugin>
43+
<artifactId>maven-javadoc-plugin</artifactId>
44+
<version>@project.version@</version>
45+
<executions>
46+
<execution>
47+
<id>javadoc-jar</id>
48+
<goals>
49+
<goal>aggregate-jar</goal>
50+
</goals>
51+
<phase>package</phase>
52+
<configuration>
53+
<jvmVersion>9</jvmVersion>
54+
<skip>false</skip>
55+
<includeDependencySources>true</includeDependencySources>
56+
<detectOfflineLinks>false</detectOfflineLinks>
57+
<dependencySourceIncludes>
58+
<dependencySourceInclude>*:*</dependencySourceInclude>
59+
</dependencySourceIncludes>
60+
<dependencySourceExcludes>
61+
<dependencySourceExclude>*:thing2</dependencySourceExclude>
62+
</dependencySourceExcludes>
63+
</configuration>
64+
</execution>
65+
</executions>
66+
</plugin>
67+
</plugins>
68+
</build>
69+
</project>

‎src/it/projects/MJAVADOC-767/invoker.properties

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
invoker.goals= package
19+
invoker.java.version = 9+

‎src/it/projects/MJAVADOC-767/pom.xml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
~ Licensed under the Apache License, Version 2.0 (the "License");
4+
~ you may not use this file except in compliance with the License.
5+
~ You may obtain a copy of the License at
6+
~
7+
~ http://www.apache.org/licenses/LICENSE-2.0
8+
~
9+
~ Unless required by applicable law or agreed to in writing, software
10+
~ distributed under the License is distributed on an "AS IS" BASIS,
11+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
~ See the License for the specific language governing permissions and
13+
~ limitations under the License.
14+
-->
15+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
16+
<modelVersion>4.0.0</modelVersion>
17+
18+
<groupId>org.apache.maven.plugins.javadoc.it</groupId>
19+
<artifactId>mjavadoc767</artifactId>
20+
<version>1.0-SNAPSHOT</version>
21+
<packaging>pom</packaging>
22+
23+
<url>https://issues.apache.org/jira/browse/MJAVADOC-767</url>
24+
25+
<properties>
26+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
27+
<maven.compiler.source>9</maven.compiler.source>
28+
<maven.compiler.target>9</maven.compiler.target>
29+
</properties>
30+
31+
<modules>
32+
<module>thing1</module>
33+
<module>thing2</module>
34+
<module>doc</module>
35+
</modules>
36+
</project>

‎src/it/projects/MJAVADOC-767/thing1/pom.xml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
~ Licensed under the Apache License, Version 2.0 (the "License");
4+
~ you may not use this file except in compliance with the License.
5+
~ You may obtain a copy of the License at
6+
~
7+
~ http://www.apache.org/licenses/LICENSE-2.0
8+
~
9+
~ Unless required by applicable law or agreed to in writing, software
10+
~ distributed under the License is distributed on an "AS IS" BASIS,
11+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
~ See the License for the specific language governing permissions and
13+
~ limitations under the License.
14+
-->
15+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
16+
<modelVersion>4.0.0</modelVersion>
17+
18+
<parent>
19+
<groupId>org.apache.maven.plugins.javadoc.it</groupId>
20+
<artifactId>mjavadoc767</artifactId>
21+
<version>1.0-SNAPSHOT</version>
22+
</parent>
23+
24+
<artifactId>thing1</artifactId>
25+
<packaging>jar</packaging>
26+
</project>

‎src/it/projects/MJAVADOC-767/thing1/src/main/java/jdbug/thing1/Main.java

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
package jdbug.thing1;
21+
22+
public final class Main {
23+
public static final void main(String ... args) throws Exception {
24+
System.out.println("Hello, World!");
25+
}
26+
}

‎src/it/projects/MJAVADOC-767/thing1/src/main/java/module-info.java

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
module jdbug.thing1 {
21+
exports jdbug.thing1;
22+
}

‎src/it/projects/MJAVADOC-767/thing2/pom.xml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
~ Licensed under the Apache License, Version 2.0 (the "License");
4+
~ you may not use this file except in compliance with the License.
5+
~ You may obtain a copy of the License at
6+
~
7+
~ http://www.apache.org/licenses/LICENSE-2.0
8+
~
9+
~ Unless required by applicable law or agreed to in writing, software
10+
~ distributed under the License is distributed on an "AS IS" BASIS,
11+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
~ See the License for the specific language governing permissions and
13+
~ limitations under the License.
14+
-->
15+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
16+
<modelVersion>4.0.0</modelVersion>
17+
18+
<parent>
19+
<groupId>org.apache.maven.plugins.javadoc.it</groupId>
20+
<artifactId>mjavadoc767</artifactId>
21+
<version>1.0-SNAPSHOT</version>
22+
</parent>
23+
24+
<artifactId>thing2</artifactId>
25+
<packaging>jar</packaging>
26+
</project>

‎src/it/projects/MJAVADOC-767/thing2/src/main/java/jdbug/thing2/Main.java

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
package jdbug.thing2;
21+
22+
public final class Main {
23+
public static final void main(String ... args) throws Exception {
24+
System.out.println("Hello, World!");
25+
}
26+
}

‎src/it/projects/MJAVADOC-767/thing2/src/main/java/module-info.java

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
module jdbug.thing2 {
21+
exports jdbug.thing2;
22+
}

‎src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4594,12 +4594,14 @@ private void addJavadocOptions(
45944594
}
45954595

45964596
for (Entry<String, Collection<Path>> entry : patchModules.entrySet()) {
4597-
addArgIfNotEmpty(
4598-
arguments,
4599-
"--patch-module",
4600-
entry.getKey() + '=' + JavadocUtil.quotedPathArgument(getSourcePath(entry.getValue())),
4601-
false,
4602-
false);
4597+
if (!entry.getValue().isEmpty()) {
4598+
addArgIfNotEmpty(
4599+
arguments,
4600+
"--patch-module",
4601+
entry.getKey() + '=' + JavadocUtil.quotedPathArgument(getSourcePath(entry.getValue())),
4602+
false,
4603+
false);
4604+
}
46034605
}
46044606

46054607
if (doclet != null && !doclet.isEmpty()) {

0 commit comments

Comments
 (0)