Author: dennisl
Date: Sun Sep 14 09:08:24 2008
New Revision: 695247
URL: http://svn.apache.org/viewvc?rev=695247&view=rev
Log:
o Polish the site.
Modified:
maven/plugins/trunk/maven-docck-plugin/src/site/apt/examples/file-output.apt
maven/plugins/trunk/maven-docck-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-docck-plugin/src/site/fml/faq.fml
Modified:
maven/plugins/trunk/maven-docck-plugin/src/site/apt/examples/file-output.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-docck-plugin/src/site/apt/examples/file-output.apt?rev=695247&r1=695246&r2=695247&view=diff
==============================================================================
---
maven/plugins/trunk/maven-docck-plugin/src/site/apt/examples/file-output.apt
(original)
+++
maven/plugins/trunk/maven-docck-plugin/src/site/apt/examples/file-output.apt
Sun Sep 14 09:08:24 2008
@@ -2,6 +2,7 @@
Sending the output to a file
------
------
+ 2008-09-14
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -26,17 +27,17 @@
Sending the output to a file
-* Configuring your pom.xml
+* Configuring your <<<pom.xml>>>
You can use the following configuration in your <<<pom.xml>>> to run the
DOCCK
Plugin everytime the project is built and send its output to a file.
+---+
<project>
- [...]
+ ...
<build>
<plugins>
- [...]
+ ...
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-docck-plugin</artifactId>
@@ -51,10 +52,10 @@
</execution>
</executions>
</plugin>
- [...]
+ ...
</plugins>
</build>
- [...]
+ ...
</project>
+---+
Modified: maven/plugins/trunk/maven-docck-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-docck-plugin/src/site/apt/usage.apt?rev=695247&r1=695246&r2=695247&view=diff
==============================================================================
--- maven/plugins/trunk/maven-docck-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-docck-plugin/src/site/apt/usage.apt Sun Sep 14
09:08:24 2008
@@ -2,7 +2,7 @@
Usage
------
------
- 19-June-2006
+ 2008-09-14
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -28,21 +28,21 @@
Usage
This document is intended to provide instructions for using the
- maven-docck-plugin. In order for this discussion to be useful, it's
+ Maven DOCCK Plugin. In order for this discussion to be useful, it's
critical to cover two topics: Configuring your project's <<<pom.xml>>> to run
the plugin during every build and using the plugin from the command-line.
-* Configuring the plugin in pom.xml
+* Configuring the plugin in <<<pom.xml>>>
You can use the following configuration in your <<<pom.xml>>> to run the
DOCCK
Plugin everytime the project is built.
+---+
<project>
- [...]
+ ...
<build>
<plugins>
- [...]
+ ...
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-docck-plugin</artifactId>
@@ -54,10 +54,10 @@
</execution>
</executions>
</plugin>
- [...]
+ ...
</plugins>
</build>
- [...]
+ ...
</project>
+---+
@@ -66,7 +66,7 @@
The DOCCK Plugin is easily executed from the command line since it can run
without any parameter configuration.
- To run the DOCCK Plugin on a project, use:
+ To run the DOCCK Plugin on a project, type:
+---+
mvn docck:check
Modified: maven/plugins/trunk/maven-docck-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-docck-plugin/src/site/fml/faq.fml?rev=695247&r1=695246&r2=695247&view=diff
==============================================================================
--- maven/plugins/trunk/maven-docck-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-docck-plugin/src/site/fml/faq.fml Sun Sep 14
09:08:24 2008
@@ -26,10 +26,10 @@
<answer>
<p>
The plugin documentation standard was created to address the frequent
- complaint of lack of documentation, specifically on the maven plugins.
- The standard was based on suggestions made on the maven dev mailing
+ complaint of lack of documentation, specifically for the Maven
plugins.
+ The standard was based on suggestions made on the Maven dev mailing
list with some refinements. It is a community consensus of what basic
- documentation a maven plugin should have.
+ documentation a Maven plugin should have.
</p>
</answer>
</faq>
