Author: dennisl
Date: Wed Jul 19 16:44:29 2006
New Revision: 423662
URL: http://svn.apache.org/viewvc?rev=423662&view=rev
Log:
Update the site to comply with mvn docck:plugin
Added:
maven/sandbox/plugins/maven-docck-plugin/src/site/apt/index.apt (with
props)
maven/sandbox/plugins/maven-docck-plugin/src/site/fml/
maven/sandbox/plugins/maven-docck-plugin/src/site/fml/faq.fml (with props)
Modified:
maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java
maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java
maven/sandbox/plugins/maven-docck-plugin/src/site/apt/examples/file-output.apt
(contents, props changed)
maven/sandbox/plugins/maven-docck-plugin/src/site/apt/usage.apt
(contents, props changed)
maven/sandbox/plugins/maven-docck-plugin/src/site/site.xml
Modified:
maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java
URL:
http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java?rev=423662&r1=423661&r2=423662&view=diff
==============================================================================
---
maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java
(original)
+++
maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java
Wed Jul 19 16:44:29 2006
@@ -63,14 +63,15 @@
private List reactorProjects;
/**
- * An optional location where the results should be written.
+ * An optional location where the results will be written to. If this is
+ * not specified the results will be written to the console.
*
* @parameter expression="${output}"
*/
private File output;
/**
- * Directory to search for files used by maven-site-plugin
+ * Directory where the site source for the project is located.
*
* @parameter expression="${siteDirectory}" default-value="src/site"
* @todo should be determined programmatically
Modified:
maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java
URL:
http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java?rev=423662&r1=423661&r2=423662&view=diff
==============================================================================
---
maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java
(original)
+++
maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.java
Wed Jul 19 16:44:29 2006
@@ -46,7 +46,7 @@
{
/**
- * Plexus component that searches for Mojos
+ * Plexus component that searches for Mojos.
*
* @component
*/
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=423662&r1=423661&r2=423662&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
Wed Jul 19 16:44:29 2006
@@ -1,5 +1,10 @@
+ ------
+ Sending the output to a file
+ ------
+ ------
+ ------
-Using the DOCCK Plugin to send its output to a file
+Sending the output to a file
* Configuring your pom.xml
Propchange:
maven/sandbox/plugins/maven-docck-plugin/src/site/apt/examples/file-output.apt
------------------------------------------------------------------------------
svn:eol-style = native
Added: maven/sandbox/plugins/maven-docck-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-docck-plugin/src/site/apt/index.apt?rev=423662&view=auto
==============================================================================
--- maven/sandbox/plugins/maven-docck-plugin/src/site/apt/index.apt (added)
+++ maven/sandbox/plugins/maven-docck-plugin/src/site/apt/index.apt Wed Jul 19
16:44:29 2006
@@ -0,0 +1,30 @@
+ ------
+ Introduction
+ ------
+ Dennis Lundberg
+ ------
+ 20 July 2006
+ ------
+
+
+Maven 2 DOCCK Plugin
+
+ This plugin checks that a project complies with the
+
{{{http://maven.apache.org/guides/development/guide-plugin-documentation.html}Plugin
Documentation Standard}}.
+
+* Goals Overview
+
+ * {{{plugin-mojo.html}docck:plugin}} Checks a plugin's documentation for the
standard minimums.
+
+ []
+
+* Usage
+
+ Instructions on how to use the DOCCK Plugin can be found
{{{usage.html}here}}.
+
+* Examples
+
+ To provide you with better understanding of some usages of the DOCCK Plugin,
+ you can take a look at the following examples:
+
+ * {{{examples/file-output.html}Sending the output to a file}}
Propchange: maven/sandbox/plugins/maven-docck-plugin/src/site/apt/index.apt
------------------------------------------------------------------------------
svn:eol-style = native
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=423662&r1=423661&r2=423662&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 Wed Jul 19
16:44:29 2006
@@ -1,11 +1,11 @@
------
- Maven 2 DOCCK Plugin
+ Usage
------
------
19-June-2006
------
-DOCCK Plugin - Configuration and Usage
+Usage
* Introduction
@@ -64,12 +64,10 @@
+---+
[INFO] Scanning for projects...
[INFO] Searching repository for plugin with prefix: 'docck'.
-[INFO]
-------------------------------------------------------------------------
----
+[INFO]
----------------------------------------------------------------------------
[INFO] Building Mojo Project
[INFO] task-segment: [docck:plugin] (aggregator-style)
-[INFO]
-------------------------------------------------------------------------
----
+[INFO]
----------------------------------------------------------------------------
[INFO] [docck:plugin]
[INFO] Checking project: Mojo Project
[INFO] Using 2 extractors.
@@ -92,12 +90,10 @@
+---+
[INFO] Scanning for projects...
[INFO] Searching repository for plugin with prefix: 'docck'.
-[INFO]
-------------------------------------------------------------------------
----
+[INFO]
----------------------------------------------------------------------------
[INFO] Building Mojo Project
[INFO] task-segment: [docck:plugin] (aggregator-style)
-[INFO]
-------------------------------------------------------------------------
----
+[INFO]
----------------------------------------------------------------------------
[INFO] [docck:plugin]
[INFO] Checking project: Mojo Project
[INFO] Using 2 extractors.
Propchange: maven/sandbox/plugins/maven-docck-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:eol-style = native
Added: maven/sandbox/plugins/maven-docck-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-docck-plugin/src/site/fml/faq.fml?rev=423662&view=auto
==============================================================================
--- maven/sandbox/plugins/maven-docck-plugin/src/site/fml/faq.fml (added)
+++ maven/sandbox/plugins/maven-docck-plugin/src/site/fml/faq.fml Wed Jul 19
16:44:29 2006
@@ -0,0 +1,29 @@
+<?xml version="1.0"?>
+<faqs id="FAQ" title="Frequently Asked Questions">
+ <part id="General">
+ <faq id="question1">
+ <question>Where did the standard came from?</question>
+ <answer>
+ <p>
+ The plugin documentation standard was created to address the frequent
+ complain of lack of documentation, specifically on the maven
plugins.
+ The standard was based on the suggestion made on the maven dev
mailing
+ list with some refinements. It is a community consensus of what
basic
+ documentation a maven plugin should have.
+ </p>
+ </answer>
+ </faq>
+ <faq id="question2">
+ <question>Why do we need a documentation standard?</question>
+ <answer>
+ <p>
+ The standard is not a set of rules but a guide to help plugin
+ developers document their plugins better, for the benefit of the users
+ of the plugin. The standard also reminds the plugin developers of the
+ important details that needs to be documented, to help speed up the
+ adoption of the plugin.
+ </p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
\ No newline at end of file
Propchange: maven/sandbox/plugins/maven-docck-plugin/src/site/fml/faq.fml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: maven/sandbox/plugins/maven-docck-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-docck-plugin/src/site/site.xml?rev=423662&r1=423661&r2=423662&view=diff
==============================================================================
--- maven/sandbox/plugins/maven-docck-plugin/src/site/site.xml (original)
+++ maven/sandbox/plugins/maven-docck-plugin/src/site/site.xml Wed Jul 19
16:44:29 2006
@@ -33,12 +33,14 @@
</links>
<menu name="Overview">
+ <item name="Introduction" href="index.html"/>
<item name="Goals" href="plugin-info.html"/>
<item name="Usage" href="usage.html"/>
+ <item name="FAQ" href="faq.html"/>
</menu>
<menu name="Examples">
- <item name="Sending output to a file" href="examples/file-output.html" />
+ <item name="Sending the output to a file"
href="examples/file-output.html" />
</menu>
${reports}
