maven-plugins/simian/xdocs/properties.xml
aheritier 373a6481dd MAVEN-1285
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@115390 13f79535-47bb-0310-9956-ffa450edef68
2004-05-19 23:38:15 +00:00

117 lines
3.9 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
/*
* Copyright 2001-2004 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.
*/
-->
<document>
<properties>
<title>Simian Properties</title>
<author email="aslak@thoughtworks.net">Aslak Hellesoy</author>
<author email="maurice@maguyane.net">Maurice Montgénie</author>
</properties>
<body>
<section name="Simian Properties">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>maven.simian.linecount</td>
<td>Yes (default = 10)</td>
<td>
Specifies the minimum number of lines that is considered a match.
</td>
</tr>
<tr>
<td>maven.simian.includetests</td>
<td>Yes (default = true)</td>
<td>
Specifies whether simian should process the unit test files if
present.
</td>
</tr>
<tr>
<td>maven.simian.failonduplication</td>
<td>Yes (default = false)</td>
<td>
Specifies whether the build should fail if a match is found.
</td>
</tr>
<tr>
<td>maven.simian.ignorestrings</td>
<td>Yes (default = false)</td>
<td>
Ignore strings (Java, C#, C, C++, JavaScript, COBOL): "one" and "two" would both match.
</td>
</tr>
<tr>
<td>maven.simian.ignorestringcase</td>
<td>Yes (default = false)</td>
<td>
Ignore string case (Java, C#, C, C++, JavaScript, COBOL): "Hello, World" and "HELLO, WORLD" would both match.
</td>
</tr>
<tr>
<td>maven.simian.ignorenumbers</td>
<td>Yes (default = false)</td>
<td>
Ignore numbers (Java, C#, C, C++, JavaScript, COBOL): int x = 1; and int x = 576; would both match.
</td>
</tr>
<tr>
<td>maven.simian.ignoresubtypenames</td>
<td>Yes (default = false)</td>
<td>
Ignore subtype names (Java): BufferedReader, StringReader and Reader would all match.
</td>
</tr>
<tr>
<td>maven.simian.ignoremodifiers</td>
<td>Yes (default = false)</td>
<td>
Ignore modifiers (Java, C#, C, C++, JavaScript): public, protected, static, etc.
</td>
</tr>
<tr>
<td>maven.simian.includes</td>
<td>Yes</td>
<td>
Specifies a comma-separated list of Ant patterns to use
when matching files in the source tree to be included in the
Simian report. The pattern specified is relative to
<code>${maven.src.dir}</code>. The default value is
<code>**/*.java</code>, which matches all Java source files
in the source tree (specified by the <code>${maven.src.dir}</code>
property.
</td>
</tr>
<tr>
<td>maven.simian.excludes</td>
<td>Yes</td>
<td>
Specifies a comma-separated list of Ant patterns to use when
matching files in the source tree to be excluded from the
Simian report. The pattern specified is relative to
<code>${maven.src.dir}</code>. The default value is to not
exclude any files.
</td>
</tr>
</table>
</section>
</body>
</document>