Author: vmassol
Date: Fri Oct 6 01:46:38 2006
New Revision: 453531
URL: http://svn.apache.org/viewvc?view=rev&rev=453531
Log:
MCLOVER-47: Align plugin documentation with Maven standards
* I had forgotten to commit the FAQ
* Added Examples to please the docck plugin. It's passing now.
Added:
maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/
maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/contexts.apt
maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/multiproject.apt
maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/simple.apt
maven/plugins/trunk/maven-clover-plugin/src/site/fml/
maven/plugins/trunk/maven-clover-plugin/src/site/fml/faq.fml
Modified:
maven/plugins/trunk/maven-clover-plugin/src/site/site.xml
Added:
maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/contexts.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/contexts.apt?view=auto&rev=453531
==============================================================================
--- maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/contexts.apt
(added)
+++ maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/contexts.apt
Fri Oct 6 01:46:38 2006
@@ -0,0 +1,35 @@
+ ------
+ Contexts Example
+ ------
+ Vincent Massol
+ <[EMAIL PROTECTED]>
+ ------
+ October 6th, 2006
+
+ ~~ Copyright 2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed 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.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+{Contexts Example}
+
+ This example demonstrates how to configure
{{{http://cenqua.com/clover/doc/adv/contexts.html}Clover filter contexts}}
+ using the Clover plugin.
+
+* {Sources}
+
+ Sources are available
{{{http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/it/contexts/}here}}.
+
+ To execute the project run either <<<mvn install>>> to verify the TPC or
<<<mvn site>>> to generate the Clover report.
Added:
maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/multiproject.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/multiproject.apt?view=auto&rev=453531
==============================================================================
---
maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/multiproject.apt
(added)
+++
maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/multiproject.apt
Fri Oct 6 01:46:38 2006
@@ -0,0 +1,41 @@
+ ------
+ Multiproject Example
+ ------
+ Vincent Massol
+ <[EMAIL PROTECTED]>
+ ------
+ October 6th, 2006
+
+ ~~ Copyright 2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed 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.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+{Multiproject Example}
+
+ This example demonstrates how to use the Clover plugin in a multiproject
scenario (i.e. a master Maven project with
+ several children modules. It also demonstrates how to perform Clover report
aggregation and how functional tests
+ can be accounted for in the Clove report.
+
+* {Sources}
+
+ Sources are available
{{{http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/it/multiproject/}here}}.
+
+ To execute the project run <<<mvn install>>> to generate the Clover report.
+
+ Note: Because of a {{{http://jira.codehaus.org/browse/MCLOVER-34}bug in
Maven2}} you'll need to run
+ <<<mvn install>>> twice at the top level if you want to generate an
aggregated report. This is because it currently
+ works only if the Clover databases int he children exist prior to the top
level project running the Clover report
+ generation.
Added: maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/simple.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/simple.apt?view=auto&rev=453531
==============================================================================
--- maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/simple.apt
(added)
+++ maven/plugins/trunk/maven-clover-plugin/src/site/apt/examples/simple.apt
Fri Oct 6 01:46:38 2006
@@ -0,0 +1,35 @@
+ ------
+ Simple Example
+ ------
+ Vincent Massol
+ <[EMAIL PROTECTED]>
+ ------
+ October 6th, 2006
+
+ ~~ Copyright 2006 The Apache Software Foundation.
+ ~~
+ ~~ Licensed 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.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+{Simple Example}
+
+ This example demonstrates how to use the Clover plugin both for report
generation and for Test Percentage
+ Clover (TPC) verification, on a single Maven project.
+
+* {Sources}
+
+ Sources are available
{{{http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/it/simple/}here}}.
+
+ To execute the project run either <<<mvn install>>> to verify the TPC or
<<<mvn site>>> to generate the Clover report.
Added: maven/plugins/trunk/maven-clover-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/site/fml/faq.fml?view=auto&rev=453531
==============================================================================
--- maven/plugins/trunk/maven-clover-plugin/src/site/fml/faq.fml (added)
+++ maven/plugins/trunk/maven-clover-plugin/src/site/fml/faq.fml Fri Oct 6
01:46:38 2006
@@ -0,0 +1,38 @@
+<?xml version="1.0"?>
+
+<!--
+ ~ Copyright 2006 The Apache Software Foundation.
+ ~
+ ~ Licensed 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.
+ -->
+
+<faqs id="FAQ" title="Frequently Asked Questions">
+ <part id="General">
+ <faq id="Does Clover work on the Source code or the bytecode?">
+ <question>Does Clover work on the Source code or the bytecode?</question>
+ <answer>
+ <p>Clover works on the source code. It is not possible for Clover to
work
+ on bytecodes.</p>
+ </answer>
+ </faq>
+ <faq id="Why are my tests executed twice?">
+ <question>Why are my tests executed twice?</question>
+ <answer>
+ <p>The Clover plugin takes great care not to mix the instrumented code
nor any artifact generated from it
+ with main production sources and artifacts. This is the reason why you
may see your tests executed twice: once
+ for the production sources and once for the Clover-instrumented sources.
+ </p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
Modified: maven/plugins/trunk/maven-clover-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/site/site.xml?view=diff&rev=453531&r1=453530&r2=453531
==============================================================================
--- maven/plugins/trunk/maven-clover-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-clover-plugin/src/site/site.xml Fri Oct 6
01:46:38 2006
@@ -38,12 +38,11 @@
<item name="FAQ" href="faq.html"/>
</menu>
- <!-- TODO: Give examples -->
- <!--menu name="Examples">
- <item name="item 1" href="examples/item1.html"/>
- <item name="item 2" href="examples/item2.html"/>
- <item name="item 3" href="examples/item3.html"/>
- </menu-->
+ <menu name="Examples">
+ <item name="Simple" href="/examples/simple.html"/>
+ <item name="Filter Contexts" href="/examples/contexts.html"/>
+ <item name="Multiproject" href="/examples/multiproject.html"/>
+ </menu>
<!-- To be uncommented once it's up to date again -->
<!--menu name="Architecture">
