Author: rdonkin
Date: Sat Jan 17 06:42:28 2009
New Revision: 735298
URL: http://svn.apache.org/viewvc?rev=735298&view=rev
Log:
Added usage page
Added:
james/mailet/maven-mailetdocs-plugin/trunk/src/site/apt/
james/mailet/maven-mailetdocs-plugin/trunk/src/site/apt/usage.apt
Modified:
james/mailet/maven-mailetdocs-plugin/trunk/src/site/site.xml
Added: james/mailet/maven-mailetdocs-plugin/trunk/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/james/mailet/maven-mailetdocs-plugin/trunk/src/site/apt/usage.apt?rev=735298&view=auto
==============================================================================
--- james/mailet/maven-mailetdocs-plugin/trunk/src/site/apt/usage.apt (added)
+++ james/mailet/maven-mailetdocs-plugin/trunk/src/site/apt/usage.apt Sat Jan
17 06:42:28 2009
@@ -0,0 +1,49 @@
+ ------
+ Usage
+ ------
+ Apache JAMES Project Team
+ ------
+ 2009-01-17
+ ------
+
+~~ 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.
+
+Usage
+
+ The MailetDocs plugin for {{{http://maven.apache.org} Maven2}} finds all
+ mailets and matchers (as defined by the
{{{http://james.apache.org/mailet/api} Mailet API}}).
+ It generates reports on each and then combines all into a single catelog.
+
+* The <<<mailetdocs:mailetdocs>>> Goal
+
+ To include the generated documentation, this should be included
+ in the reports generated for a project:
+
++----------------------------------
+ <reporting>
+ ...
+ <plugins>
+ <plugin>
+ <groupId>org.apache.james</groupId>
+ <artifactId>maven-mailetdocs-plugin</artifactId>
+ <version>0.1</version>
+ </plugin>
+ ...
+ </plugins>
+ </reporting>
++----------------------------------
\ No newline at end of file
Modified: james/mailet/maven-mailetdocs-plugin/trunk/src/site/site.xml
URL:
http://svn.apache.org/viewvc/james/mailet/maven-mailetdocs-plugin/trunk/src/site/site.xml?rev=735298&r1=735297&r2=735298&view=diff
==============================================================================
--- james/mailet/maven-mailetdocs-plugin/trunk/src/site/site.xml (original)
+++ james/mailet/maven-mailetdocs-plugin/trunk/src/site/site.xml Sat Jan 17
06:42:28 2009
@@ -35,6 +35,7 @@
<menu name="MailetDocs Maven Plugin">
<item name="Introduction" href="index.html"/>
<item name="Goals" href="plugin-info.html"/>
+ <item name="Usage" href="usage.html"/>
<item
name="DOAP"
href="doap_crypto-mailets.rdf"
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
