Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[MNG-7571] add Maven API javadoc (#830)

This commit is contained in:
Hervé Boutemy 2022-12-31 17:32:07 +01:00 committed by GitHub
parent dc9efaace6
commit fbdf109b34
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
45 changed files with 518 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api/maven-api-core/pom.xml
View File

@ -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>

38
api/maven-api-core/src/site/site.xml Normal file
View File

@ -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>

3
api/maven-api-meta/pom.xml
View File

@ -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>

38
api/maven-api-meta/src/site/site.xml Normal file
View File

@ -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>

4
api/maven-api-model/pom.xml
View File

@ -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>

2
api/maven-api-model/src/main/java/org/apache/maven/api/model/package-info.java
View File

@ -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;

2
api/maven-api-model/src/main/mdo/common.vm
View File

@ -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" )

36
api/maven-api-model/src/site/apt/index.apt Normal file
View File

@ -0,0 +1,36 @@
~~ 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.
-----
Introduction
-----
Jason van Zyl
Vincent Siveton
Hervé Boutemy
-----
2011-06-12
-----
Maven 4 API - Immutable Maven Model
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 <<<Builder>>> inner classes for immutable instances creation.
See also corresponding {{{../../maven-model/index.html}Maven classical POM model documentation}}.

38
api/maven-api-model/src/site/site.xml Normal file
View File

@ -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>

4
api/maven-api-settings/pom.xml
View File

@ -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>

9
api/maven-api-settings/src/site/apt/index.apt
View File

@ -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}}
See also corresponding {{{../../maven-settings/index.html}Maven classical settings model documentation}}.
* An {{{https://maven.apache.org/xsd/settings-1.2.0.xsd}XSD}}

2
api/maven-api-settings/src/site/site.xml
View File

@ -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>

4
api/maven-api-toolchain/pom.xml
View File

@ -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>

35
api/maven-api-toolchain/src/site/apt/index.apt Normal file
View File

@ -0,0 +1,35 @@
~~ 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.
-----
Introduction
-----
Vincent Siveton
-----
2006-11-04
-----
Maven 4 API - Immutable Toolchains Model
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 <<<Builder>>> inner classes for immutable instances creation.
See also corresponding {{{../../maven-toolchain-model/index.html}Maven classical toolchains model documentation}}.

38
api/maven-api-toolchain/src/site/site.xml Normal file
View File

@ -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>

3
api/maven-api-xml/pom.xml
View File

@ -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>

38
api/maven-api-xml/src/site/site.xml Normal file
View File

@ -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>

38
api/modello-plugin-velocity/src/site/site.xml Normal file
View File

@ -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>

52
api/pom.xml
View File

@ -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>

38
api/src/site/site.xml Normal file
View File

@ -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>

2
maven-artifact/src/site/site.xml
View File

@ -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>

2
maven-bom/src/site/site.xml
View File

@ -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>

2
maven-builder-support/src/site/site.xml
View File

@ -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>

2
maven-compat/src/site/site.xml
View File

@ -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>

2
maven-core/src/site/site.xml
View File

@ -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>

2
maven-embedder/src/site/site.xml
View File

@ -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>

2
maven-model-builder/src/site/site.xml
View File

@ -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>

2
maven-model-transform/src/site/site.xml
View File

@ -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>

6
maven-model/src/site/apt/index.apt
View File

@ -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}}

2
maven-model/src/site/site.xml
View File

@ -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>

2
maven-plugin-api/src/site/site.xml
View File

@ -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>

2
maven-repository-metadata/src/site/site.xml
View File

@ -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>

2
maven-resolver-provider/src/site/site.xml
View File

@ -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>

2
maven-settings-builder/src/site/site.xml
View File

@ -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>

7
maven-settings/src/site/apt/index.apt
View File

@ -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}}

2
maven-settings/src/site/site.xml
View File

@ -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>

2
maven-slf4j-provider/src/site/site.xml
View File

@ -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>

2
maven-slf4j-wrapper/src/site/site.xml
View File

@ -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>

38
maven-toolchain-builder/src/site/site.xml Normal file
View File

@ -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>

38
maven-toolchain-model/src/site/site.xml Normal file
View File

@ -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>

1
maven-xml-impl/README.md
View File

@ -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.

4
maven-xml-impl/pom.xml
View File

@ -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>

6
plexus-utils/README.md
View File

@ -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.

4
plexus-utils/pom.xml
View File

@ -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>

2
src/site/site.xml
View File

@ -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/"/>