You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2023/04/30 09:28:48 UTC
[maven-javadoc-plugin] branch doxia-2.0.0 updated (861a26e4 -> 37ba82e2)
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a change to branch doxia-2.0.0
in repository https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git
discard 861a26e4 Prepare for Doxia 2.0.0
add 5af4519c [MJAVADOC-705] Upgrade Maven Reporting API to 3.1.0
add 50a41f78 [maven-release-plugin] prepare release maven-javadoc-plugin-3.3.2
add 313fd4bb [maven-release-plugin] prepare for next development iteration
add 3ce03576 (doc) Update plugin' configuration parameter (MJAVADOC-475)
add 80e2646e (doc) Update plugin' configuration parameter (MJAVADOC-475)
add 3ba873cf (doc) Fix spurious Javadoc @param tag
add 9dd7bddb use shared gh action/release-drafter (#128)
add 25835541 Bump commons-io from 2.2 to 2.7 in /src/it/projects/MJAVADOC-437/module2
add ca006016 Bump junit in /src/it/projects/MJAVADOC-498_modulepath
add 5dcfa6e7 Bump plexus-archiver from 4.2.6 to 4.2.7
add 03ca8437 Bump maven-archiver from 3.5.1 to 3.5.2
add 5fae3b65 [MJAVADOC-711] Upgrade plugins in ITs
add 47d03d3a [MJAVADOC-712] Remove remains of org.codehaus.doxia.sink.Sink
add 506cb74e [MJAVADOC-696] Invalid anchors in Javadoc and plugin mojo
add 0c6b32fb [MJAVADOC-714] Upgrade to Maven 3.2.5
add 40cc602f [maven-release-plugin] prepare release maven-javadoc-plugin-3.4.0
add cc8608ce [maven-release-plugin] prepare for next development iteration
add 4306c920 Bump mockito-core from 4.1.0 to 4.4.0
add b9289708 Bump spring-webmvc in /src/it/projects/MJAVADOC-434_fixcompile
add 34b501d7 Bump assertj-core from 3.21.0 to 3.23.1
add 497f80f4 [MJAVADOC-719] - Update Maven Archiver to 3.6.0
add bacc078f Add Integration Test for reproducible builds
add 92ce6688 Ignore Maven Core updates
add 26d84b26 Add notimestamp for reproducible builds test
add c19dba2f Skip Java 9-14 in reproducible test
add a10f0b11 [MJAVADOC-723] Upgrade Maven Reporting API to 3.1.1/Complete with Maven Reporting Impl 3.2.0
add a5db96e7 [maven-release-plugin] prepare release maven-javadoc-plugin-3.4.1
add 231316be [maven-release-plugin] prepare for next development iteration
add 139af8ce [MJAVADOC-721] Parse stderr output and suppress informational lines
add 23792f2c fix link to documentation of link option (#160)
add 7cbf4349 [MJAVADOC-729] Link to Javadoc references from JDK 17 (#161)
add ebde546a [MJAVADOC-685] Deprecate parameter "stylesheet" (#162)
add 1286b859 Add SLF4J Simple to the test classpath
add 8b589325 MJAVADOC-731 Update parent, get rid of legacy (#164)
add a45bd489 [MJAVADOC-685] No longer document deprecated parameter stylesheet (#165)
add e8476dac licenced --> licensed
add 14d75aa4 Update
add 5b61ee91 an --> a (#171)
add f21b24c7 update Reproducible Builds badge link
add 96df545a [MJAVADOC-738] Upgrade commons-text to 1.10.0 (#174)
add 73557e33 Fixed a typo in AbstractJavadocMojo (#175)
add a654cc64 Assorted minor FAQ edits (#176)
add fabff9c1 Clean up language and update URLs (#172)
add 41233152 [MJAVADOC-700] Plugin duplicates classes in Java 8 all-classes lists
add d02fd90c [MJAVADOC-740] Upgrade Parent to 39
add c56ec0a9 [MJAVADOC-741] Upgrade plugins and components
add e41f4fda [maven-release-plugin] prepare release maven-javadoc-plugin-3.5.0
add 0329124b [maven-release-plugin] prepare for next development iteration
add ca297515 (doc) Remove deprecated maven-changes-plugin (MPOM-348)
add 509a391d Bump apache/maven-gh-actions-shared from 2 to 3
add adc0f07a tests: Bump spring-security-core to 5.5.8 to fix vulnerabilities
add 9040d0da ci fix: adopt-openj9 does not support the footer param
add 931164d0 Remove Netware code (#197)
add f1aea612 Fix UmlGraph link in site example
add 62e2bae3 [MNG-6825] Replace StringUtils
add 0f3a524f Bump mockito-core from 4.4.0 to 4.11.0
add 6f72300b Auto-link MJAVADOC Jira
new 37ba82e2 Prepare for Doxia 2.0.0
This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (861a26e4)
\
N -- N -- N refs/heads/doxia-2.0.0 (37ba82e2)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.asf.yaml | 11 +
.github/dependabot.yml | 3 +
.github/pull_request_template.md | 2 +-
.../release-drafter.yml | 37 +-
.github/workflows/maven.yml | 34 +-
.../release-drafter.yml} | 22 +-
README.md | 2 +-
pom.xml | 276 +-
.../projects/MJAVADOC-134_multiaggregate/pom.xml | 2 +-
src/it/projects/MJAVADOC-434_fixcompile/pom.xml | 2 +-
src/it/projects/MJAVADOC-437/module2/pom.xml | 2 +-
src/it/projects/MJAVADOC-498_modulepath/pom.xml | 2 +-
.../javadoc-child/pom.xml | 4 +-
.../com/leokom/javadoc/JavadocMavenBugDemo.java | 2 +-
.../MJAVADOC-613-aggregate-exclude/pom.xml | 2 +-
.../MJAVADOC-636-aggregate_module_skipped/pom.xml | 2 +-
src/it/projects/examples/alternate-doclet/pom.xml | 4 +-
.../invoker.properties | 10 +-
.../pom.xml | 4 +-
.../src/main/java/foo/Bar.java | 3 +-
src/it/projects/reproducible/verify.groovy | 61 +
src/it/projects/site-failOnError/pom.xml | 2 +-
.../plugins/javadoc/AbstractFixJavadocMojo.java | 6929 +++++++++-----------
.../maven/plugins/javadoc/AbstractJavadocMojo.java | 5488 ++++++----------
.../plugins/javadoc/AdditionalDependency.java | 61 +-
.../plugins/javadoc/AggregatorJavadocJar.java | 92 +-
.../javadoc/AggregatorJavadocNoForkReport.java | 14 +-
.../plugins/javadoc/AggregatorJavadocReport.java | 88 +-
.../plugins/javadoc/AggregatorTestJavadocJar.java | 92 +-
.../javadoc/AggregatorTestJavadocNoForkReport.java | 14 +-
.../javadoc/AggregatorTestJavadocReport.java | 88 +-
.../maven/plugins/javadoc/DependencyLink.java | 46 +-
.../maven/plugins/javadoc/FixJavadocMojo.java | 78 +-
.../javadoc/JavadocArchiveConfiguration.java | 12 +-
.../apache/maven/plugins/javadoc/JavadocJar.java | 593 +-
.../maven/plugins/javadoc/JavadocModule.java | 39 +-
.../maven/plugins/javadoc/JavadocNoForkReport.java | 18 +-
.../maven/plugins/javadoc/JavadocReport.java | 664 +-
.../apache/maven/plugins/javadoc/JavadocUtil.java | 3424 +++++-----
.../maven/plugins/javadoc/JavadocVersion.java | 169 +-
.../maven/plugins/javadoc/ResourcesBundleMojo.java | 274 +-
.../apache/maven/plugins/javadoc/StaleHelper.java | 159 +-
.../apache/maven/plugins/javadoc/SystemUtils.java | 52 +-
.../maven/plugins/javadoc/TestFixJavadocMojo.java | 156 +-
.../maven/plugins/javadoc/TestJavadocJar.java | 430 +-
.../plugins/javadoc/TestJavadocNoForkReport.java | 18 +-
.../maven/plugins/javadoc/TestJavadocReport.java | 680 +-
.../plugins/javadoc/TestResourcesBundleMojo.java | 131 +-
.../plugins/javadoc/resolver/JavadocBundle.java | 118 +-
.../plugins/javadoc/resolver/ResourceResolver.java | 846 ++-
.../javadoc/resolver/SourceResolverConfig.java | 328 +-
.../maven/plugins/javadoc/css/stylesheet.css | 64 -
src/site/apt/examples/alternate-doclet.apt.vm | 2 +-
src/site/apt/examples/fix-javadocs.apt.vm | 43 +-
src/site/apt/examples/links-configuration.apt.vm | 26 +-
.../apt/examples/stylesheet-configuration.apt.vm | 34 +-
src/site/apt/usage.apt.vm | 2 +-
src/site/fml/faq.fml | 142 +-
.../javadoc/AbstractFixJavadocMojoTest.java | 326 +-
.../plugins/javadoc/AbstractJavadocMojoTest.java | 171 +-
.../javadoc/AggregatorJavadocReportTest.java | 517 +-
.../maven/plugins/javadoc/FixJavadocMojoTest.java | 1272 ++--
.../maven/plugins/javadoc/JavadocJarTest.java | 390 +-
.../maven/plugins/javadoc/JavadocReportTest.java | 1498 ++---
.../maven/plugins/javadoc/JavadocUtilTest.java | 1376 ++--
.../maven/plugins/javadoc/JavadocVersionTest.java | 133 +-
.../apache/maven/plugins/javadoc/ProxyServer.java | 428 +-
.../plugins/javadoc/TestJavadocReportTest.java | 139 +-
.../io/xpp3/JavadocOptionsXpp3ReaderTest.java | 24 +-
.../AbstractAggregateChildMavenProjectStub.java | 160 +-
.../stubs/AbstractAggregateMavenProjectStub.java | 174 +-
...NotInSubFolderProject1TestMavenProjectStub.java | 65 +-
...NotInSubFolderProject2TestMavenProjectStub.java | 65 +-
...ggregateNotInSubFolderTestMavenProjectStub.java | 69 +-
.../AggregateProject1TestMavenProjectStub.java | 140 +-
.../AggregateProject2TestMavenProjectStub.java | 140 +-
...egateResourcesProject1TestMavenProjectStub.java | 65 +-
...egateResourcesProject2TestMavenProjectStub.java | 65 +-
.../AggregateResourcesTestMavenProjectStub.java | 69 +-
.../stubs/AggregateTestMavenProjectStub.java | 186 +-
.../stubs/CustomConfigurationMavenProjectStub.java | 204 +-
.../javadoc/stubs/DefaultArtifactHandlerStub.java | 98 +-
.../DefaultConfigurationMavenProjectStub.java | 159 +-
.../stubs/DocfilesTestMavenProjectStub.java | 161 +-
.../DocfilesWithJavaTestMavenProjectStub.java | 115 +-
.../stubs/DocletPathTestMavenProjectStub.java | 159 +-
.../javadoc/stubs/DocletTestMavenProjectStub.java | 161 +-
.../plugins/javadoc/stubs/FixMavenProjectStub.java | 198 +-
.../stubs/HeaderFooterTestMavenProjectStub.java | 120 +-
.../javadoc/stubs/HelpFileMavenProjectStub.java | 160 +-
.../stubs/JavadocJarArchiveConfigProjectStub.java | 73 +-
.../stubs/JavadocJarDefaultMavenProjectStub.java | 173 +-
.../JavadocJarFailOnErrorMavenProjectStub.java | 69 +-
.../JavadocJarInvalidDestdirMavenProjectStub.java | 170 +-
.../javadoc/stubs/JavadocPluginArtifactStub.java | 290 +-
.../javadoc/stubs/Jdk5TestMavenProjectStub.java | 159 +-
.../javadoc/stubs/Jdk6TestMavenProjectStub.java | 159 +-
.../javadoc/stubs/NewlineTestMavenProjectStub.java | 120 +-
.../OptionsUmlautEncodingMavenProjectStub.java | 65 +-
.../plugins/javadoc/stubs/PomMavenProjectStub.java | 135 +-
.../javadoc/stubs/ProxyTestMavenProjectStub.java | 175 +-
.../javadoc/stubs/QuotedPathMavenProjectStub.java | 159 +-
.../stubs/ResourcesTestMavenProjectStub.java | 120 +-
.../ResourcesWithExcludesTestMavenProjectStub.java | 120 +-
.../maven/plugins/javadoc/stubs/SettingsStub.java | 105 +-
...dDocletConflictOptionsTestMavenProjectStub.java | 120 +-
.../stubs/StylesheetFileMavenProjectStub.java | 160 +-
.../stubs/SubpackagesTestMavenProjectStub.java | 159 +-
.../javadoc/stubs/TagTestMavenProjectStub.java | 120 +-
.../stubs/TagletArtifactsMavenProjectStub.java | 154 +-
.../javadoc/stubs/TagletTestMavenProjectStub.java | 159 +-
.../javadoc/stubs/TestJavadocMavenProjectStub.java | 187 +-
.../WrongEncodingOptionsTestMavenProjectStub.java | 120 +-
.../tagletArtifacts-test-plugin-config.xml | 5 -
.../wrong-locale-test-plugin-config.xml | 52 -
115 files changed, 15543 insertions(+), 18695 deletions(-)
copy src/it/projects/MJAVADOC-180/invoker.properties => .github/release-drafter.yml (84%)
copy .github/{dependabot.yml => workflows/release-drafter.yml} (77%)
copy src/it/projects/{MJAVADOC-427 => reproducible}/invoker.properties (68%)
copy src/it/projects/{MJAVADOC-619_copyright-year => reproducible}/pom.xml (94%)
copy src/it/projects/{MJAVADOC-672_multiline-tag => reproducible}/src/main/java/foo/Bar.java (97%)
create mode 100644 src/it/projects/reproducible/verify.groovy
delete mode 100644 src/main/resources/org/apache/maven/plugins/javadoc/css/stylesheet.css
delete mode 100644 src/test/resources/unit/validate-options-test/wrong-locale-test-plugin-config.xml
[maven-javadoc-plugin] 01/01: Prepare for Doxia 2.0.0
Posted by mi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch doxia-2.0.0
in repository https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git
commit 37ba82e29fdefa416103ed50936b0a66527f611d
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Sun Apr 30 11:25:56 2023 +0200
Prepare for Doxia 2.0.0
---
pom.xml | 21 +++---
.../maven/plugins/javadoc/AbstractJavadocMojo.java | 83 +++++-----------------
.../apache/maven/plugins/javadoc/JavadocJar.java | 4 +-
.../maven/plugins/javadoc/JavadocReport.java | 16 ++---
.../javadoc/AggregatorJavadocReportTest.java | 8 ++-
.../maven/plugins/javadoc/JavadocJarTest.java | 7 +-
.../maven/plugins/javadoc/JavadocReportTest.java | 20 +++---
.../plugins/javadoc/TestJavadocReportTest.java | 7 +-
.../wrong-locale-test-plugin-config.xml | 52 --------------
9 files changed, 65 insertions(+), 153 deletions(-)
diff --git a/pom.xml b/pom.xml
index e1110c1c..2970ea0a 100644
--- a/pom.xml
+++ b/pom.xml
@@ -112,16 +112,15 @@ under the License.
<properties>
<javaVersion>8</javaVersion>
<mavenVersion>3.2.5</mavenVersion>
- <doxiaVersion>1.11.1</doxiaVersion>
- <doxia-sitetoolsVersion>1.11.1</doxia-sitetoolsVersion>
+ <doxiaSitetoolsVersion>2.0.0-M10</doxiaSitetoolsVersion>
<wagonVersion>2.4</wagonVersion>
<aetherVersion>1.0.0.v20140518</aetherVersion>
<!-- https://cwiki.apache.org/confluence/x/VIHOCg#MavenEcosystemCleanup-ResolverandMaven -->
<plexus-java.version>1.1.2</plexus-java.version>
<jetty.version>9.4.50.v20221201</jetty.version>
<!-- for ITs -->
- <sitePluginVersion>3.12.1</sitePluginVersion>
- <projectInfoReportsPluginVersion>3.4.2</projectInfoReportsPluginVersion>
+ <sitePluginVersion>4.0.0-M8</sitePluginVersion>
+ <projectInfoReportsPluginVersion>4.0.0-M1-SNAPSHOT</projectInfoReportsPluginVersion>
<project.build.outputTimestamp>2023-02-12T17:50:15Z</project.build.outputTimestamp>
<slf4jVersion>1.7.36</slf4jVersion>
</properties>
@@ -209,7 +208,7 @@ under the License.
<dependency>
<groupId>org.apache.maven.reporting</groupId>
<artifactId>maven-reporting-api</artifactId>
- <version>3.1.1</version>
+ <version>4.0.0-M6</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
@@ -231,14 +230,20 @@ under the License.
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-sink-api</artifactId>
- <version>${doxiaVersion}</version>
+ <version>2.0.0-M6</version>
</dependency>
<!-- Doxia-sitetools -->
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-site-renderer</artifactId>
- <version>${doxia-sitetoolsVersion}</version>
+ <version>${doxiaSitetoolsVersion}</version>
+ </dependency>
+ <!-- Doxia-sitetools -->
+ <dependency>
+ <groupId>org.apache.maven.doxia</groupId>
+ <artifactId>doxia-integration-tools</artifactId>
+ <version>${doxiaSitetoolsVersion}</version>
</dependency>
<!-- wagon -->
@@ -285,7 +290,7 @@ under the License.
<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-utils</artifactId>
- <version>3.5.0</version>
+ <version>3.5.1</version>
</dependency>
<dependency>
<groupId>commons-io</groupId>
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 e9f38d54..ed5adeff 100644
--- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
+++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java
@@ -66,6 +66,7 @@ import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.artifact.versioning.ArtifactVersion;
import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
+import org.apache.maven.doxia.tools.SiteTool;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.Dependency;
import org.apache.maven.model.Plugin;
@@ -271,6 +272,12 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
// Mojo components
// ----------------------------------------------------------------------
+ /**
+ * SiteTool.
+ */
+ @Component
+ protected SiteTool siteTool;
+
/**
* Archiver manager
*
@@ -330,8 +337,8 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
@Parameter(defaultValue = "${project}", readonly = true, required = true)
protected MavenProject project;
- @Parameter(defaultValue = "${mojoExecution}", readonly = true)
- private MojoExecution mojo;
+ @Parameter(defaultValue = "${mojoExecution}", readonly = true, required = true)
+ protected MojoExecution mojoExecution;
/**
* Specify if the Javadoc should operate in offline mode.
@@ -423,10 +430,10 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
private ArtifactRepository localRepository;
/**
- * The projects in the reactor for aggregation report.
+ * The reactor projects.
*/
- @Parameter(property = "reactorProjects", readonly = true)
- private List<MavenProject> reactorProjects;
+ @Parameter(defaultValue = "${reactorProjects}", required = true, readonly = true)
+ protected List<MavenProject> reactorProjects;
/**
* Set this to <code>true</code> to debug the Javadoc plugin. With this, <code>javadoc.bat(or.sh)</code>,
@@ -1821,7 +1828,7 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
abstract void doExecute() throws MojoExecutionException, MojoFailureException;
protected final void verifyRemovedParameter(String paramName) {
- Xpp3Dom configDom = mojo.getConfiguration();
+ Xpp3Dom configDom = mojoExecution.getConfiguration();
if (configDom != null) {
if (configDom.getChild(paramName) != null) {
throw new IllegalArgumentException(
@@ -1831,7 +1838,7 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
}
private void verifyReplacedParameter(String oldParamName, String newParamNew) {
- Xpp3Dom configDom = mojo.getConfiguration();
+ Xpp3Dom configDom = mojoExecution.getConfiguration();
if (configDom != null) {
if (configDom.getChild(oldParamName) != null) {
throw new IllegalArgumentException("parameter '" + oldParamName + "' has been replaced with "
@@ -4239,63 +4246,7 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
// locale
if (StringUtils.isNotEmpty(this.locale)) {
- StringTokenizer tokenizer = new StringTokenizer(this.locale, "_");
- final int maxTokens = 3;
- if (tokenizer.countTokens() > maxTokens) {
- throw new MavenReportException(
- "Unsupported option <locale/> '" + this.locale + "', should be language_country_variant.");
- }
-
- Locale localeObject = null;
- if (tokenizer.hasMoreTokens()) {
- String language = tokenizer.nextToken().toLowerCase(Locale.ENGLISH);
- if (!Arrays.asList(Locale.getISOLanguages()).contains(language)) {
- throw new MavenReportException(
- "Unsupported language '" + language + "' in option <locale/> '" + this.locale + "'");
- }
- localeObject = new Locale(language);
-
- if (tokenizer.hasMoreTokens()) {
- String country = tokenizer.nextToken().toUpperCase(Locale.ENGLISH);
- if (!Arrays.asList(Locale.getISOCountries()).contains(country)) {
- throw new MavenReportException(
- "Unsupported country '" + country + "' in option <locale/> '" + this.locale + "'");
- }
- localeObject = new Locale(language, country);
-
- if (tokenizer.hasMoreTokens()) {
- String variant = tokenizer.nextToken();
- localeObject = new Locale(language, country, variant);
- }
- }
- }
-
- if (localeObject == null) {
- throw new MavenReportException(
- "Unsupported option <locale/> '" + this.locale + "', should be language_country_variant.");
- }
-
- this.locale = localeObject.toString();
- final List<Locale> availableLocalesList = Arrays.asList(Locale.getAvailableLocales());
- if (StringUtils.isNotEmpty(localeObject.getVariant()) && !availableLocalesList.contains(localeObject)) {
- StringBuilder sb = new StringBuilder();
- sb.append("Unsupported option <locale/> with variant '").append(this.locale);
- sb.append("'");
-
- localeObject = new Locale(localeObject.getLanguage(), localeObject.getCountry());
- this.locale = localeObject.toString();
-
- sb.append(", trying to use <locale/> without variant, i.e. '")
- .append(this.locale)
- .append("'");
- if (getLog().isWarnEnabled()) {
- getLog().warn(sb.toString());
- }
- }
-
- if (!availableLocalesList.contains(localeObject)) {
- throw new MavenReportException("Unsupported option <locale/> '" + this.locale + "'");
- }
+ this.locale = siteTool.getSiteLocales(locale).get(0).toString();
}
}
@@ -6009,6 +5960,10 @@ public abstract class AbstractJavadocMojo extends AbstractMojo {
}
}
+ protected List<MavenProject> getReactorProjects() {
+ return reactorProjects;
+ }
+
/**
* @param prefix The prefix of the exception.
* @param e The exception.
diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocJar.java b/src/main/java/org/apache/maven/plugins/javadoc/JavadocJar.java
index e295edd2..98bed568 100644
--- a/src/main/java/org/apache/maven/plugins/javadoc/JavadocJar.java
+++ b/src/main/java/org/apache/maven/plugins/javadoc/JavadocJar.java
@@ -21,12 +21,12 @@ package org.apache.maven.plugins.javadoc;
import java.io.File;
import java.io.IOException;
import java.util.List;
-import java.util.Locale;
import org.apache.maven.archiver.MavenArchiveConfiguration;
import org.apache.maven.archiver.MavenArchiver;
import org.apache.maven.artifact.DependencyResolutionRequiredException;
import org.apache.maven.artifact.handler.ArtifactHandler;
+import org.apache.maven.doxia.tools.SiteTool;
import org.apache.maven.model.Resource;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Component;
@@ -178,7 +178,7 @@ public class JavadocJar extends AbstractJavadocMojo {
}
try {
- executeReport(Locale.getDefault());
+ executeReport(SiteTool.DEFAULT_LOCALE);
} catch (MavenReportException e) {
failOnError("MavenReportException: Error while generating Javadoc", e);
} catch (RuntimeException e) {
diff --git a/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java b/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java
index 14e138ec..417ffea8 100644
--- a/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java
+++ b/src/main/java/org/apache/maven/plugins/javadoc/JavadocReport.java
@@ -28,8 +28,9 @@ import java.util.stream.Collectors;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkFactory;
-import org.apache.maven.doxia.siterenderer.RenderingContext;
+import org.apache.maven.doxia.siterenderer.DocumentRenderingContext;
import org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
+import org.apache.maven.doxia.tools.SiteTool;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Execute;
@@ -118,11 +119,6 @@ public class JavadocReport extends AbstractJavadocMojo implements MavenMultiPage
}
/** {@inheritDoc} */
- @Override
- public void generate(org.codehaus.doxia.sink.Sink sink, Locale locale) throws MavenReportException {
- generate(sink, null, locale);
- }
-
public void generate(Sink sink, Locale locale) throws MavenReportException {
generate(sink, null, locale);
}
@@ -299,16 +295,16 @@ public class JavadocReport extends AbstractJavadocMojo implements MavenMultiPage
String filename = getOutputName() + ".html";
- Locale locale = Locale.getDefault();
+ Locale locale = SiteTool.DEFAULT_LOCALE;
try {
- // TODO Replace null with real value
- RenderingContext docRenderingContext = new RenderingContext(outputDirectory, filename, null);
+ String reportMojoInfo = mojoExecution.getPlugin().getId() + ":" + mojoExecution.getGoal();
+ DocumentRenderingContext docRenderingContext =
+ new DocumentRenderingContext(outputDirectory, filename, reportMojoInfo);
SiteRendererSink sink = new SiteRendererSink(docRenderingContext);
generate(sink, null, locale);
-
} catch (MavenReportException | RuntimeException e) {
failOnError("An error has occurred in " + getName(Locale.ENGLISH) + " report generation", e);
}
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 9097ab9e..36bd7d89 100644
--- a/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java
+++ b/src/test/java/org/apache/maven/plugins/javadoc/AggregatorJavadocReportTest.java
@@ -62,8 +62,12 @@ public class AggregatorJavadocReportTest extends AbstractMojoTestCase {
private JavadocReport lookupMojo(File testPom) throws Exception {
JavadocReport mojo = (JavadocReport) lookupMojo("aggregate", testPom);
- MojoExecution mojoExec = new MojoExecution(new Plugin(), "aggregate", null);
- setVariableValueToObject(mojo, "mojo", mojoExec);
+ Plugin p = new Plugin();
+ p.setGroupId("org.apache.maven.plugins");
+ p.setArtifactId("maven-javadoc-plugin");
+ MojoExecution mojoExecution = new MojoExecution(p, "aggregate", null);
+
+ setVariableValueToObject(mojo, "mojoExecution", mojoExecution);
MavenProject currentProject = new MavenProjectStub();
currentProject.setGroupId("GROUPID");
diff --git a/src/test/java/org/apache/maven/plugins/javadoc/JavadocJarTest.java b/src/test/java/org/apache/maven/plugins/javadoc/JavadocJarTest.java
index c36668f7..66ffc989 100644
--- a/src/test/java/org/apache/maven/plugins/javadoc/JavadocJarTest.java
+++ b/src/test/java/org/apache/maven/plugins/javadoc/JavadocJarTest.java
@@ -42,9 +42,12 @@ public class JavadocJarTest extends AbstractMojoTestCase {
private JavadocJar lookupMojo(File testPom) throws Exception {
JavadocJar mojo = (JavadocJar) lookupMojo("jar", testPom);
- MojoExecution mojoExec = new MojoExecution(new Plugin(), "javadoc", null);
+ Plugin p = new Plugin();
+ p.setGroupId("org.apache.maven.plugins");
+ p.setArtifactId("maven-javadoc-plugin");
+ MojoExecution mojoExecution = new MojoExecution(p, "jar", null);
- setVariableValueToObject(mojo, "mojo", mojoExec);
+ setVariableValueToObject(mojo, "mojoExecution", mojoExecution);
MavenProject currentProject = new MavenProjectStub();
currentProject.setGroupId("GROUPID");
diff --git a/src/test/java/org/apache/maven/plugins/javadoc/JavadocReportTest.java b/src/test/java/org/apache/maven/plugins/javadoc/JavadocReportTest.java
index d8c836b8..e61f747e 100644
--- a/src/test/java/org/apache/maven/plugins/javadoc/JavadocReportTest.java
+++ b/src/test/java/org/apache/maven/plugins/javadoc/JavadocReportTest.java
@@ -26,6 +26,7 @@ import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
+import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
@@ -101,17 +102,23 @@ public class JavadocReportTest extends AbstractMojoTestCase {
private JavadocReport lookupMojo(Path testPom) throws Exception {
JavadocReport mojo = (JavadocReport) lookupMojo("javadoc", testPom.toFile());
- MojoExecution mojoExec = new MojoExecution(new Plugin(), "javadoc", null);
+ Plugin p = new Plugin();
+ p.setGroupId("org.apache.maven.plugins");
+ p.setArtifactId("maven-javadoc-plugin");
+ MojoExecution mojoExecution = new MojoExecution(p, "javadoc", null);
- setVariableValueToObject(mojo, "mojo", mojoExec);
+ setVariableValueToObject(mojo, "mojoExecution", mojoExecution);
MavenProject currentProject = new MavenProjectStub();
currentProject.setGroupId("GROUPID");
currentProject.setArtifactId("ARTIFACTID");
+ List<MavenProject> reactorProjects =
+ mojo.getReactorProjects() != null ? mojo.getReactorProjects() : Collections.emptyList();
MavenSession session = newMavenSession(currentProject);
setVariableValueToObject(mojo, "session", session);
setVariableValueToObject(mojo, "repoSession", session.getRepositorySession());
+ setVariableValueToObject(mojo, "reactorProjects", reactorProjects);
return mojo;
}
@@ -1064,15 +1071,6 @@ public class JavadocReportTest extends AbstractMojoTestCase {
assertTrue("No wrong charset catch", e.getMessage().contains("Unsupported option <charset/>"));
}
- // locale
- testPom = unit.resolve("validate-options-test/wrong-locale-test-plugin-config.xml");
- mojo = lookupMojo(testPom);
- try {
- mojo.execute();
- fail("No wrong locale catch");
- } catch (MojoExecutionException e) {
- assertTrue("No wrong locale catch", e.getMessage().contains("Unsupported option <locale/>"));
- }
testPom = unit.resolve("validate-options-test/wrong-locale-with-variant-test-plugin-config.xml");
mojo = lookupMojo(testPom);
mojo.execute();
diff --git a/src/test/java/org/apache/maven/plugins/javadoc/TestJavadocReportTest.java b/src/test/java/org/apache/maven/plugins/javadoc/TestJavadocReportTest.java
index ad2cfa66..3f8d02a6 100644
--- a/src/test/java/org/apache/maven/plugins/javadoc/TestJavadocReportTest.java
+++ b/src/test/java/org/apache/maven/plugins/javadoc/TestJavadocReportTest.java
@@ -43,9 +43,12 @@ public class TestJavadocReportTest extends AbstractMojoTestCase {
new File(getBasedir(), "src/test/resources/unit/test-javadoc-test/test-javadoc-test-plugin-config.xml");
TestJavadocReport mojo = (TestJavadocReport) lookupMojo("test-javadoc", testPom);
- MojoExecution mojoExec = new MojoExecution(new Plugin(), "test-javadoc", null);
+ Plugin p = new Plugin();
+ p.setGroupId("org.apache.maven.plugins");
+ p.setArtifactId("maven-javadoc-plugin");
+ MojoExecution mojoExecution = new MojoExecution(p, "test-javadoc", null);
- setVariableValueToObject(mojo, "mojo", mojoExec);
+ setVariableValueToObject(mojo, "mojoExecution", mojoExecution);
MavenProject currentProject = new MavenProjectStub();
currentProject.setGroupId("GROUPID");
diff --git a/src/test/resources/unit/validate-options-test/wrong-locale-test-plugin-config.xml b/src/test/resources/unit/validate-options-test/wrong-locale-test-plugin-config.xml
deleted file mode 100644
index d94e0c8a..00000000
--- a/src/test/resources/unit/validate-options-test/wrong-locale-test-plugin-config.xml
+++ /dev/null
@@ -1,52 +0,0 @@
-<!--
-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>
- <groupId>org.apache.maven.plugins.maven-javadoc-plugin.unit</groupId>
- <artifactId>wrong-locale-options-test</artifactId>
- <packaging>jar</packaging>
- <version>1.0-SNAPSHOT</version>
- <inceptionYear>2007</inceptionYear>
- <name>Maven Javadoc Plugin wrong locale Test</name>
- <url>http://maven.apache.org</url>
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <project implementation="org.apache.maven.plugins.javadoc.stubs.WrongEncodingOptionsTestMavenProjectStub"/>
- <localRepository>${localRepository}</localRepository>
- <outputDirectory>${basedir}/target/test/unit/validate-options-test/target/site/apidocs</outputDirectory>
- <javadocOptionsDir>${basedir}/target/test/unit/validate-options-test/target/javadoc-bundle-options</javadocOptionsDir>
- <show>protected</show>
- <groups/>
- <tags/>
- <quiet>true</quiet>
- <debug>true</debug>
- <locale>wrong_wrong_wrong_wrong</locale>
- <stylesheet>java</stylesheet>
- <failOnError>true</failOnError>
- </configuration>
- </plugin>
- </plugins>
- </build>
-</project>