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

added doculmentation about extension descriptor

This commit is contained in:
Hervé Boutemy 2015-03-09 04:56:26 +01:00
parent 207d18ddb6
commit ab5f3a9de7
3 changed files with 82 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
maven-core/pom.xml
View File

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

65
maven-core/src/main/mdo/extension.mdo Normal file
View File

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

2
maven-core/src/site/apt/index.apt
View File

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