fixes for linkcheck violations
This commit is contained in:
Roman Ivanov
parent
6b3adb0a75
commit
e8756de8ec
37
pom.xml
37
pom.xml
|
|
@ -486,10 +486,22 @@
|
|||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-linkcheck-plugin</artifactId>
|
||||
<version>1.1</version>
|
||||
<version>1.2</version>
|
||||
<configuration>
|
||||
<excludedLinks>**/apidocs/*</excludedLinks>
|
||||
<excludedHttpStatusErrors>401</excludedHttpStatusErrors>
|
||||
<excludedPages>
|
||||
<excludedPage>dependencies.html</excludedPage>
|
||||
</excludedPages>
|
||||
<excludedLinks>
|
||||
<excludedLink>**apidocs/*</excludedLink>
|
||||
<excludedLink>reports/google-style/guava</excludedLink>
|
||||
<excludedLink>reports/javadoc/openjdk8</excludedLink>
|
||||
<excludedLink>https://travis-ci.org/checkstyle/checkstyle</excludedLink>
|
||||
<excludedLink>https://coveralls.io/r/checkstyle/checkstyle</excludedLink>
|
||||
<excludedLink>http://search.maven.org/*</excludedLink>
|
||||
</excludedLinks>
|
||||
<excludedHttpStatusErrors>
|
||||
<excludedHttpStatusError>401</excludedHttpStatusError>
|
||||
</excludedHttpStatusErrors>
|
||||
</configuration>
|
||||
</plugin>
|
||||
|
||||
|
|
@ -538,12 +550,23 @@
|
|||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-linkcheck-plugin</artifactId>
|
||||
<version>1.1</version>
|
||||
<!--
|
||||
<version>1.2</version>
|
||||
<configuration>
|
||||
<excludedLinks>**/apidocs/*</excludedLinks>
|
||||
<excludedPages>
|
||||
<excludedPage>dependencies.html</excludedPage>
|
||||
</excludedPages>
|
||||
<excludedLinks>
|
||||
<excludedLink>**apidocs/*</excludedLink>
|
||||
<excludedLink>reports/google-style/guava</excludedLink>
|
||||
<excludedLink>reports/javadoc/openjdk8</excludedLink>
|
||||
<excludedLink>https://travis-ci.org/checkstyle/checkstyle</excludedLink>
|
||||
<excludedLink>https://coveralls.io/r/checkstyle/checkstyle</excludedLink>
|
||||
<excludedLink>http://search.maven.org/*</excludedLink>
|
||||
</excludedLinks>
|
||||
<excludedHttpStatusErrors>
|
||||
<excludedHttpStatusError>401</excludedHttpStatusError>
|
||||
</excludedHttpStatusErrors>
|
||||
</configuration>
|
||||
-->
|
||||
</plugin>
|
||||
|
||||
</plugins>
|
||||
|
|
|
|||
|
|
@ -90,14 +90,14 @@
|
|||
<td>The number of other classes a given class relies on.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="config_naming.html#ClassTypeParameterName">ClassTypeParameterName</a></td>
|
||||
<td><a href="config_naming.html#Modules">ClassTypeParameterName</a></td>
|
||||
<td>
|
||||
Checks that class type parameter names conform to a format
|
||||
specified by the format property.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="config_naming.html#ConstantName">ConstantName</a></td>
|
||||
<td><a href="config_naming.html#Modules">ConstantName</a></td>
|
||||
<td>Checks that constant names conform to a format specified by the format property.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -310,7 +310,7 @@
|
|||
Use Interfaces only to define types.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="config_naming.html#InterfaceTypeParameterName">InterfaceTypeParameterName</a></td>
|
||||
<td><a href="config_naming.html#Modules">InterfaceTypeParameterName</a></td>
|
||||
<td>
|
||||
Checks that interface type parameter names conform to a format specified
|
||||
by the format property.</td>
|
||||
|
|
@ -365,7 +365,7 @@
|
|||
<td>Checks for long lines.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="config_naming.html#LocalFinalVariableName">LocalFinalVariableName</a></td>
|
||||
<td><a href="config_naming.html#Modules">LocalFinalVariableName</a></td>
|
||||
<td>
|
||||
Checks that local final variable names conform to a format specified
|
||||
by the format property.</td>
|
||||
|
|
@ -382,7 +382,7 @@
|
|||
Checks for magic numbers.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="config_naming.html#MemberName">MemberName</a></td>
|
||||
<td><a href="config_naming.html#Modules">MemberName</a></td>
|
||||
<td>
|
||||
Checks that instance variable names conform to a format specified
|
||||
by the format property.</td>
|
||||
|
|
@ -410,7 +410,7 @@
|
|||
and the left parenthesis of the parameter list.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="config_naming.html#MethodTypeParameterName">MethodTypeParameterName</a></td>
|
||||
<td><a href="config_naming.html#Modules">MethodTypeParameterName</a></td>
|
||||
<td>
|
||||
Checks that class type parameter names conform to a format specified
|
||||
by the format property.</td>
|
||||
|
|
@ -554,7 +554,7 @@
|
|||
<td>Ensures there is a package declaration and (optionally) in the correct directory.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="config_naming.html#PackageName">PackageName</a></td>
|
||||
<td><a href="config_naming.html#Modules">PackageName</a></td>
|
||||
<td>
|
||||
Checks that package names conform to a format specified
|
||||
by the format property.</td>
|
||||
|
|
@ -565,7 +565,7 @@
|
|||
Disallow assignment of parameters.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="config_naming.html#ParameterName">ParameterName</a></td>
|
||||
<td><a href="config_naming.html#Modules">ParameterName</a></td>
|
||||
<td>
|
||||
Checks that parameter names conform to a format specified
|
||||
by the format property.</td>
|
||||
|
|
@ -655,7 +655,7 @@
|
|||
Checks for overly complicated boolean return statements.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="config_naming.html#StaticVariableName">StaticVariableName</a></td>
|
||||
<td><a href="config_naming.html#Modules">StaticVariableName</a></td>
|
||||
<td>
|
||||
Checks that static, non-final variable names conform to a format specified
|
||||
by the format property.</td>
|
||||
|
|
|
|||
|
|
@ -102,7 +102,7 @@ String b = (a==null || a.length<1) ? null : a.substring(1);
|
|||
<subsection name="Description">
|
||||
<p>
|
||||
Checks that classes that define a covariant <code>equals()</code> method also override method <code>equals(java.lang.Object)</code>. Inspired by <a
|
||||
href="http://www.cs.umd.edu/~pugh/java/bugs/docs/findbugsPaper.pdf">findbugs</a>.
|
||||
href="http://www.cs.nyu.edu/~lharris/papers/findbugsPaper.pdf">findbugs</a>.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
|
@ -1450,7 +1450,7 @@ if ("something".equals(x))
|
|||
|
||||
<p>
|
||||
Reference: <a
|
||||
href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#clone()">Object.clone()</a>.
|
||||
href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html#clone%28%29">Object.clone()</a>.
|
||||
</p>
|
||||
</subsection>
|
||||
|
||||
|
|
@ -1485,8 +1485,8 @@ if ("something".equals(x))
|
|||
|
||||
<p>
|
||||
Reference: <a
|
||||
href="http://java.sun.com/docs/books/tutorial/java/data/garbagecollection.html">Cleaning
|
||||
Up Unused Objects</a>.
|
||||
href="http://www.oracle.com/technetwork/java/javamail/finalization-137655.html">
|
||||
Use Finalization Only When You Must</a>.
|
||||
</p>
|
||||
</subsection>
|
||||
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@
|
|||
whether to allow starred class imports like
|
||||
<code>import java.util.*;</code>.
|
||||
</td>
|
||||
<td><a href="property_types.html#Boolean">Boolean</a></td>
|
||||
<td><a href="property_types.html#boolean">Boolean</a></td>
|
||||
<td><code>false</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -57,7 +57,7 @@
|
|||
whether to allow starred static member imports like
|
||||
<code>import static org.junit.Assert.*;</code>
|
||||
</td>
|
||||
<td><a href="property_types.html#Boolean">Boolean</a></td>
|
||||
<td><a href="property_types.html#boolean">Boolean</a></td>
|
||||
<td><code>false</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -97,7 +97,7 @@
|
|||
<p>
|
||||
A check for <code>TODO:</code> comments. Actually
|
||||
it is a generic <a
|
||||
href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html">regular
|
||||
href="https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html">regular
|
||||
expression</a> matcher on Java comments. To check for other
|
||||
patterns in Java comments, set the <code>format</code> property.
|
||||
</p>
|
||||
|
|
@ -1012,7 +1012,7 @@ d = e / f; // Another comment for this line
|
|||
<b>Note:</b> Not all regular expression engines are created equal. Some provide extra
|
||||
functions that others do not and some elements of the syntax may vary.
|
||||
This check makes use of the <a
|
||||
href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/package-summary.html">
|
||||
href="https://docs.oracle.com/javase/7/docs/api/java/util/regex/package-summary.html">
|
||||
java.util.regex package</a>; please check its documentation for
|
||||
details of how to construct a regular expression to achieve a particular
|
||||
goal.
|
||||
|
|
@ -1197,7 +1197,7 @@ d = e / f; // Another comment for this line
|
|||
</source>
|
||||
<p>
|
||||
<b>To use like <a
|
||||
href="config_misc.html#RegexpHeader">RegexpHeader
|
||||
href="config_header.html#RegexpHeader">RegexpHeader
|
||||
</a>:</b>
|
||||
</p>
|
||||
<p>
|
||||
|
|
|
|||
|
|
@ -44,17 +44,17 @@
|
|||
<th>default value of <code>format</code></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code id="AbstractClassName">AbstractClassName</code></td>
|
||||
<td><code>AbstractClassName</code></td>
|
||||
<td><code>abstract</code> classes</td>
|
||||
<td><code>^Abstract.*$|^.*Factory$</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code id="ClassTypeParameterName">ClassTypeParameterName</code></td>
|
||||
<td><code>ClassTypeParameterName</code></td>
|
||||
<td>class type parameters</td>
|
||||
<td><code>^[A-Z]$</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code id="ConstantName">ConstantName</code></td>
|
||||
<td><code>ConstantName</code></td>
|
||||
<td>
|
||||
constants (<code>static</code>, <code>
|
||||
final</code> fields)
|
||||
|
|
@ -62,13 +62,13 @@
|
|||
<td><code>^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code id="LocalFinalVariableName">LocalFinalVariableName</code></td>
|
||||
<td><code>LocalFinalVariableName</code></td>
|
||||
<td>local, <code>final</code> variables, including
|
||||
<code>catch</code> parameters</td>
|
||||
<td><code>^[a-z][a-zA-Z0-9]*$</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code id="LocalVariableName">LocalVariableName</code></td>
|
||||
<td><code>LocalVariableName</code></td>
|
||||
<td>
|
||||
local, non-<code>final</code> variables, including
|
||||
<code>catch</code> parameters
|
||||
|
|
@ -76,46 +76,46 @@
|
|||
<td><code>^[a-z][a-zA-Z0-9]*$</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code id="MemberName">MemberName</code></td>
|
||||
<td><code>MemberName</code></td>
|
||||
<td>non-<code>static</code> fields</td>
|
||||
<td><code>^[a-z][a-zA-Z0-9]*$</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code id="MethodName">MethodName</code></td>
|
||||
<td><code>MethodName</code></td>
|
||||
<td>methods</td>
|
||||
<td><code>^[a-z][a-zA-Z0-9]*$</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code id="MethodTypeParameterName">MethodTypeParameterName</code></td>
|
||||
<td><code>MethodTypeParameterName</code></td>
|
||||
<td>method type parameters</td>
|
||||
<td><code>^[A-Z]$</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code id="InterfaceTypeParameterName">InterfaceTypeParameterName</code></td>
|
||||
<td><code>InterfaceTypeParameterName</code></td>
|
||||
<td>interface type parameters</td>
|
||||
<td><code>^[A-Z]$</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code id="PackageName">PackageName</code></td>
|
||||
<td><code>PackageName</code></td>
|
||||
<td>packages</td>
|
||||
<td>
|
||||
<code>^[a-z]+(\.[a-zA-Z_][a-zA-Z0-9_]*)*$</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code id="ParameterName">ParameterName</code></td>
|
||||
<td><code>ParameterName</code></td>
|
||||
<td>parameters</td>
|
||||
<td><code>^[a-z][a-zA-Z0-9]*$</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code id="StaticVariableName">StaticVariableName</code></td>
|
||||
<td><code>StaticVariableName</code></td>
|
||||
<td>
|
||||
<code>static</code>, non-<code>final</code> fields
|
||||
</td>
|
||||
<td><code>^[a-z][a-zA-Z0-9]*$</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code id="TypeName">TypeName</code></td>
|
||||
<td><code>TypeName</code></td>
|
||||
<td>classes, interfaces, enums, and annotations</td>
|
||||
<td><code>^[A-Z][a-zA-Z0-9]*$</code></td>
|
||||
</tr>
|
||||
|
|
@ -371,7 +371,7 @@ class MyClass {
|
|||
<td>allowedAbbreviations</td>
|
||||
<td>list of abbreviations that must be skipped for checking.
|
||||
Abbreviations should be separated by comma, no spaces are allowed.</td>
|
||||
<td><a href="property_types.html#StringSet">stringSet</a></td>
|
||||
<td><a href="property_types.html#stringSet">stringSet</a></td>
|
||||
<td>null</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
|
|||
|
|
@ -776,8 +776,8 @@
|
|||
<li><a href="config_coding.html#NoFinalizer">NoFinalizer</a></li>
|
||||
<li><a href="config_imports.html#AvoidStaticImport">AvoidStaticImport</a></li>
|
||||
<li><a href="config_javadoc.html#JavadocPackage">JavadocPackage</a></li>
|
||||
<li><a href="config_naming.html#ClassTypeParameterName">ClassTypeParameterName</a></li>
|
||||
<li><a href="config_naming.html#MethodTypeParameterName">MethodTypeParameterName</a></li>
|
||||
<li><a href="config_naming.html#Modules">ClassTypeParameterName</a></li>
|
||||
<li><a href="config_naming.html#Modules">MethodTypeParameterName</a></li>
|
||||
<li><a href="config_regexp.html#RegexpMultiline">RegexpMultiline</a></li>
|
||||
<li><a href="config_regexp.html#RegexpSingleline">RegexpSingleline</a></li>
|
||||
<li><a href="config_regexp.html#RegexpSinglelineJava">RegexpSinglelineJava</a></li>
|
||||
|
|
@ -917,7 +917,7 @@
|
|||
</li>
|
||||
<li>
|
||||
Add new options to the <a
|
||||
href="config_sizes.html#ImportOrder">ImportOrderCheck</a>
|
||||
href="config_imports.html#ImportOrder">ImportOrderCheck</a>
|
||||
to make it more flexible. Thanks to David Didier for providing
|
||||
patch #1854213.
|
||||
</li>
|
||||
|
|
@ -1058,9 +1058,9 @@
|
|||
Schneeberger for providing patch #1947417.
|
||||
</li>
|
||||
<li>
|
||||
New checks <a href="config_naming.html#ClassTypeParameterName">
|
||||
New checks <a href="config_naming.html#Modules">
|
||||
ClassTypeParameterName</a> and
|
||||
<a href="config_naming.html#MethodTypeParameterName">
|
||||
<a href="config_naming.html#Modules">
|
||||
MethodTypeParameterName</a>
|
||||
for type name formats. Thanks to Travis Schneeberger for providing
|
||||
patch #1956561.
|
||||
|
|
|
|||
Loading…
Reference in New Issue