This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven.git
The following commit(s) were added to refs/heads/master by this push:
new fbdf109b3 [MNG-7571] add Maven API javadoc (#830)
fbdf109b3 is described below
commit fbdf109b34947c5cc64b8d584d0c3010351e613b
Author: Hervé Boutemy <hbout...@apache.org>
AuthorDate: Sat Dec 31 17:32:07 2022 +0100
[MNG-7571] add Maven API javadoc (#830)
---
api/maven-api-core/pom.xml | 3 +-
.../maven-api-core}/src/site/site.xml | 2 +-
api/maven-api-meta/pom.xml | 3 +-
.../maven-api-meta}/src/site/site.xml | 2 +-
api/maven-api-model/pom.xml | 4 +-
.../org/apache/maven/api/model/package-info.java | 2 +-
api/maven-api-model/src/main/mdo/common.vm | 2 +-
.../maven-api-model}/src/site/apt/index.apt | 14 +++---
.../maven-api-model}/src/site/site.xml | 2 +-
api/maven-api-settings/pom.xml | 4 +-
api/maven-api-settings/src/site/apt/index.apt | 11 +++--
api/maven-api-settings/src/site/site.xml | 2 +-
api/maven-api-toolchain/pom.xml | 4 +-
.../maven-api-toolchain}/src/site/apt/index.apt | 11 +++--
.../maven-api-toolchain}/src/site/site.xml | 2 +-
api/maven-api-xml/pom.xml | 3 +-
.../maven-api-xml}/src/site/site.xml | 2 +-
.../modello-plugin-velocity}/src/site/site.xml | 2 +-
api/pom.xml | 52 +++++++++++++++++++++-
{maven-artifact => api}/src/site/site.xml | 2 +-
maven-artifact/src/site/site.xml | 2 +-
maven-bom/src/site/site.xml | 2 +-
maven-builder-support/src/site/site.xml | 2 +-
maven-compat/src/site/site.xml | 2 +-
maven-core/src/site/site.xml | 2 +-
maven-embedder/src/site/site.xml | 2 +-
maven-model-builder/src/site/site.xml | 2 +-
maven-model-transform/src/site/site.xml | 2 +-
maven-model/src/site/apt/index.apt | 6 ++-
maven-model/src/site/site.xml | 2 +-
maven-plugin-api/src/site/site.xml | 2 +-
maven-repository-metadata/src/site/site.xml | 2 +-
maven-resolver-provider/src/site/site.xml | 2 +-
maven-settings-builder/src/site/site.xml | 2 +-
maven-settings/src/site/apt/index.apt | 7 ++-
maven-settings/src/site/site.xml | 2 +-
maven-slf4j-provider/src/site/site.xml | 2 +-
maven-slf4j-wrapper/src/site/site.xml | 2 +-
.../src/site/site.xml | 2 +-
.../src/site/site.xml | 2 +-
maven-xml-impl/README.md | 1 -
maven-xml-impl/pom.xml | 4 +-
plexus-utils/README.md | 6 +--
plexus-utils/pom.xml | 4 +-
src/site/site.xml | 2 +-
45 files changed, 126 insertions(+), 69 deletions(-)
diff --git a/api/maven-api-core/pom.xml b/api/maven-api-core/pom.xml
index 8920507f5..1ba9fb04b 100644
--- a/api/maven-api-core/pom.xml
+++ b/api/maven-api-core/pom.xml
@@ -27,7 +27,8 @@
</parent>
<artifactId>maven-api-core</artifactId>
- <name>Apache Maven Core API</name>
+ <name>Maven 4 API :: Core</name>
+ <description>Maven 4 API - Maven Core APIs.</description>
<dependencies>
<dependency>
diff --git a/maven-artifact/src/site/site.xml
b/api/maven-api-core/src/site/site.xml
similarity index 95%
copy from maven-artifact/src/site/site.xml
copy to api/maven-api-core/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-artifact/src/site/site.xml
+++ b/api/maven-api-core/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/api/maven-api-meta/pom.xml b/api/maven-api-meta/pom.xml
index 65d31dc6b..54b602fd3 100644
--- a/api/maven-api-meta/pom.xml
+++ b/api/maven-api-meta/pom.xml
@@ -27,6 +27,7 @@
</parent>
<artifactId>maven-api-meta</artifactId>
- <name>Maven API Meta annotations</name>
+ <name>Maven 4 API Meta annotations</name>
+ <description>Java annotations for Maven 4 Immutable API.</description>
</project>
diff --git a/maven-artifact/src/site/site.xml
b/api/maven-api-meta/src/site/site.xml
similarity index 95%
copy from maven-artifact/src/site/site.xml
copy to api/maven-api-meta/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-artifact/src/site/site.xml
+++ b/api/maven-api-meta/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/api/maven-api-model/pom.xml b/api/maven-api-model/pom.xml
index 34add9629..e141aac08 100644
--- a/api/maven-api-model/pom.xml
+++ b/api/maven-api-model/pom.xml
@@ -28,8 +28,8 @@ under the License.
<artifactId>maven-api-model</artifactId>
- <name>Maven API Model</name>
- <description>Maven API Model for Maven POM (Project Object
Model)</description>
+ <name>Maven 4 API :: Model</name>
+ <description>Maven 4 API - Immutable Model for Maven POM (Project Object
Model)</description>
<dependencies>
<dependency>
diff --git
a/api/maven-api-model/src/main/java/org/apache/maven/api/model/package-info.java
b/api/maven-api-model/src/main/java/org/apache/maven/api/model/package-info.java
index 854562874..3c1c61e21 100644
---
a/api/maven-api-model/src/main/java/org/apache/maven/api/model/package-info.java
+++
b/api/maven-api-model/src/main/java/org/apache/maven/api/model/package-info.java
@@ -1,6 +1,6 @@
// CHECKSTYLE_OFF: RegexpHeader
/**
- * Maven POM (Project Object Model) classes, generated from
<code>maven.mdo</code> model.
+ * Maven Immutable POM (Project Object Model) classes, generated from
<code>maven.mdo</code> model.
* The root class is {@link org.apache.maven.api.model.Model}.
*/
package org.apache.maven.api.model;
diff --git a/api/maven-api-model/src/main/mdo/common.vm
b/api/maven-api-model/src/main/mdo/common.vm
index 3c3f29cf7..e300b2289 100644
--- a/api/maven-api-model/src/main/mdo/common.vm
+++ b/api/maven-api-model/src/main/mdo/common.vm
@@ -20,7 +20,7 @@
##
## The following loop code is required in order to change the type of the
## pomFile attribute to a java.nio.file.Path. Modello does not support this
-## type and loading a model with such a type would fail the modello validation.
+## type and loading a model with such a type would fail the Modello validation.
##
#foreach ( $field in $model.getClass("Model", $version).allFields )
#if ( $field.name == "pomFile" )
diff --git a/maven-settings/src/site/apt/index.apt
b/api/maven-api-model/src/site/apt/index.apt
similarity index 67%
copy from maven-settings/src/site/apt/index.apt
copy to api/maven-api-model/src/site/apt/index.apt
index 2b42ccd16..e64b4fb21 100644
--- a/maven-settings/src/site/apt/index.apt
+++ b/api/maven-api-model/src/site/apt/index.apt
@@ -18,19 +18,19 @@
-----
Introduction
-----
+ Jason van Zyl
Vincent Siveton
+ Hervé Boutemy
-----
- 2006-11-04
+ 2011-06-12
-----
-Maven Settings Model
+Maven 4 API - Immutable Maven Model
- This is strictly the model for Maven settings.
+ This is strictly the immutable model for Maven POM (Project Object Model), so
really just plain objects in <<<org.apache.maven.api.model>>> package.
The following are generated from this model:
- * {{{./apidocs/index.html}Java sources}} with Reader and Writers for the
Xpp3 XML parser
+ * {{{./apidocs/index.html}Java sources}} with <<<Builder>>> inner classes
for immutable instances creation.
- * A {{{./settings.html}Descriptor Reference}}
-
- * An {{{https://maven.apache.org/xsd/settings-1.2.0.xsd}XSD}}
+ See also corresponding {{{../../maven-model/index.html}Maven classical POM
model documentation}}.
diff --git a/maven-artifact/src/site/site.xml
b/api/maven-api-model/src/site/site.xml
similarity index 95%
copy from maven-artifact/src/site/site.xml
copy to api/maven-api-model/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-artifact/src/site/site.xml
+++ b/api/maven-api-model/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/api/maven-api-settings/pom.xml b/api/maven-api-settings/pom.xml
index 5f1b0f02e..843274f0e 100644
--- a/api/maven-api-settings/pom.xml
+++ b/api/maven-api-settings/pom.xml
@@ -28,8 +28,8 @@ under the License.
<artifactId>maven-api-settings</artifactId>
- <name>Maven API Settings</name>
- <description>Maven API Settings model.</description>
+ <name>Maven 4 API :: Settings</name>
+ <description>Maven 4 API - Immutable Settings model</description>
<dependencies>
<dependency>
diff --git a/api/maven-api-settings/src/site/apt/index.apt
b/api/maven-api-settings/src/site/apt/index.apt
index 2b42ccd16..ca71c0d7f 100644
--- a/api/maven-api-settings/src/site/apt/index.apt
+++ b/api/maven-api-settings/src/site/apt/index.apt
@@ -23,14 +23,13 @@
2006-11-04
-----
-Maven Settings Model
+Maven 4 API - Immutable Settings Model
- This is strictly the model for Maven settings.
+ This is strictly the immutable model for Maven settings in
<<<org.apache.maven.api.settings>>> package.
The following are generated from this model:
- * {{{./apidocs/index.html}Java sources}} with Reader and Writers for the
Xpp3 XML parser
+ * {{{./apidocs/index.html}Java sources}} with <<<Builder>>> inner classes
for immutable instances creation.
- * A {{{./settings.html}Descriptor Reference}}
-
- * An {{{https://maven.apache.org/xsd/settings-1.2.0.xsd}XSD}}
+ See also corresponding {{{../../maven-settings/index.html}Maven classical
settings model documentation}}.
+
\ No newline at end of file
diff --git a/api/maven-api-settings/src/site/site.xml
b/api/maven-api-settings/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/api/maven-api-settings/src/site/site.xml
+++ b/api/maven-api-settings/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/api/maven-api-toolchain/pom.xml b/api/maven-api-toolchain/pom.xml
index bb0cb54b3..20024cb8a 100644
--- a/api/maven-api-toolchain/pom.xml
+++ b/api/maven-api-toolchain/pom.xml
@@ -27,8 +27,8 @@ under the License.
<artifactId>maven-api-toolchain</artifactId>
- <name>Maven API Toolchain</name>
- <description>Maven API Toolchain model.</description>
+ <name>Maven 4 API :: Toolchain</name>
+ <description>Maven 4 API - Immutable Toolchain model.</description>
<dependencies>
<dependency>
diff --git a/maven-settings/src/site/apt/index.apt
b/api/maven-api-toolchain/src/site/apt/index.apt
similarity index 70%
copy from maven-settings/src/site/apt/index.apt
copy to api/maven-api-toolchain/src/site/apt/index.apt
index 2b42ccd16..689b04433 100644
--- a/maven-settings/src/site/apt/index.apt
+++ b/api/maven-api-toolchain/src/site/apt/index.apt
@@ -23,14 +23,13 @@
2006-11-04
-----
-Maven Settings Model
+Maven 4 API - Immutable Toolchains Model
- This is strictly the model for Maven settings.
+ This is strictly the immutable model for Maven toolchains in
<<<org.apache.maven.api.toolchain>>> package.
The following are generated from this model:
- * {{{./apidocs/index.html}Java sources}} with Reader and Writers for the
Xpp3 XML parser
+ * {{{./apidocs/index.html}Java sources}} with <<<Builder>>> inner classes
for immutable instances creation.
- * A {{{./settings.html}Descriptor Reference}}
-
- * An {{{https://maven.apache.org/xsd/settings-1.2.0.xsd}XSD}}
+ See also corresponding {{{../../maven-toolchain-model/index.html}Maven
classical toolchains model documentation}}.
+
\ No newline at end of file
diff --git a/maven-artifact/src/site/site.xml
b/api/maven-api-toolchain/src/site/site.xml
similarity index 95%
copy from maven-artifact/src/site/site.xml
copy to api/maven-api-toolchain/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-artifact/src/site/site.xml
+++ b/api/maven-api-toolchain/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/api/maven-api-xml/pom.xml b/api/maven-api-xml/pom.xml
index 3a8d0e6ad..0b0adb0d3 100644
--- a/api/maven-api-xml/pom.xml
+++ b/api/maven-api-xml/pom.xml
@@ -27,7 +27,8 @@
</parent>
<artifactId>maven-api-xml</artifactId>
- <name>Maven API XML</name>
+ <name>Maven 4 API XML</name>
+ <description>Maven 4 API immutable XML helper.</description>
<dependencies>
<dependency>
diff --git a/maven-artifact/src/site/site.xml
b/api/maven-api-xml/src/site/site.xml
similarity index 95%
copy from maven-artifact/src/site/site.xml
copy to api/maven-api-xml/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-artifact/src/site/site.xml
+++ b/api/maven-api-xml/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-artifact/src/site/site.xml
b/api/modello-plugin-velocity/src/site/site.xml
similarity index 95%
copy from maven-artifact/src/site/site.xml
copy to api/modello-plugin-velocity/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-artifact/src/site/site.xml
+++ b/api/modello-plugin-velocity/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/api/pom.xml b/api/pom.xml
index 3de8ccbc9..d425fee16 100644
--- a/api/pom.xml
+++ b/api/pom.xml
@@ -28,7 +28,8 @@
<artifactId>maven-api</artifactId>
<packaging>pom</packaging>
- <name>Maven API</name>
+ <name>Maven 4 API</name>
+ <description>A new immutable API for Maven 4 to better manage what plugins
and extensions can influence.</description>
<modules>
<module>modello-plugin-velocity</module>
@@ -40,4 +41,53 @@
<module>maven-api-core</module>
</modules>
+ <properties>
+ <project.directory>api</project.directory>
+ </properties>
+
+ <profiles>
+ <profile>
+ <id>reporting</id>
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <tags>
+ <tag>
+ <name>provisional</name>
+ <placement>tf</placement>
+ <head>Provisional:</head>
+ </tag>
+ </tags>
+ </configuration>
+ <reportSets>
+ <reportSet>
+ <id>aggregate</id>
+ <reports>
+ <report>aggregate</report>
+ </reports>
+ <inherited>false</inherited>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jxr-plugin</artifactId>
+ <reportSets>
+ <reportSet>
+ <id>aggregate</id>
+ <reports>
+ <report>aggregate</report>
+ </reports>
+ <inherited>false</inherited>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ </plugins>
+ </reporting>
+ </profile>
+ </profiles>
+
</project>
diff --git a/maven-artifact/src/site/site.xml b/api/src/site/site.xml
similarity index 95%
copy from maven-artifact/src/site/site.xml
copy to api/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-artifact/src/site/site.xml
+++ b/api/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-artifact/src/site/site.xml b/maven-artifact/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-artifact/src/site/site.xml
+++ b/maven-artifact/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-bom/src/site/site.xml b/maven-bom/src/site/site.xml
index 7f2adda9a..e6ace5735 100644
--- a/maven-bom/src/site/site.xml
+++ b/maven-bom/src/site/site.xml
@@ -39,7 +39,7 @@ under the License.
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <!--item name="JavaDocs" href="apidocs/index.html"/>
+ <!--item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-builder-support/src/site/site.xml
b/maven-builder-support/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-builder-support/src/site/site.xml
+++ b/maven-builder-support/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-compat/src/site/site.xml b/maven-compat/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-compat/src/site/site.xml
+++ b/maven-compat/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-core/src/site/site.xml b/maven-core/src/site/site.xml
index ee0671d4c..09663df66 100644
--- a/maven-core/src/site/site.xml
+++ b/maven-core/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-embedder/src/site/site.xml b/maven-embedder/src/site/site.xml
index 908e741f8..c1bd4a7df 100644
--- a/maven-embedder/src/site/site.xml
+++ b/maven-embedder/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-model-builder/src/site/site.xml
b/maven-model-builder/src/site/site.xml
index 7aaee5a6b..61e47a68f 100644
--- a/maven-model-builder/src/site/site.xml
+++ b/maven-model-builder/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-model-transform/src/site/site.xml
b/maven-model-transform/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-model-transform/src/site/site.xml
+++ b/maven-model-transform/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-model/src/site/apt/index.apt
b/maven-model/src/site/apt/index.apt
index 0010f4fb7..f4fa80236 100644
--- a/maven-model/src/site/apt/index.apt
+++ b/maven-model/src/site/apt/index.apt
@@ -27,12 +27,14 @@
Maven Model
- This is strictly the model for Maven POM (Project Object Model), so really
just plain objects. All the effective model
+ This is strictly the model for Maven POM (Project Object Model) in
<<<org.apache.maven.model>>> package,
+ delegating content to {{{../maven-api/maven-api-model/index.html}Maven 4 API
immutable model}}. All the effective model
building logic from multiple POMs and building context is done in
{{{../maven-model-builder/}Maven Model Builder}}.
The following are generated from this model:
- * {{{./apidocs/index.html}Java sources}} with Reader and Writers for the
Xpp3 XML parser
+ * {{{./apidocs/index.html}Java sources}} with Reader and Writers for the
Xpp3 XML parser, <<<ToAPiV3()>>> and <<<ToApiV4()>>> transformers, and <<<v4>>>
package
+ for Merger and v4 Reader and Writers for the Xpp3 XML parser,
* A {{{./maven.html}Descriptor Reference}}
diff --git a/maven-model/src/site/site.xml b/maven-model/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-model/src/site/site.xml
+++ b/maven-model/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-plugin-api/src/site/site.xml
b/maven-plugin-api/src/site/site.xml
index 224f30ecf..519623c9e 100644
--- a/maven-plugin-api/src/site/site.xml
+++ b/maven-plugin-api/src/site/site.xml
@@ -27,7 +27,7 @@
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-repository-metadata/src/site/site.xml
b/maven-repository-metadata/src/site/site.xml
index c24e1433e..be08a3317 100644
--- a/maven-repository-metadata/src/site/site.xml
+++ b/maven-repository-metadata/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<!--item name="Source Xref" href="xref/index.html"/-->
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-resolver-provider/src/site/site.xml
b/maven-resolver-provider/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-resolver-provider/src/site/site.xml
+++ b/maven-resolver-provider/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-settings-builder/src/site/site.xml
b/maven-settings-builder/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-settings-builder/src/site/site.xml
+++ b/maven-settings-builder/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-settings/src/site/apt/index.apt
b/maven-settings/src/site/apt/index.apt
index 2b42ccd16..bcedeedd2 100644
--- a/maven-settings/src/site/apt/index.apt
+++ b/maven-settings/src/site/apt/index.apt
@@ -25,11 +25,14 @@
Maven Settings Model
- This is strictly the model for Maven settings.
+ This is the model for Maven settings in <<<org.apache.maven.settings>>>
package,
+ delegating content to {{{../maven-api/maven-api-settings/index.html}Maven 4
API immutable settings}}. All the effective model
+ building logic from multiple settings files is done in
{{{../maven-settings-builder/}Maven Settings Builder}}.
The following are generated from this model:
- * {{{./apidocs/index.html}Java sources}} with Reader and Writers for the
Xpp3 XML parser
+ * {{{./apidocs/index.html}Java sources}} with Reader and Writers for the
Xpp3 XML parser, <<<ToAPiV3()>>> and <<<ToApiV4()>>> transformers, and <<<v4>>>
package
+ for Merger and v4 Reader and Writers for the Xpp3 XML parser,
* A {{{./settings.html}Descriptor Reference}}
diff --git a/maven-settings/src/site/site.xml b/maven-settings/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-settings/src/site/site.xml
+++ b/maven-settings/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-slf4j-provider/src/site/site.xml
b/maven-slf4j-provider/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-slf4j-provider/src/site/site.xml
+++ b/maven-slf4j-provider/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-slf4j-wrapper/src/site/site.xml
b/maven-slf4j-wrapper/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-slf4j-wrapper/src/site/site.xml
+++ b/maven-slf4j-wrapper/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-artifact/src/site/site.xml
b/maven-toolchain-builder/src/site/site.xml
similarity index 95%
copy from maven-artifact/src/site/site.xml
copy to maven-toolchain-builder/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-artifact/src/site/site.xml
+++ b/maven-toolchain-builder/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-artifact/src/site/site.xml
b/maven-toolchain-model/src/site/site.xml
similarity index 95%
copy from maven-artifact/src/site/site.xml
copy to maven-toolchain-model/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-artifact/src/site/site.xml
+++ b/maven-toolchain-model/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-xml-impl/README.md b/maven-xml-impl/README.md
index b2a7ad544..ed9ba4254 100644
--- a/maven-xml-impl/README.md
+++ b/maven-xml-impl/README.md
@@ -20,4 +20,3 @@ Apache Maven XML Impl
This module contains the implementation of the `org.apache.maven.api.xml.Dom`
interface used to convey XML snippets in the object model, and also the
modified `org.codehaus.plexus.util.xml` package which wraps the immutable
objects from `org.apache.maven.api.xml.Dom` in order to provide compatibility
and interoperability between the API v3.x and v4.x.
See [plexus-utils](../plexus-utils/README.md) for more information.
-
diff --git a/maven-xml-impl/pom.xml b/maven-xml-impl/pom.xml
index db8b7a523..bf91fab2b 100644
--- a/maven-xml-impl/pom.xml
+++ b/maven-xml-impl/pom.xml
@@ -26,8 +26,8 @@ under the License.
</parent>
<artifactId>maven-xml-impl</artifactId>
-
- <name>Maven XML Implementation</name>
+ <name>Implementation of Maven API XML</name>
+ <description>To be merged into Maven plexus-utils</description>
<dependencies>
<dependency>
diff --git a/plexus-utils/README.md b/plexus-utils/README.md
index c23a3000a..125c34a49 100644
--- a/plexus-utils/README.md
+++ b/plexus-utils/README.md
@@ -17,10 +17,10 @@
Apache Maven Plexus Utils
=========================
-This module is a repackaging of the `org.codehaus.plexus:plexus-utils` jar,
which contains a few modified classes to allow a seamless transition between
the maven 3.x and 4.x apis.
+This module is a repackaging of the `org.codehaus.plexus:plexus-utils` jar,
which contains a few modified classes to allow a seamless transition between
the Maven 3.x and 4.x APIs.
-The maven 4.x api is based on immutable data objects. The maven model contains
a few classes that contain some open xml data (`Plugin`, `PluginExecution`,
`ReportPlugin` and `ReportSet`). So the v3 API which was using the
`org.codehaus.plexus.utils.xml.Xpp3Dom` class now wraps the
`org.apache.maven.api.Dom` node. This is completely transparent for existing
plugins, but the correct (new) classes have to be used.
+The Maven 4.x API is based on immutable data objects. The Maven model contains
a few classes that contain some open xml data for configuration (`Plugin`,
`PluginExecution`, `ReportPlugin` and `ReportSet`). So the v3 API which was
using the `org.codehaus.plexus.utils.xml.Xpp3Dom` class now wraps the
`org.apache.maven.api.Dom` interface node. This is completely transparent for
existing plugins, but the correct (new) classes have to be used.
-Given the new implementation of `org.codehaus.plexus.utils.xml.Xpp3Dom` now
relies on `org.apache.maven.api.Dom`, the modifications can't be made inside
the `plexus-utils` project, because maven itself depends on it.
+Given the new implementation of `org.codehaus.plexus.utils.xml.Xpp3Dom` now
relies on `org.apache.maven.api.Dom`, the modifications can't be made inside
the `plexus-utils` project, because Maven itself depends on it.
This is drop-in replacement for `plexus-utils` 3.4.2.
diff --git a/plexus-utils/pom.xml b/plexus-utils/pom.xml
index 6193526da..b7d9515f7 100644
--- a/plexus-utils/pom.xml
+++ b/plexus-utils/pom.xml
@@ -28,6 +28,8 @@ under the License.
<groupId>org.apache.maven</groupId>
<artifactId>plexus-utils</artifactId>
<version>4.0.0-alpha-4-SNAPSHOT</version>
+ <name>Apache Maven Plexus-Utils</name>
+ <description>Apache Maven repackaging of Plexus Utils with immutable Dom
interface and its replacement implementation.</description>
<dependencies>
<dependency>
@@ -51,7 +53,7 @@ under the License.
<version>3.1.1</version>
<executions>
<execution>
- <id>unpack-sourcs</id>
+ <id>unpack-sources</id>
<goals>
<goal>unpack</goal>
</goals>
diff --git a/src/site/site.xml b/src/site/site.xml
index 83da6d7d0..3ba52bda5 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -39,7 +39,7 @@ under the License.
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
<item name="License" href="http://www.apache.org/licenses/"/>
