Author: vmassol
Date: Mon Nov 6 05:44:34 2006
New Revision: 471733
URL: http://svn.apache.org/viewvc?view=rev&rev=471733
Log:
MCLOVER-60: Create architecture documentation
Modified:
maven/plugins/trunk/maven-clover-plugin/src/site/apt/architecture/architecture.apt
maven/plugins/trunk/maven-clover-plugin/src/site/apt/architecture/clover-check.apt
maven/plugins/trunk/maven-clover-plugin/src/site/apt/architecture/clover-report.apt
maven/plugins/trunk/maven-clover-plugin/src/site/misc/architecture.ppt
maven/plugins/trunk/maven-clover-plugin/src/site/resources/images/clover-check-achitecture-small.jpg
maven/plugins/trunk/maven-clover-plugin/src/site/resources/images/clover-check-achitecture.jpg
maven/plugins/trunk/maven-clover-plugin/src/site/resources/images/clover-report-architecture-small.jpg
maven/plugins/trunk/maven-clover-plugin/src/site/resources/images/clover-report-architecture.jpg
maven/plugins/trunk/maven-clover-plugin/src/site/site.xml
Modified:
maven/plugins/trunk/maven-clover-plugin/src/site/apt/architecture/architecture.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/site/apt/architecture/architecture.apt?view=diff&rev=471733&r1=471732&r2=471733
==============================================================================
---
maven/plugins/trunk/maven-clover-plugin/src/site/apt/architecture/architecture.apt
(original)
+++
maven/plugins/trunk/maven-clover-plugin/src/site/apt/architecture/architecture.apt
Mon Nov 6 05:44:34 2006
@@ -1,10 +1,27 @@
------
- Maven 2 Clover Plugin
+ Architecture
------
Vincent Massol
<[EMAIL PROTECTED]>
------
- January 13th, 2006
+ November 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
Architecture
Modified:
maven/plugins/trunk/maven-clover-plugin/src/site/apt/architecture/clover-check.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/site/apt/architecture/clover-check.apt?view=diff&rev=471733&r1=471732&r2=471733
==============================================================================
---
maven/plugins/trunk/maven-clover-plugin/src/site/apt/architecture/clover-check.apt
(original)
+++
maven/plugins/trunk/maven-clover-plugin/src/site/apt/architecture/clover-check.apt
Mon Nov 6 05:44:34 2006
@@ -1,14 +1,35 @@
------
- Maven 2 Clover Plugin
+ Clover Check Architecture
------
Vincent Massol
<[EMAIL PROTECTED]>
------
- December 20th, 2005
+ November 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
Architecture of the clover:check goal
Here's how the <<<clover:check>>> goal works:
[../images/clover-check-achitecture.jpg] Clover check goal architecture
-
\ No newline at end of file
+
+ Note that the generation of the Clover database is independent of the
<<<clover:check>>> goal which expects
+ a Clover database to exist prior to calling it. In the architecture diagram
we've shown a typical use case
+ where the creation of the Clover database is done by binding the
<<<clover:instrument>>> goal to the
+ <<<verify>>> phase, before the execution of the <<<clover:check>>> goal.
Modified:
maven/plugins/trunk/maven-clover-plugin/src/site/apt/architecture/clover-report.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/site/apt/architecture/clover-report.apt?view=diff&rev=471733&r1=471732&r2=471733
==============================================================================
---
maven/plugins/trunk/maven-clover-plugin/src/site/apt/architecture/clover-report.apt
(original)
+++
maven/plugins/trunk/maven-clover-plugin/src/site/apt/architecture/clover-report.apt
Mon Nov 6 05:44:34 2006
@@ -1,10 +1,27 @@
------
- Maven 2 Clover Plugin
+ Clover Report Architecture
------
Vincent Massol
<[EMAIL PROTECTED]>
------
- January 13th, 2006
+ November 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
Architecture of the clover:clover goal
@@ -12,4 +29,9 @@
Here's how it works:
[../images/clover-report-achitecture.jpg] Clover report goal architecture
+
+ Note that the generation of the Clover database is independent of the
<<<clover:clover>>> goal which expects
+ a Clover database to exist prior to calling it. In the architecture diagram
we've shown a typical use case
+ where the creation of the Clover database is done by binding the
<<<clover:instrument>>> goal to the
+ <<<pre-site>>> phase so that it executes prior to the report generation.
Modified: maven/plugins/trunk/maven-clover-plugin/src/site/misc/architecture.ppt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/site/misc/architecture.ppt?view=diff&rev=471733&r1=471732&r2=471733
==============================================================================
Binary files - no diff available.
Modified:
maven/plugins/trunk/maven-clover-plugin/src/site/resources/images/clover-check-achitecture-small.jpg
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/site/resources/images/clover-check-achitecture-small.jpg?view=diff&rev=471733&r1=471732&r2=471733
==============================================================================
Binary files - no diff available.
Modified:
maven/plugins/trunk/maven-clover-plugin/src/site/resources/images/clover-check-achitecture.jpg
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/site/resources/images/clover-check-achitecture.jpg?view=diff&rev=471733&r1=471732&r2=471733
==============================================================================
Binary files - no diff available.
Modified:
maven/plugins/trunk/maven-clover-plugin/src/site/resources/images/clover-report-architecture-small.jpg
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/site/resources/images/clover-report-architecture-small.jpg?view=diff&rev=471733&r1=471732&r2=471733
==============================================================================
Binary files - no diff available.
Modified:
maven/plugins/trunk/maven-clover-plugin/src/site/resources/images/clover-report-architecture.jpg
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-clover-plugin/src/site/resources/images/clover-report-architecture.jpg?view=diff&rev=471733&r1=471732&r2=471733
==============================================================================
Binary files - no diff available.
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=471733&r1=471732&r2=471733
==============================================================================
--- maven/plugins/trunk/maven-clover-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-clover-plugin/src/site/site.xml Mon Nov 6
05:44:34 2006
@@ -23,12 +23,10 @@
<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">
<item name="Overview" href="/architecture/architecture.html"/>
<item name="Check Goal" href="/architecture/clover-check.html"/>
+ <item name="Report Goal" href="/architecture/clover-report.html"/>
</menu>
- -->
</body>
</project>
