2005-12-09 18:36:31 +00:00

89 lines
2.8 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed 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.
*/
-->
<document>
<properties>
<title>XDoc plugin goals</title>
<author email="dion@apache.org">dIon Gillard</author>
<author email="vincent.siveton@gmail.com">Vincent Siveton</author>
</properties>
<body>
<goals>
<goal>
<name>xdoc</name>
<description>
The default goal. This goal simply executes the
<code>xdoc:generate-from-pom</code>
and <code>xdoc:transform</code> goals.
</description>
</goal>
<goal>
<name>xdoc:generate-from-pom</name>
<description>
Generate a set of reports from your <code>project.xml</code> file.
This includes the dependency, mailing list, project info, project
reports and team list pages.
</description>
</goal>
<goal>
<name>xdoc:transform</name>
<description>
Transforms user supplied documents into html.
</description>
</goal>
<goal>
<name>xdoc:validate</name>
<description>
Validates the user xdoc documents. See
<a href="reference/xdocs.html#Validation">Validation</a>.
</description>
</goal>
<goal>
<name>xdoc:navigation-validate</name>
<description>
Validates the navigation file ${maven.xdoc.navigation.file}. See
<a href="reference/navfile.html#Validation">Validation</a>.
</description>
</goal>
<goal>
<name>xdoc:sitemap</name>
<description>
Generates a sitemap from the information found in the
navigation file ${maven.xdoc.navigation.file}.
See <a href="reference/navfile.html#Sitemap">Sitemap</a>.
</description>
</goal>
<goal>
<name>copy-user-bundles</name>
<description>
Copy user bundles in the XDOC plugin. Used for the i18n support.
</description>
</goal>
<goal>
<name>clean-user-bundles</name>
<description>
Remove all user bundles from the XDOC plugin.
</description>
</goal>
</goals>
</body>
</document>