You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ah...@apache.org on 2015/04/01 02:24:13 UTC
[31/50] [abbrv] maven git commit: added doculmentation about
extension descriptor
added doculmentation about extension descriptor
Project: http://git-wip-us.apache.org/repos/asf/maven/repo
Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/ab5f3a9d
Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/ab5f3a9d
Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/ab5f3a9d
Branch: refs/heads/slf4j-log4j2
Commit: ab5f3a9de789c2ee3fcac79646bdb3240ab15cc1
Parents: 207d18d
Author: Hervé Boutemy <hb...@apache.org>
Authored: Mon Mar 9 04:56:26 2015 +0100
Committer: Hervé Boutemy <hb...@apache.org>
Committed: Mon Mar 9 04:56:26 2015 +0100
----------------------------------------------------------------------
maven-core/pom.xml | 15 +++++++
maven-core/src/main/mdo/extension.mdo | 65 ++++++++++++++++++++++++++++++
maven-core/src/site/apt/index.apt | 2 +
3 files changed, 82 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/maven/blob/ab5f3a9d/maven-core/pom.xml
----------------------------------------------------------------------
diff --git a/maven-core/pom.xml b/maven-core/pom.xml
index e69ffd3..ef6ccd9 100644
--- a/maven-core/pom.xml
+++ b/maven-core/pom.xml
@@ -190,6 +190,21 @@
<model>src/main/mdo/toolchains.mdo</model>
</models>
</configuration>
+ <executions>
+ <execution>
+ <id>plugin-site-doc</id>
+ <phase>pre-site</phase>
+ <goals>
+ <goal>xdoc</goal>
+ </goals>
+ <configuration>
+ <version>1.0.0</version>
+ <models>
+ <model>src/main/mdo/extension.mdo</model>
+ </models>
+ </configuration>
+ </execution>
+ </executions>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
http://git-wip-us.apache.org/repos/asf/maven/blob/ab5f3a9d/maven-core/src/main/mdo/extension.mdo
----------------------------------------------------------------------
diff --git a/maven-core/src/main/mdo/extension.mdo b/maven-core/src/main/mdo/extension.mdo
new file mode 100644
index 0000000..4b2e460
--- /dev/null
+++ b/maven-core/src/main/mdo/extension.mdo
@@ -0,0 +1,65 @@
+<!--
+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.
+-->
+
+<model xmlns="http://modello.codehaus.org/MODELLO/1.4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://modello.codehaus.org/MODELLO/1.4.0 http://modello.codehaus.org/xsd/modello-1.4.0.xsd">
+ <id>extension</id>
+ <name>ExtensionDescriptor</name>
+ <description><![CDATA[
+ Extension descriptor, stored in <code>META-INF/maven/extension.xml</code> in an extension's jar artifact to
+ precisely control parts of the extension and dependencies to expose.
+ <p><i>Notice:</i> this documentation is generated from a Modello model but the code executed is not generated
+ from this descriptor. Please report if you find anything wrong.</p>
+ ]]></description>
+ <defaults>
+ <default>
+ <key>package</key>
+ <value>extension descriptor XML documentation (no java generation)</value><!-- intentionally non-buildable value -->
+ </default>
+ </defaults>
+ <classes>
+ <class rootElement="true" xml.tagName="extension">
+ <name>ExtensionDescriptor</name>
+ <version>1.0.0</version>
+ <description><![CDATA[Root element of the <code>extension.xml</code> file.]]></description>
+ <fields>
+ <field>
+ <name>exportedPackages</name>
+ <version>1.0.0</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description>Packages from the artifact that are exposed.</description>
+ <!-- TODO explain package vs package.class vs package.* -->
+ </field>
+ <field>
+ <name>exportedArtifacts</name>
+ <version>1.0.0</version>
+ <association>
+ <type>String</type>
+ <multiplicity>*</multiplicity>
+ </association>
+ <description><![CDATA[Artifacts that are exposed: <code>groupId:artifactId</code> file.]]>
+ </description>
+ </field>
+ </fields>
+ </class>
+ </classes>
+</model>
http://git-wip-us.apache.org/repos/asf/maven/blob/ab5f3a9d/maven-core/src/site/apt/index.apt
----------------------------------------------------------------------
diff --git a/maven-core/src/site/apt/index.apt b/maven-core/src/site/apt/index.apt
index 390215c..f6c26fd 100644
--- a/maven-core/src/site/apt/index.apt
+++ b/maven-core/src/site/apt/index.apt
@@ -53,6 +53,8 @@ Maven Core
({{{./xref/org/apache/maven/classrealm/DefaultClassRealmManager.html}source}}), using
{{{http://plexus.codehaus.org/plexus-classworlds/}Plexus Classworlds}},
+ * {{{./extension.html}extension descriptor}},
+
* <<<ExceptionHandler>>> component ({{{./apidocs/org/apache/maven/exception/ExceptionHandler.html}javadoc}}),
with its <<<DefaultExceptionHandler>>> implementation
({{{./xref/org/apache/maven/exception/DefaultExceptionHandler.html}source}}), use to transform exception into useful end-user messages.