diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java index 9fdbad2c6..a07a0bcb4 100644 --- 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 { *

* Wildcards work as followed: *

*

* 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 index 0da8bb1a2..835d63324 100644 --- 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 index 769d4adb1..434e4d40f 100644 --- 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 <<>> has changed a little bit. It'll generate aggregated + Since 3.1.0 the <<>> 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: - + +-----+ ... @@ -64,7 +64,7 @@ Project aggregate - false + false aggregate @@ -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 <<>> with an entry for the <<>>. - In other words: ensure to call <<>>, because the manifest file is only being read from jar, not from folder. - + In other words: ensure to call <<>>, because the manifest file is only being read from jar, not from directory. + +-----+ org.apache.maven.plugins @@ -191,7 +191,7 @@ Project - + +-----+ 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 index 36bd7d890..c394905de 100644 --- 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/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject1TestMavenProjectStub.java b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubDirectoryProject1TestMavenProjectStub.java similarity index 76% rename from src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject1TestMavenProjectStub.java rename to src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubDirectoryProject1TestMavenProjectStub.java index 93613a184..d3ee8c918 100644 --- a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject1TestMavenProjectStub.java +++ b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubDirectoryProject1TestMavenProjectStub.java @@ -21,11 +21,11 @@ /** * @author Reto Weiss */ -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/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject2TestMavenProjectStub.java b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubDirectoryProject2TestMavenProjectStub.java similarity index 76% rename from src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject2TestMavenProjectStub.java rename to src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubDirectoryProject2TestMavenProjectStub.java index d596903e7..52bfd90ee 100644 --- a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderProject2TestMavenProjectStub.java +++ b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubDirectoryProject2TestMavenProjectStub.java @@ -21,11 +21,11 @@ /** * @author Reto Weiss */ -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/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderTestMavenProjectStub.java b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubDirectoryTestMavenProjectStub.java similarity index 79% rename from src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderTestMavenProjectStub.java rename to src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubDirectoryTestMavenProjectStub.java index f390f7e3d..a0a8f706a 100644 --- a/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubFolderTestMavenProjectStub.java +++ b/src/test/java/org/apache/maven/plugins/javadoc/stubs/AggregateNotInSubDirectoryTestMavenProjectStub.java @@ -21,12 +21,12 @@ /** * @author Reto Weiss */ -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/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/all/pom.xml b/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/all/pom.xml similarity index 80% rename from src/test/resources/unit/aggregate-modules-not-in-subfolders-test/all/pom.xml rename to src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/all/pom.xml index b84312f9d..ace258172 100644 --- a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/all/pom.xml +++ b/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/all/pom.xml @@ -21,7 +21,7 @@ under the License. 4.0.0 org.apache.maven.plugins.maven-javadoc-plugin.unit - aggregate-modules-not-in-subfolders-test-resources-test + aggregate-modules-not-in-subdirectories-test-resources-test 1.0-SNAPSHOT pom @@ -36,20 +36,20 @@ under the License. maven-javadoc-plugin ISO-8859-1 - - ${basedir}/target/test/unit/aggregate-modules-not-in-subfolders-test/target/site/apidocs - ${basedir}/target/test/unit/aggregate-modules-not-in-subfolders-test/target/javadoc-bundle-options + + ${basedir}/target/test/unit/aggregate-modules-not-in-subdirectories-test/target/site/apidocs + ${basedir}/target/test/unit/aggregate-modules-not-in-subdirectories-test/target/javadoc-bundle-options Maven Javadoc Plugin aggregate resources 1.0-SNAPSHOT API - - - + + + protected true - ${basedir}/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/src/main/javadoc + ${basedir}/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/src/main/javadoc true true java diff --git a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/pom.xml b/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project1/pom.xml similarity index 86% rename from src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/pom.xml rename to src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project1/pom.xml index 0350abc85..1177c7481 100644 --- a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/pom.xml +++ b/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project1/pom.xml @@ -1,31 +1,31 @@ - - - 4.0.0 - - org.apache.maven.plugins.maven-javadoc-plugin.unit - aggregate-modules-not-in-subfolders-test-resources-test - 1.0-SNAPSHOT - - org.apache.maven.plugins.maven-javadoc-plugin.unit - aggregate-modules-not-in-subfolders-test-resources-test-project1 - 1.0-SNAPSHOT - jar - + + + 4.0.0 + + org.apache.maven.plugins.maven-javadoc-plugin.unit + aggregate-modules-not-in-subdirectories-test-resources-test + 1.0-SNAPSHOT + + org.apache.maven.plugins.maven-javadoc-plugin.unit + aggregate-modules-not-in-subdirectories-test-resources-test-project1 + 1.0-SNAPSHOT + jar + diff --git a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/src/main/java/test1/Hello.java b/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project1/src/main/java/test1/Hello.java similarity index 100% rename from src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project1/src/main/java/test1/Hello.java rename to src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project1/src/main/java/test1/Hello.java diff --git a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/pom.xml b/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project2/pom.xml similarity index 86% rename from src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/pom.xml rename to src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project2/pom.xml index 7b847b5ae..3b5045201 100644 --- a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/pom.xml +++ b/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project2/pom.xml @@ -1,32 +1,32 @@ - - - 4.0.0 - - - org.apache.maven.plugins.maven-javadoc-plugin.unit - aggregate-modules-not-in-subfolders-test-resources-test - 1.0-SNAPSHOT - - org.apache.maven.plugins.maven-javadoc-plugin.unit - aggregate-modules-not-in-subfolders-test-resources-test-project2 - 1.0-SNAPSHOT - jar - + + + 4.0.0 + + + org.apache.maven.plugins.maven-javadoc-plugin.unit + aggregate-modules-not-in-subdirectories-test-resources-test + 1.0-SNAPSHOT + + org.apache.maven.plugins.maven-javadoc-plugin.unit + aggregate-modules-not-in-subdirectories-test-resources-test-project2 + 1.0-SNAPSHOT + jar + diff --git a/src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/src/main/java/test2/World.java b/src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/project2/src/main/java/test2/World.java similarity index 100% rename from src/test/resources/unit/aggregate-modules-not-in-subfolders-test/project2/src/main/java/test2/World.java rename to src/test/resources/unit/aggregate-modules-not-in-subdirectories-test/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 index a463df983..cf9875dd9 100644 --- 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. true true - + ${basedir}/target/test/unit/stale-test/target/maven-javadoc-plugin-stale-data.txt