Skip to content

[MNG-7571] add Maven API javadoc #830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 31, 2022
Merged

[MNG-7571] add Maven API javadoc #830

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2bb556
[MNG-7571] add Maven API javadoc
hboutemy Oct 17, 2022
917e3b8
fix review feedback
hboutemy Dec 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion api/maven-api-core/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
38 changes: 38 additions & 0 deletions api/maven-api-core/src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 changes: 2 additions & 1 deletion api/maven-api-meta/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
</parent>

<artifactId>maven-api-meta</artifactId>
<name>Maven API Meta annotations</name>
<name>Maven 4 API Meta annotations</name>
Copy link
Member

@michael-o michael-o Dec 28, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Annotations

Copy link
Member Author

@hboutemy hboutemy Dec 29, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we rename the artifactId?

Copy link
Member

@michael-o michael-o Dec 29, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, good idea: maven-api-meta-annotations?

<description>Java annotations for Maven 4 Immutable API.</description>

</project>
38 changes: 38 additions & 0 deletions api/maven-api-meta/src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 changes: 2 additions & 2 deletions api/maven-api-model/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion api/maven-api-model/src/main/java/org/apache/maven/api/model/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion api/maven-api-model/src/main/mdo/common.vm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" )
Expand Down
36 changes: 36 additions & 0 deletions api/maven-api-model/src/site/apt/index.apt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 changes: 38 additions & 0 deletions api/maven-api-model/src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 changes: 2 additions & 2 deletions api/maven-api-settings/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
11 changes: 5 additions & 6 deletions api/maven-api-settings/src/site/apt/index.apt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}}.

2 changes: 1 addition & 1 deletion api/maven-api-settings/src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions api/maven-api-toolchain/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
35 changes: 35 additions & 0 deletions api/maven-api-toolchain/src/site/apt/index.apt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 changes: 38 additions & 0 deletions api/maven-api-toolchain/src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 changes: 2 additions & 1 deletion api/maven-api-xml/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
38 changes: 38 additions & 0 deletions api/maven-api-xml/src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
Loading