Author: rdonkin
Date: Sat Jan 17 06:21:00 2009
New Revision: 735296
URL: http://svn.apache.org/viewvc?rev=735296&view=rev
Log:
Improved goal documentation
Modified:
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/MailetdocsMojo.java
james/mailet/maven-mailetdocs-plugin/trunk/src/site/xdoc/index.xml
Modified:
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/MailetdocsMojo.java
URL:
http://svn.apache.org/viewvc/james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/MailetdocsMojo.java?rev=735296&r1=735295&r2=735296&view=diff
==============================================================================
---
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/MailetdocsMojo.java
(original)
+++
james/mailet/maven-mailetdocs-plugin/trunk/src/main/java/org/apache/james/mailet/MailetdocsMojo.java
Sat Jan 17 06:21:00 2009
@@ -33,8 +33,14 @@
import java.util.Locale;
/**
+ * <p>Generates catelog and reports on mailets and matchers.</p>
+ * <h4>Notes</h4>
+ * <ul>
+ * <li>Should only used as a report.</li>
+ * <li>Mailets are instantiated during report production. </li>
+ * </ul>
* @goal mailetdocs
- *
+ * @since 0.1
* @requiresDependencyResolution compile
*/
public class MailetdocsMojo extends AbstractMavenReport {
@@ -60,6 +66,7 @@
*
* @parameter expression="${project.reporting.outputDirectory}"
* @required
+ * @since 0.1
*/
private File outputDirectory;
Modified: james/mailet/maven-mailetdocs-plugin/trunk/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewvc/james/mailet/maven-mailetdocs-plugin/trunk/src/site/xdoc/index.xml?rev=735296&r1=735295&r2=735296&view=diff
==============================================================================
--- james/mailet/maven-mailetdocs-plugin/trunk/src/site/xdoc/index.xml
(original)
+++ james/mailet/maven-mailetdocs-plugin/trunk/src/site/xdoc/index.xml Sat Jan
17 06:21:00 2009
@@ -26,7 +26,13 @@
<section name="MailetDocs Maven Plugin">
<p>MailetDocs is a <a href='http://maven.apache.org'>Maven</a> plugin
which
generates documentation for mailets. For example, this
- <a
href='http://james.apache.org/mailet/standard/mailet-report.html'>report</a>.</p>
+ <a
href='http://james.apache.org/mailet/standard/mailet-report.html'>report</a>.</p>
+ <subsection name='Goals Overview'>
+ <p>MailetDocs plugin has one goal:</p>
+ <ul>
+ <li><a href='mailetdocs-mojo.html'>mailetdocs:mailetdocs</a>
Generates catelog and reports on mailets and matchers</li>
+ </ul>
+ </subsection>
</section>
</body>
</document>
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
