Skip to content

Commit b47b280

Browse files
michael-omichael-o
committed
directory, not folder
Use property term for item type on a filesystem.
1 parent 488624f commit b47b280

File tree

13 files changed

+98
-98
lines changed

13 files changed

+98
-98
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -711,8 +711,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
711711
* <p>
712712
* Wildcards work as followed:
713713
* <ul>
714-
* <li>a wildcard at the beginning should match 1 or more folders</li>
715-
* <li>any other wildcard must match exactly one folder</li>
714+
* <li>a wildcard at the beginning should match one or more directories</li>
715+
* <li>any other wildcard must match exactly one directory</li>
716716
* </ul>
717717
* </p>
718718
* Example:

Diff for: ‎src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -372,8 +372,8 @@ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IO
372372
// Usage of wildcard was bad specified and bad implemented, i.e. using String.contains()
373373
// without respecting surrounding context
374374
// Following implementation should match requirements as defined in the examples:
375-
// - A wildcard at the beginning should match 1 or more folders
376-
// - Any other wildcard must match exactly one folder
375+
// - A wildcard at the beginning should match one or more directories
376+
// - Any other wildcard must match exactly one directory
377377
Pattern p = Pattern.compile(excludePackagename
378378
.replace(".", regexFileSeparator)
379379
.replaceFirst("^\\*", ".+")

Diff for: ‎src/site/apt/examples/aggregate.apt.vm

+6-6
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@ Project
4848

4949
+-----+
5050

51-
Since 3.1.0 the <<<aggregate>>> has changed a little bit. It'll generate aggregated
51+
Since 3.1.0 the <<<aggregate>>> has changed a little bit. It'll generate aggregated
5252
reports at every level.
5353
To get only an aggregated project at root level, you need to configure the pom like:
54-
54+
5555
+-----+
5656
<project>
5757
...
@@ -64,7 +64,7 @@ Project
6464
<reportSets>
6565
<reportSet>
6666
<id>aggregate</id>
67-
<inherited>false</inherited>
67+
<inherited>false</inherited>
6868
<reports>
6969
<report>aggregate</report>
7070
</reports>
@@ -178,8 +178,8 @@ Project
178178
Be aware that is not possible to have a mixture of named and unnamed modules. Ideally every Maven module has a Java module descriptor,
179179
but this is not always possible, e.g. due to split packages of dependencies.
180180
In such case you must have a jar containing a <<<META-INF/MANIFEST.MF>>> with an entry for the <<<Automatic-Module-Name>>>.
181-
In other words: ensure to call <<<package javadoc:aggregate>>>, because the manifest file is only being read from jar, not from folder.
182-
181+
In other words: ensure to call <<<package javadoc:aggregate>>>, because the manifest file is only being read from jar, not from directory.
182+
183183
+-----+
184184
<plugin>
185185
<groupId>org.apache.maven.plugins</groupId>
@@ -191,7 +191,7 @@ Project
191191
</manifestEntries>
192192
</archive>
193193
</configuration>
194-
</plugin>
194+
</plugin>
195195
+-----+
196196

197197
Occasionally, automatic modules need to import named modules. For example,

Diff for: ‎src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -230,13 +230,13 @@ public void testAggregateJavadocResources() throws Exception {
230230
assertTrue(new File(apidocs, "resources/test/doc-files/maven-feather.png").exists());
231231
}
232232

233-
public void testAggregateWithModulsNotInSubFolders() throws Exception {
234-
File testPom = new File(unit, "aggregate-modules-not-in-subfolders-test/all/pom.xml");
233+
public void testAggregateWithModulsNotInSubDirectories() throws Exception {
234+
File testPom = new File(unit, "aggregate-modules-not-in-subdirectories-test/all/pom.xml");
235235
JavadocReport mojo = lookupMojo(testPom);
236236
mojo.execute();
237237

238-
File apidocs =
239-
new File(getBasedir(), "target/test/unit/aggregate-modules-not-in-subfolders-test/target/site/apidocs");
238+
File apidocs = new File(
239+
getBasedir(), "target/test/unit/aggregate-modules-not-in-subdirectories-test/target/site/apidocs");
240240
assertTrue(apidocs.isDirectory());
241241
assertTrue(getOverviewSummary(apidocs).isFile());
242242
}

Diff for: ‎src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject1TestMavenProjectStub.java renamed to ‎src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubDirectoryProject1TestMavenProjectStub.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@
2121
/**
2222
* @author <a href="mailto:reto.weiss@axonivy.com">Reto Weiss</a>
2323
*/
24-
public class AggregateNotInSubFolderProject1TestMavenProjectStub extends AbstractAggregateChildMavenProjectStub {
25-
public AggregateNotInSubFolderProject1TestMavenProjectStub() {
24+
public class AggregateNotInSubDirectoryProject1TestMavenProjectStub extends AbstractAggregateChildMavenProjectStub {
25+
public AggregateNotInSubDirectoryProject1TestMavenProjectStub() {
2626
super(
27-
"/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1",
27+
"/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project1",
2828
"pom.xml",
29-
"/target/test/unit/aggregate-modules-not-in-subfolders-test/project1/target");
29+
"/target/test/unit/aggregate-modules-not-in-subdirectories-test/project1/target");
3030
}
3131
}

Diff for: ‎src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject2TestMavenProjectStub.java renamed to ‎src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubDirectoryProject2TestMavenProjectStub.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@
2121
/**
2222
* @author <a href="mailto:reto.weiss@axonivy.com">Reto Weiss</a>
2323
*/
24-
public class AggregateNotInSubFolderProject2TestMavenProjectStub extends AbstractAggregateChildMavenProjectStub {
25-
public AggregateNotInSubFolderProject2TestMavenProjectStub() {
24+
public class AggregateNotInSubDirectoryProject2TestMavenProjectStub extends AbstractAggregateChildMavenProjectStub {
25+
public AggregateNotInSubDirectoryProject2TestMavenProjectStub() {
2626
super(
27-
"/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2",
27+
"/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project2",
2828
"pom.xml",
29-
"/target/test/unit/aggregate-modules-not-in-subfolders-test/project2/target");
29+
"/target/test/unit/aggregate-modules-not-in-subdirectories-test/project2/target");
3030
}
3131
}

Diff for: ‎src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderTestMavenProjectStub.java renamed to ‎src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubDirectoryTestMavenProjectStub.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@
2121
/**
2222
* @author <a href="mailto:reto.weiss@axonivy.com">Reto Weiss</a>
2323
*/
24-
public class AggregateNotInSubFolderTestMavenProjectStub extends AbstractAggregateMavenProjectStub {
25-
public AggregateNotInSubFolderTestMavenProjectStub() {
24+
public class AggregateNotInSubDirectoryTestMavenProjectStub extends AbstractAggregateMavenProjectStub {
25+
public AggregateNotInSubDirectoryTestMavenProjectStub() {
2626
super(
27-
"/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/all",
27+
"/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/all",
2828
"pom.xml",
29-
"/target/test/unit/aggregate-modules-not-in-subfolders-test/target",
29+
"/target/test/unit/aggregate-modules-not-in-subdirectories-test/target",
3030
"../project1",
3131
"../project2");
3232
}

Diff for: ‎src/test/resources/unit/aggregate-modules-not-in-subfolders-test/all/pom.xml renamed to ‎src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/all/pom.xml

+8-8
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ under the License.
2121
<modelVersion>4.0.0</modelVersion>
2222

2323
<groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
24-
<artifactId>aggregate-modules-not-in-subfolders-test-resources-test</artifactId>
24+
<artifactId>aggregate-modules-not-in-subdirectories-test-resources-test</artifactId>
2525
<version>1.0-SNAPSHOT</version>
2626
<packaging>pom</packaging>
2727

@@ -36,20 +36,20 @@ under the License.
3636
<artifactId>maven-javadoc-plugin</artifactId>
3737
<configuration>
3838
<encoding>ISO-8859-1</encoding>
39-
<project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubFolderTestMavenProjectStub"/>
40-
<outputDirectory>${basedir}/target/test/unit/aggregate-modules-not-in-subfolders-test/target/site/apidocs</outputDirectory>
41-
<javadocOptionsDir>${basedir}/target/test/unit/aggregate-modules-not-in-subfolders-test/target/javadoc-bundle-options</javadocOptionsDir>
39+
<project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubDirectoryTestMavenProjectStub"/>
40+
<outputDirectory>${basedir}/target/test/unit/aggregate-modules-not-in-subdirectories-test/target/site/apidocs</outputDirectory>
41+
<javadocOptionsDir>${basedir}/target/test/unit/aggregate-modules-not-in-subdirectories-test/target/javadoc-bundle-options</javadocOptionsDir>
4242
<windowtitle>Maven Javadoc Plugin aggregate resources 1.0-SNAPSHOT API</windowtitle>
4343
<reactorProjects>
44-
<project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubFolderTestMavenProjectStub"/>
45-
<project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubFolderProject1TestMavenProjectStub"/>
46-
<project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubFolderProject2TestMavenProjectStub"/>
44+
<project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubDirectoryTestMavenProjectStub"/>
45+
<project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubDirectoryProject1TestMavenProjectStub"/>
46+
<project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubDirectoryProject2TestMavenProjectStub"/>
4747
</reactorProjects>
4848
<show>protected</show>
4949
<groups/>
5050
<tags/>
5151
<quiet>true</quiet>
52-
<javadocDirectory>${basedir}/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/src/main/javadoc</javadocDirectory>
52+
<javadocDirectory>${basedir}/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/src/main/javadoc</javadocDirectory>
5353
<debug>true</debug>
5454
<docfilessubdirs>true</docfilessubdirs>
5555
<stylesheet>java</stylesheet>

Diff for: ‎src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/pom.xml renamed to ‎src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project1/pom.xml

+31-31
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
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-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20-
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
21-
<modelVersion>4.0.0</modelVersion>
22-
<parent>
23-
<groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
24-
<artifactId>aggregate-modules-not-in-subfolders-test-resources-test</artifactId>
25-
<version>1.0-SNAPSHOT</version>
26-
</parent>
27-
<groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
28-
<artifactId>aggregate-modules-not-in-subfolders-test-resources-test-project1</artifactId>
29-
<version>1.0-SNAPSHOT</version>
30-
<packaging>jar</packaging>
31-
</project>
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+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
21+
<modelVersion>4.0.0</modelVersion>
22+
<parent>
23+
<groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
24+
<artifactId>aggregate-modules-not-in-subdirectories-test-resources-test</artifactId>
25+
<version>1.0-SNAPSHOT</version>
26+
</parent>
27+
<groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
28+
<artifactId>aggregate-modules-not-in-subdirectories-test-resources-test-project1</artifactId>
29+
<version>1.0-SNAPSHOT</version>
30+
<packaging>jar</packaging>
31+
</project>

Diff for: ‎src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/src/main/java/test1/Hello.java renamed to ‎src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project1/src/main/java/test1/Hello.java

File renamed without changes.

Diff for: ‎src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/pom.xml renamed to ‎src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project2/pom.xml

+32-32
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
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-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20-
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
21-
<modelVersion>4.0.0</modelVersion>
22-
23-
<parent>
24-
<groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
25-
<artifactId>aggregate-modules-not-in-subfolders-test-resources-test</artifactId>
26-
<version>1.0-SNAPSHOT</version>
27-
</parent>
28-
<groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
29-
<artifactId>aggregate-modules-not-in-subfolders-test-resources-test-project2</artifactId>
30-
<version>1.0-SNAPSHOT</version>
31-
<packaging>jar</packaging>
32-
</project>
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+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
21+
<modelVersion>4.0.0</modelVersion>
22+
23+
<parent>
24+
<groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
25+
<artifactId>aggregate-modules-not-in-subdirectories-test-resources-test</artifactId>
26+
<version>1.0-SNAPSHOT</version>
27+
</parent>
28+
<groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
29+
<artifactId>aggregate-modules-not-in-subdirectories-test-resources-test-project2</artifactId>
30+
<version>1.0-SNAPSHOT</version>
31+
<packaging>jar</packaging>
32+
</project>

Diff for: ‎src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/src/main/java/test2/World.java renamed to ‎src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project2/src/main/java/test2/World.java

File renamed without changes.

Diff for: ‎src/test/resources/unit/stale-test/stale-test-plugin-config.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ under the License.
5656
<debug>true</debug>
5757
<failOnError>true</failOnError>
5858
<reactorProjects>
59-
<project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubFolderTestMavenProjectStub"/>
59+
<project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubDirectoryTestMavenProjectStub"/>
6060
</reactorProjects>
6161
<staleDataPath>${basedir}/target/test/unit/stale-test/target/maven-javadoc-plugin-stale-data.txt</staleDataPath>
6262
</configuration>

0 commit comments

Comments
 (0)