diff --git a/simian/xdocs/index.xml b/simian/xdocs/index.xml index 7f4312d1..782fd9d4 100644 --- a/simian/xdocs/index.xml +++ b/simian/xdocs/index.xml @@ -27,18 +27,29 @@
- This plugin generates xdoc documentation containing a - Simian - (Similarity Analyser) report. Simian identifies duplicated lines in - Java and C# source code. Ie. lines of code that occur more than once - across an entire source tree. + This plugin generates xdoc documentation containing a + Simian + (Similarity Analyser) report. Simian identifies duplicated lines in + Java and C# source code. Ie. lines of code that occur more than once + across an entire source tree.
Duplicate code should always be refactored. It is therefore recommended - that the maven.simian.failonduplication property be set to true and that the + that the maven.simian.failonduplication property be set to true and that the maven.simian.linecount property be small. This will make it easier to always have duplicates factored out in the codebase.
+
+ To enable the plugin, add the following to your project.xml's
+ /project/reports node:
+
+ For further details about how to use the plugin, see the + Goals and + Properties pages. +
+- As long as this plugin is not a standard Maven plugin, it must - be installed manually. This is very easy. -
-
- If you have a binary distribution of the plugin, just copy the plugin jar file
- to your $MAVEN_HOME/plugins directory. and the simian
- jar file to $MAVEN_HOME/repository/simian/jars.
-
- If you have a source distribution of the plugin, installing the plugin is just as easy. - Just run -
-- from the root directory of the unpacked distribution. -
-- To enable the plugin add the following to your project.xml's - /project/reports node: -
-- For further details about how to use the plugin, see the - Goals and Properties - pages. -
-