maven-plugins/jalopy/xdocs/properties.xml
2004-09-02 12:36:45 +00:00

138 lines
4.6 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>Jalopy Properties</title>
<author email="evenisse@ifrance.com">Emmanuel Venisse</author>
</properties>
<body>
<section name="Jalopy Settings">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>maven.jalopy.fileFormat</td>
<td>Yes</td>
<td>
Sets the file format of the output files. The file format
controls what end of line character is used. Either one of
"UNIX", "DOS", MAC", "DEFAULT" or "AUTO" can be used. Defaults
to "AUTO" (case insensitive).
</td>
</tr>
<tr>
<td>maven.jalopy.style</td>
<td>Yes</td>
<td>
Sets the preferences file to use - given either relative to
the project's basedir or as an absolute local path or internet
address. If omitted, the current preferences are used, if available.
Otherwise the Jalopy build-in defaults will be used.
Defaults to "${plugin.dir}/jalopy_maven.xml".
</td>
</tr>
<tr>
<td>maven.jalopy.history</td>
<td>Yes</td>
<td>
Specifies the history policy to use. Either one of "COMMENT",
"FILE" or "NONE" can be used. Defaults to "none".
</td>
</tr>
<tr>
<td>maven.jalopy.logLevel</td>
<td>Yes</td>
<td>
Specifies the logging level for message output. Either one of
"ERROR", "WARN", "INFO" or "DEBUG" can be used.
Defaults to "info".
</td>
</tr>
<tr>
<td>maven.jalopy.nbThread</td>
<td>Yes</td>
<td>
Specifies the number of processing threads to use. Integer between 1 - 8.
Defaults to "2".
</td>
</tr>
<tr>
<td>maven.jalopy.failOnError</td>
<td>Yes</td>
<td>
Indicates whether a run should be held if errors occured. Defaults to "true".
</td>
</tr>
<tr>
<td>maven.jalopy.filesetInclude</td>
<td>Yes</td>
<td>
Specifies a fileset source file to format. Defaults to <code>**/*.java</code>.
</td>
</tr>
<tr>
<td>maven.jalopy.filesetExclude</td>
<td>Yes</td>
<td>
Source files excluded from format. Default: empty.
</td>
</tr>
<tr>
<td>maven.jalopy.src.filesetInclude</td>
<td>Yes</td>
<td>
For <code>src/java</code> directory. Specifies a fileset source file to format.
This is a comma- or space-separated list of patterns of files.
Defaults to <code>${maven.jalopy.filesetInclude}</code>.
</td>
</tr>
<tr>
<td>maven.jalopy.src.filesetExclude</td>
<td>Yes</td>
<td>
For <code>src/java</code> direcotry. Source files excluded from format.
This is a comma- or space-separated list of patterns of files.
Defaults to <code>${maven.jalopy.filesetExclude}</code>.
</td>
</tr>
<tr>
<td>maven.jalopy.test.filesetInclude</td>
<td>Yes</td>
<td>
For <code>src/test</code> directory. Specifies a fileset source file to format.
This is a comma- or space-separated list of patterns of files.
Defaults to <code>${maven.jalopy.filesetInclude}</code>.
</td>
</tr>
<tr>
<td>maven.jalopy.test.filesetExclude</td>
<td>Yes</td>
<td>
For <code>src/test</code> direcotry. Source files excluded from format.
This is a comma- or space-separated list of patterns of files.
Defaults to <code>${maven.jalopy.filesetExclude}</code>.
</td>
</tr>
</table>
</section>
</body>
</document>