You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by GitBox <gi...@apache.org> on 2022/10/17 06:15:14 UTC
[GitHub] [maven] hboutemy opened a new pull request, #830: [MNG-7571] add Maven API javadoc
hboutemy opened a new pull request, #830:
URL: https://github.com/apache/maven/pull/830
https://issues.apache.org/jira/browse/MNG-7571
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] gnodet commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
gnodet commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1059147903
##########
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>
Review Comment:
The jar includes the generated model too:
https://maven.apache.org/ref/4-LATEST/apidocs/org/apache/maven/api/settings/package-summary.html
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] hboutemy merged pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
hboutemy merged PR #830:
URL: https://github.com/apache/maven/pull/830
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] michael-o commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
michael-o commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1058987275
##########
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>
Review Comment:
Yes, good idea: `maven-api-meta-annotations`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] hboutemy commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
hboutemy commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1058987151
##########
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>
Review Comment:
I don't get
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] gnodet commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
gnodet commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1059151219
##########
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>
Review Comment:
This module actually contains the implementation of the XML `Dom` interface defined by the API.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] michael-o commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
michael-o commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1058988520
##########
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>
Review Comment:
Settings is something you configure/set on something, a settings module is the transport class which is used to plug the actual settings between a user and the backend.
Looking at the code it looks like Maven 4 API :: Settings Utils/Helpers. I don't see any settings nor a model.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] hboutemy commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
hboutemy commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1058984209
##########
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"/>
Review Comment:
we'll need to fix it in the whole Maven core project...
see https://maven.apache.org/ref/4.0.0-alpha-3/ or https://maven.apache.org/ref/3.8.6/
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] michael-o commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
michael-o commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1058988520
##########
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>
Review Comment:
Settings is something you configure/set on something, a settings module is the transport class which is used to plug the actual settings between a user and the backend.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] hboutemy commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
hboutemy commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1058983423
##########
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>
Review Comment:
no, the interface is named `Dom`, which is not the best name IMHO...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] hboutemy commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
hboutemy commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1058986535
##########
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>
Review Comment:
should we rename the artifactId?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] michael-o commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
michael-o commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1058988520
##########
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>
Review Comment:
Settings is something you configure/set on something, a settings module is the transport class which is used to plug the actual settings between a user and the backend. I see `settings.mdo` and a few templates, then this is a model module.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] gnodet commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
gnodet commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1059149603
##########
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>
Review Comment:
It's not helpers, it contains a single class which is the XML API used by maven:
https://maven.apache.org/ref/4-LATEST/apidocs/org/apache/maven/api/xml/package-summary.html
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] michael-o commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
michael-o commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1059151429
##########
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>
Review Comment:
Sounds reasonable
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] hboutemy commented on pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
hboutemy commented on PR #830:
URL: https://github.com/apache/maven/pull/830#issuecomment-1368247595
I'll merge this PR regarding basic documentation improvements
on the renaming ideas (`Dom` interface to `XmlNode`, `maven-api-meta` to `maven-api-annotations`), we'll do that separately while doing the plan discussed on dev ML https://lists.apache.org/thread/t52x7jfqlfxwtftbwv4vpfhqg6zgsysf
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] michael-o commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
michael-o commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1058487714
##########
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>
Review Comment:
I think the 5 is useless there days. Just "Java annotations" or "annotations" are good enough.
##########
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>
Review Comment:
Immutable
##########
api/maven-api-model/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"/>
Review Comment:
ditto
##########
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
Review Comment:
ditto
##########
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>
Review Comment:
ditto
##########
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>
Review Comment:
I think both name and artifactId are too generics. `maven-api-xml-helpers`, etc. fully describe the intent
##########
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"/>
Review Comment:
ditto
##########
maven-toolchain-model/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"/>
Review Comment:
ditto
##########
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"/>
Review Comment:
Canonically just 'Javadoc'
##########
api/maven-api-toolchain/src/site/apt/index.apt:
##########
@@ -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
Review Comment:
ditto
##########
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>
Review Comment:
Annotations
##########
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"/>
Review Comment:
ditto
##########
api/maven-api-model/src/site/apt/index.apt:
##########
@@ -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
Review Comment:
– Immutable
##########
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>
Review Comment:
So this module contains settings or the settings model? This is a difference.
##########
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"/>
Review Comment:
ditto
##########
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"/>
Review Comment:
ditto
##########
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"/>
Review Comment:
ditto
##########
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>
Review Comment:
see above
##########
maven-toolchain-builder/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"/>
Review Comment:
ditto
##########
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>
Review Comment:
DOM
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] michael-o commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
michael-o commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1058986775
##########
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"/>
Review Comment:
Yes, it is everywhere :-(
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] michael-o commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
michael-o commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1058986630
##########
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>
Review Comment:
Really? This is confusing, it thought it is an acronym referring to Document Object Model...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [maven] gnodet commented on a diff in pull request #830: [MNG-7571] add Maven API javadoc
Posted by GitBox <gi...@apache.org>.
gnodet commented on code in PR #830:
URL: https://github.com/apache/maven/pull/830#discussion_r1059150836
##########
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>
Review Comment:
The name comes from the plexus class [`Xpp3Dom`](https://github.com/codehaus-plexus/plexus-utils/blob/master/src/main/java/org/codehaus/plexus/util/xml/Xpp3Dom.java) but I removed the `Xpp3` part. And yes, it's referring to Document Object Model, but I would not call it `DOM`. We could rename it `XmlNode` ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org