You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2022/12/27 16:03:01 UTC
[maven] branch MNG-7571 updated (7028055ec -> a4b5f92fc)
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a change to branch MNG-7571
in repository https://gitbox.apache.org/repos/asf/maven.git
discard 7028055ec [MNG-7571] add Maven API javadoc
new a4b5f92fc [MNG-7571] add Maven API javadoc
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 (7028055ec)
\
N -- N -- N refs/heads/MNG-7571 (a4b5f92fc)
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:
api/pom.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
[maven] 01/01: [MNG-7571] add Maven API javadoc
Posted by hb...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch MNG-7571
in repository https://gitbox.apache.org/repos/asf/maven.git
commit a4b5f92fc708ed86f47f0cd51cf381a5c55725ce
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Mon Oct 17 08:07:17 2022 +0200
[MNG-7571] add Maven API javadoc
---
api/maven-api-core/pom.xml | 3 +-
api/maven-api-core/src/site/site.xml | 38 ++++++++++++++++++++++
api/maven-api-meta/pom.xml | 3 +-
api/maven-api-meta/src/site/site.xml | 38 ++++++++++++++++++++++
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 +-
api/maven-api-model/src/main/site/site.xml | 38 ++++++++++++++++++++++
api/maven-api-settings/pom.xml | 4 +--
api/maven-api-toolchain/pom.xml | 4 +--
api/maven-api-toolchain/src/site/site.xml | 38 ++++++++++++++++++++++
api/maven-api-xml/pom.xml | 3 +-
api/maven-api-xml/src/site/site.xml | 38 ++++++++++++++++++++++
api/modello-plugin-velocity/src/site/site.xml | 38 ++++++++++++++++++++++
api/pom.xml | 35 +++++++++++++++++++-
api/src/site/site.xml | 38 ++++++++++++++++++++++
16 files changed, 314 insertions(+), 12 deletions(-)
diff --git a/api/maven-api-core/pom.xml b/api/maven-api-core/pom.xml
index 8920507f5..3895448fb 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/api/maven-api-core/src/site/site.xml b/api/maven-api-core/src/site/site.xml
new file mode 100644
index 000000000..e475330c4
--- /dev/null
+++ b/api/maven-api-core/src/site/site.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+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/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
+
+ <edit>${project.scm.url}</edit>
+
+ <body>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Source Xref" href="xref/index.html"/>
+ <!--item name="FAQ" href="faq.html"/-->
+ </menu>
+
+ <menu ref="parent"/>
+ <menu ref="reports"/>
+ </body>
+</project>
\ No newline at end of file
diff --git a/api/maven-api-meta/pom.xml b/api/maven-api-meta/pom.xml
index 65d31dc6b..b7d3b3aef 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 5 annotations for Maven 4 Immutable API.</description>
</project>
diff --git a/api/maven-api-meta/src/site/site.xml b/api/maven-api-meta/src/site/site.xml
new file mode 100644
index 000000000..e475330c4
--- /dev/null
+++ b/api/maven-api-meta/src/site/site.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+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/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
+
+ <edit>${project.scm.url}</edit>
+
+ <body>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Source Xref" href="xref/index.html"/>
+ <!--item name="FAQ" href="faq.html"/-->
+ </menu>
+
+ <menu ref="parent"/>
+ <menu ref="reports"/>
+ </body>
+</project>
\ No newline at end of file
diff --git a/api/maven-api-model/pom.xml b/api/maven-api-model/pom.xml
index 34add9629..e50497794 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/api/maven-api-model/src/main/site/site.xml b/api/maven-api-model/src/main/site/site.xml
new file mode 100644
index 000000000..e475330c4
--- /dev/null
+++ b/api/maven-api-model/src/main/site/site.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+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/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
+
+ <edit>${project.scm.url}</edit>
+
+ <body>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Source Xref" href="xref/index.html"/>
+ <!--item name="FAQ" href="faq.html"/-->
+ </menu>
+
+ <menu ref="parent"/>
+ <menu ref="reports"/>
+ </body>
+</project>
\ No newline at end of file
diff --git a/api/maven-api-settings/pom.xml b/api/maven-api-settings/pom.xml
index 5f1b0f02e..b6111a9c0 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-toolchain/pom.xml b/api/maven-api-toolchain/pom.xml
index bb0cb54b3..1ae77aefa 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/api/maven-api-toolchain/src/site/site.xml b/api/maven-api-toolchain/src/site/site.xml
new file mode 100644
index 000000000..e475330c4
--- /dev/null
+++ b/api/maven-api-toolchain/src/site/site.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+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/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
+
+ <edit>${project.scm.url}</edit>
+
+ <body>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Source Xref" href="xref/index.html"/>
+ <!--item name="FAQ" href="faq.html"/-->
+ </menu>
+
+ <menu ref="parent"/>
+ <menu ref="reports"/>
+ </body>
+</project>
\ No newline at end of file
diff --git a/api/maven-api-xml/pom.xml b/api/maven-api-xml/pom.xml
index 3a8d0e6ad..01950a479 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/api/maven-api-xml/src/site/site.xml b/api/maven-api-xml/src/site/site.xml
new file mode 100644
index 000000000..e475330c4
--- /dev/null
+++ b/api/maven-api-xml/src/site/site.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+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/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
+
+ <edit>${project.scm.url}</edit>
+
+ <body>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Source Xref" href="xref/index.html"/>
+ <!--item name="FAQ" href="faq.html"/-->
+ </menu>
+
+ <menu ref="parent"/>
+ <menu ref="reports"/>
+ </body>
+</project>
\ No newline at end of file
diff --git a/api/modello-plugin-velocity/src/site/site.xml b/api/modello-plugin-velocity/src/site/site.xml
new file mode 100644
index 000000000..e475330c4
--- /dev/null
+++ b/api/modello-plugin-velocity/src/site/site.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+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/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
+
+ <edit>${project.scm.url}</edit>
+
+ <body>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Source Xref" href="xref/index.html"/>
+ <!--item name="FAQ" href="faq.html"/-->
+ </menu>
+
+ <menu ref="parent"/>
+ <menu ref="reports"/>
+ </body>
+</project>
\ No newline at end of file
diff --git a/api/pom.xml b/api/pom.xml
index 3de8ccbc9..43ffdb243 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,36 @@
<module>maven-api-core</module>
</modules>
+ <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>
+ </plugins>
+ </reporting>
+ </profile>
+ </profiles>
+
</project>
diff --git a/api/src/site/site.xml b/api/src/site/site.xml
new file mode 100644
index 000000000..e475330c4
--- /dev/null
+++ b/api/src/site/site.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+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/DECORATION/1.8.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 http://maven.apache.org/xsd/decoration-1.8.0.xsd">
+
+ <edit>${project.scm.url}</edit>
+
+ <body>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Source Xref" href="xref/index.html"/>
+ <!--item name="FAQ" href="faq.html"/-->
+ </menu>
+
+ <menu ref="parent"/>
+ <menu ref="reports"/>
+ </body>
+</project>
\ No newline at end of file