maven-plugins/linkcheck/xdocs/properties.xml
2004-07-26 16:16:35 +00:00

65 lines
2.0 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* 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>LinkCheck Plugin Properties</title>
</properties>
<body>
<section name="LinkCheck Plugin Properties">
<table>
<tr>
<th>Property</th>
<th>Optional?</th>
<th>Description</th>
</tr>
<tr>
<td>maven.linkcheck.cache</td>
<td>Yes</td>
<td>
Determines where the cache for the linkchecking is stored.
Default value is
<code>${maven.build.dir}/linkcheck/linkcheck.cache</code>.
This means that a clean build deletes the cache. If you have
an extremely large document tree this can have a negative effect
on performance.
</td>
</tr>
<tr>
<td>maven.linkcheck.failonerror</td>
<td>Yes</td>
<td>
Determines whether the build should fail on broken links or not.
Defaults to <code>false</code>.
</td>
</tr>
<tr>
<td>maven.linkcheck.exclude</td>
<td>Yes</td>
<td>
List of urls to exclude from check, delimited by comma, space or tab.
Those urls in files that start with one of the excluded urls will be ignored.
Defaults to <code>pom.repository.url</code>.
</td>
</tr>
</table>
</section>
</body>
</document>