Author: dennisl
Date: Thu Jul 20 12:54:46 2006
New Revision: 424034
URL: http://svn.apache.org/viewvc?rev=424034&view=rev
Log:
Minor tweaks to the documentation
Modified:
maven/sandbox/plugins/maven-docck-plugin/src/site/apt/examples/file-output.apt
maven/sandbox/plugins/maven-docck-plugin/src/site/apt/usage.apt
Modified:
maven/sandbox/plugins/maven-docck-plugin/src/site/apt/examples/file-output.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-docck-plugin/src/site/apt/examples/file-output.apt?rev=424034&r1=424033&r2=424034&view=diff
==============================================================================
---
maven/sandbox/plugins/maven-docck-plugin/src/site/apt/examples/file-output.apt
(original)
+++
maven/sandbox/plugins/maven-docck-plugin/src/site/apt/examples/file-output.apt
Thu Jul 20 12:54:46 2006
@@ -38,7 +38,9 @@
</project>
+---+
-* You can also direct the command-line execution output to a file using:
+* From the command-line
+
+ You can also direct the command-line execution output to a file using:
+---+
mvn docck:plugin -Doutput=target/docck-results.txt
Modified: maven/sandbox/plugins/maven-docck-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-docck-plugin/src/site/apt/usage.apt?rev=424034&r1=424033&r2=424034&view=diff
==============================================================================
--- maven/sandbox/plugins/maven-docck-plugin/src/site/apt/usage.apt (original)
+++ maven/sandbox/plugins/maven-docck-plugin/src/site/apt/usage.apt Thu Jul 20
12:54:46 2006
@@ -7,17 +7,12 @@
Usage
-* Introduction
-
This document is intended to provide instructions for using the
maven-docck-plugin. In order for this discussion to be useful, it's
- critical to cover two topics: Using the DOCCK Plugin from the command-line
- and configuring your project's pom.xml to run the DOCCK Plugin during its
- build.
-
-* Configuring DOCCK Plugin inside pom.xml
+ 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.
-** Using the DOCCK Plugin defaults
+* 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.
@@ -46,7 +41,7 @@
</project>
+---+
-* Using the command-line
+* Using the plugin from the command-line
The DOCCK Plugin is easily executed from the command line since it can run
without any parameter configuration.
@@ -57,7 +52,7 @@
mvn docck:plugin
+---+
-* Sample Output of the DOCCK Plugin
+* Sample Output
** Successful run with no documentation errors
