directory, not folder

Use property term for item type on a filesystem.
apache · Nov 26, 2023 · b47b280 · b47b280
1 parent 488624f
commit b47b280
Show file tree

Hide file tree

Showing 13 changed files with 98 additions and 98 deletions.
diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
@@ -711,8 +711,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
      * <p>
      * Wildcards work as followed:
      * <ul>
-     *   <li>a wildcard at the beginning should match 1 or more folders</li>
-     *   <li>any other wildcard must match exactly one folder</li>
+     *   <li>a wildcard at the beginning should match one or more directories</li>
+     *   <li>any other wildcard must match exactly one directory</li>
      * </ul>
      * </p>
      * Example:

diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java b/src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java
@@ -372,8 +372,8 @@ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IO
             // Usage of wildcard was bad specified and bad implemented, i.e. using String.contains()
             //   without respecting surrounding context
             // Following implementation should match requirements as defined in the examples:
-            // - A wildcard at the beginning should match 1 or more folders
-            // - Any other wildcard must match exactly one folder
+            // - A wildcard at the beginning should match one or more directories
+            // - Any other wildcard must match exactly one directory
             Pattern p = Pattern.compile(excludePackagename
                     .replace(".", regexFileSeparator)
                     .replaceFirst("^\\*", ".+")

diff --git a/src/site/apt/examples/aggregate.apt.vm b/src/site/apt/examples/aggregate.apt.vm
@@ -48,10 +48,10 @@ Project
 
 +-----+
 
- Since 3.1.0 the <<<aggregate>>> has changed a little bit. It'll generate aggregated 
+ Since 3.1.0 the <<<aggregate>>> has changed a little bit. It'll generate aggregated
  reports at every level.
  To get only an aggregated project at root level, you need to configure the pom like:
- 
+
 +-----+
 <project>
   ...
@@ -64,7 +64,7 @@ Project
         <reportSets>
           <reportSet>
             <id>aggregate</id>
-            <inherited>false</inherited>        
+            <inherited>false</inherited>
             <reports>
               <report>aggregate</report>
             </reports>
@@ -178,8 +178,8 @@ Project
   Be aware that is not possible to have a mixture of named and unnamed modules. Ideally every Maven module has a Java module descriptor,
   but this is not always possible, e.g. due to split packages of dependencies.
   In such case you must have a jar containing a <<<META-INF/MANIFEST.MF>>> with an entry for the <<<Automatic-Module-Name>>>.
-  In other words: ensure to call <<<package javadoc:aggregate>>>, because the manifest file is only being read from jar, not from folder.
-  
+  In other words: ensure to call <<<package javadoc:aggregate>>>, because the manifest file is only being read from jar, not from directory.
+
 +-----+
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
@@ -191,7 +191,7 @@ Project
               </manifestEntries>
             </archive>
           </configuration>
-        </plugin>  
+        </plugin>
 +-----+
 
   Occasionally, automatic modules need to import named modules. For example,

diff --git a/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java b/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java
@@ -230,13 +230,13 @@ public void testAggregateJavadocResources() throws Exception {
         assertTrue(new File(apidocs, "resources/test/doc-files/maven-feather.png").exists());
     }
 
-    public void testAggregateWithModulsNotInSubFolders() throws Exception {
-        File testPom = new File(unit, "aggregate-modules-not-in-subfolders-test/all/pom.xml");
+    public void testAggregateWithModulsNotInSubDirectories() throws Exception {
+        File testPom = new File(unit, "aggregate-modules-not-in-subdirectories-test/all/pom.xml");
         JavadocReport mojo = lookupMojo(testPom);
         mojo.execute();
 
-        File apidocs =
-                new File(getBasedir(), "target/test/unit/aggregate-modules-not-in-subfolders-test/target/site/apidocs");
+        File apidocs = new File(
+                getBasedir(), "target/test/unit/aggregate-modules-not-in-subdirectories-test/target/site/apidocs");
         assertTrue(apidocs.isDirectory());
         assertTrue(getOverviewSummary(apidocs).isFile());
     }

diff --git a/...ubFolderProject1TestMavenProjectStub.java → ...irectoryProject1TestMavenProjectStub.java b/...ubFolderProject1TestMavenProjectStub.java → ...irectoryProject1TestMavenProjectStub.java
@@ -21,11 +21,11 @@
 /**
  * @author <a href="mailto:reto.weiss@axonivy.com">Reto Weiss</a>
  */
-public class AggregateNotInSubFolderProject1TestMavenProjectStub extends AbstractAggregateChildMavenProjectStub {
-    public AggregateNotInSubFolderProject1TestMavenProjectStub() {
+public class AggregateNotInSubDirectoryProject1TestMavenProjectStub extends AbstractAggregateChildMavenProjectStub {
+    public AggregateNotInSubDirectoryProject1TestMavenProjectStub() {
         super(
-                "/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1",
+                "/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project1",
                 "pom.xml",
-                "/target/test/unit/aggregate-modules-not-in-subfolders-test/project1/target");
+                "/target/test/unit/aggregate-modules-not-in-subdirectories-test/project1/target");
     }
 }
diff --git a/...ubFolderProject2TestMavenProjectStub.java → ...irectoryProject2TestMavenProjectStub.java b/...ubFolderProject2TestMavenProjectStub.java → ...irectoryProject2TestMavenProjectStub.java
@@ -21,11 +21,11 @@
 /**
  * @author <a href="mailto:reto.weiss@axonivy.com">Reto Weiss</a>
  */
-public class AggregateNotInSubFolderProject2TestMavenProjectStub extends AbstractAggregateChildMavenProjectStub {
-    public AggregateNotInSubFolderProject2TestMavenProjectStub() {
+public class AggregateNotInSubDirectoryProject2TestMavenProjectStub extends AbstractAggregateChildMavenProjectStub {
+    public AggregateNotInSubDirectoryProject2TestMavenProjectStub() {
         super(
-                "/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2",
+                "/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project2",
                 "pom.xml",
-                "/target/test/unit/aggregate-modules-not-in-subfolders-test/project2/target");
+                "/target/test/unit/aggregate-modules-not-in-subdirectories-test/project2/target");
     }
 }
diff --git a/...teNotInSubFolderTestMavenProjectStub.java → ...otInSubDirectoryTestMavenProjectStub.java b/...teNotInSubFolderTestMavenProjectStub.java → ...otInSubDirectoryTestMavenProjectStub.java
@@ -21,12 +21,12 @@
 /**
  * @author <a href="mailto:reto.weiss@axonivy.com">Reto Weiss</a>
  */
-public class AggregateNotInSubFolderTestMavenProjectStub extends AbstractAggregateMavenProjectStub {
-    public AggregateNotInSubFolderTestMavenProjectStub() {
+public class AggregateNotInSubDirectoryTestMavenProjectStub extends AbstractAggregateMavenProjectStub {
+    public AggregateNotInSubDirectoryTestMavenProjectStub() {
         super(
-                "/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/all",
+                "/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/all",
                 "pom.xml",
-                "/target/test/unit/aggregate-modules-not-in-subfolders-test/target",
+                "/target/test/unit/aggregate-modules-not-in-subdirectories-test/target",
                 "../project1",
                 "../project2");
     }

diff --git a/...odules-not-in-subfolders-test/all/pom.xml → ...es-not-in-subdirectories-test/all/pom.xml b/...odules-not-in-subfolders-test/all/pom.xml → ...es-not-in-subdirectories-test/all/pom.xml
@@ -21,7 +21,7 @@ under the License.
   <modelVersion>4.0.0</modelVersion>
 
   <groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
-  <artifactId>aggregate-modules-not-in-subfolders-test-resources-test</artifactId>
+  <artifactId>aggregate-modules-not-in-subdirectories-test-resources-test</artifactId>
   <version>1.0-SNAPSHOT</version>
   <packaging>pom</packaging>
 
@@ -36,20 +36,20 @@ under the License.
         <artifactId>maven-javadoc-plugin</artifactId>
         <configuration>
           <encoding>ISO-8859-1</encoding>
-          <project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubFolderTestMavenProjectStub"/>
-          <outputDirectory>${basedir}/target/test/unit/aggregate-modules-not-in-subfolders-test/target/site/apidocs</outputDirectory>
-          <javadocOptionsDir>${basedir}/target/test/unit/aggregate-modules-not-in-subfolders-test/target/javadoc-bundle-options</javadocOptionsDir>
+          <project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubDirectoryTestMavenProjectStub"/>
+          <outputDirectory>${basedir}/target/test/unit/aggregate-modules-not-in-subdirectories-test/target/site/apidocs</outputDirectory>
+          <javadocOptionsDir>${basedir}/target/test/unit/aggregate-modules-not-in-subdirectories-test/target/javadoc-bundle-options</javadocOptionsDir>
           <windowtitle>Maven Javadoc Plugin aggregate resources 1.0-SNAPSHOT API</windowtitle>
           <reactorProjects>
-            <project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubFolderTestMavenProjectStub"/>
-            <project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubFolderProject1TestMavenProjectStub"/>
-            <project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubFolderProject2TestMavenProjectStub"/>
+            <project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubDirectoryTestMavenProjectStub"/>
+            <project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubDirectoryProject1TestMavenProjectStub"/>
+            <project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubDirectoryProject2TestMavenProjectStub"/>
           </reactorProjects>
           <show>protected</show>
           <groups/>
           <tags/>
           <quiet>true</quiet>
-          <javadocDirectory>${basedir}/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/src/main/javadoc</javadocDirectory>
+          <javadocDirectory>${basedir}/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/src/main/javadoc</javadocDirectory>
           <debug>true</debug>
           <docfilessubdirs>true</docfilessubdirs>
           <stylesheet>java</stylesheet>

diff --git a/...s-not-in-subfolders-test/project1/pom.xml → ...t-in-subdirectories-test/project1/pom.xml b/...s-not-in-subfolders-test/project1/pom.xml → ...t-in-subdirectories-test/project1/pom.xml
@@ -1,31 +1,31 @@
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements.  See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership.  The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License.  You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied.  See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-	<modelVersion>4.0.0</modelVersion>
-  <parent>
-    <groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
-    <artifactId>aggregate-modules-not-in-subfolders-test-resources-test</artifactId>
-    <version>1.0-SNAPSHOT</version>
-  </parent>
-	<groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
-	<artifactId>aggregate-modules-not-in-subfolders-test-resources-test-project1</artifactId>
-	<version>1.0-SNAPSHOT</version>
-	<packaging>jar</packaging>
-</project>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
+    <artifactId>aggregate-modules-not-in-subdirectories-test-resources-test</artifactId>
+    <version>1.0-SNAPSHOT</version>
+  </parent>
+	<groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
+	<artifactId>aggregate-modules-not-in-subdirectories-test-resources-test-project1</artifactId>
+	<version>1.0-SNAPSHOT</version>
+	<packaging>jar</packaging>
+</project>
diff --git a/...t/project1/src/main/java/test1/Hello.java → ...t/project1/src/main/java/test1/Hello.java b/...t/project1/src/main/java/test1/Hello.java → ...t/project1/src/main/java/test1/Hello.java
diff --git a/...s-not-in-subfolders-test/project2/pom.xml → ...t-in-subdirectories-test/project2/pom.xml b/...s-not-in-subfolders-test/project2/pom.xml → ...t-in-subdirectories-test/project2/pom.xml
@@ -1,32 +1,32 @@
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements.  See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership.  The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License.  You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied.  See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-	<modelVersion>4.0.0</modelVersion>
-
-  <parent>
-    <groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
-    <artifactId>aggregate-modules-not-in-subfolders-test-resources-test</artifactId>
-    <version>1.0-SNAPSHOT</version>
-  </parent>
-  <groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
-  <artifactId>aggregate-modules-not-in-subfolders-test-resources-test-project2</artifactId>
-  <version>1.0-SNAPSHOT</version>
-  <packaging>jar</packaging>
-</project>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
+    <artifactId>aggregate-modules-not-in-subdirectories-test-resources-test</artifactId>
+    <version>1.0-SNAPSHOT</version>
+  </parent>
+  <groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
+  <artifactId>aggregate-modules-not-in-subdirectories-test-resources-test-project2</artifactId>
+  <version>1.0-SNAPSHOT</version>
+  <packaging>jar</packaging>
+</project>
diff --git a/...t/project2/src/main/java/test2/World.java → ...t/project2/src/main/java/test2/World.java b/...t/project2/src/main/java/test2/World.java → ...t/project2/src/main/java/test2/World.java
diff --git a/src/test/resources/unit/stale-test/stale-test-plugin-config.xml b/src/test/resources/unit/stale-test/stale-test-plugin-config.xml
@@ -56,7 +56,7 @@ under the License.
           <debug>true</debug>
           <failOnError>true</failOnError>
           <reactorProjects>
-            <project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubFolderTestMavenProjectStub"/>
+            <project implementation="org.apache.maven.plugins.javadoc.stubs.AggregateNotInSubDirectoryTestMavenProjectStub"/>
           </reactorProjects>
           <staleDataPath>${basedir}/target/test/unit/stale-test/target/maven-javadoc-plugin-stale-data.txt</staleDataPath>
         </configuration>