mirror of
https://github.com/apache/commons-math.git
synced 2025-02-06 10:09:26 +00:00
beae2e9891
- pom's need to use ${basedir} for configuration files as the multi-module profile is run from commons-parent, so if not specified it can't find those files
- the checkstyle configuration file needs to use ${checkstyle.header.file} for the headerFile property and <headerFile> element added to the plugin config in the pom.xml
- fix m1 checkstyle config to reflect the above where appropriate (specify header file property)
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/branches/MATH_2_0@659441 13f79535-47bb-0310-9956-ffa450edef68
87 lines
3.0 KiB
XML
87 lines
3.0 KiB
XML
<?xml version="1.0"?>
|
|
|
|
<!--
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
this work for additional information regarding copyright ownership.
|
|
The ASF licenses this file to You 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.
|
|
-->
|
|
|
|
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.1//EN" "http://www.puppycrawl.com/dtds/configuration_1_1.dtd">
|
|
|
|
<!-- commons math customization of default Checkstyle behavior -->
|
|
<module name="Checker">
|
|
<property name="localeLanguage" value="en"/>
|
|
|
|
<module name="TreeWalker">
|
|
|
|
<!-- Verify that EVERY source file has the appropriate license -->
|
|
<module name="Header">
|
|
<property name="headerFile" value="${checkstyle.header.file}"/>
|
|
</module>
|
|
|
|
<!-- Operator must be at end of wrapped line -->
|
|
<module name="OperatorWrap">
|
|
<property name="option" value="eol"/>
|
|
</module>
|
|
|
|
<!-- Interfaces must be types (not just constants) -->
|
|
<module name="InterfaceIsType"/>
|
|
|
|
<!-- Must have class / interface header comments including scm version -->
|
|
<module name="JavadocType">
|
|
<property name="versionFormat" value="\$Revision.*\$ \$Date.*\$"/>
|
|
</module>
|
|
|
|
<!-- Require method javadocs, allow undeclared RTE -->
|
|
<module name="JavadocMethod">
|
|
<property name="allowUndeclaredRTE" value="true"/>
|
|
</module>
|
|
|
|
<!-- Require field javadoc -->
|
|
<module name="JavadocVariable"/>
|
|
|
|
<!-- No tabs allowed! -->
|
|
<module name="TabCharacter"/>
|
|
|
|
<!-- No public fields -->
|
|
<module name="VisibilityModifier">
|
|
<property name="protectedAllowed" value="true"/>
|
|
</module>
|
|
|
|
<!-- Require hash code override when equals is -->
|
|
<module name="EqualsHashCode"/>
|
|
|
|
<!-- Disallow unecessary instantiantion of Boolean, String -->
|
|
<module name="IllegalInstantiation">
|
|
<property name="classes" value="java.lang.Boolean, java.lang.String"/>
|
|
</module>
|
|
|
|
<!-- Required for SuppressionCommentFilter below -->
|
|
<module name="FileContentsHolder"/>
|
|
|
|
</module>
|
|
|
|
<!-- Require package javadoc -->
|
|
<module name="PackageHtml"/>
|
|
|
|
<!-- Setup special comments to suppress specific checks from source files -->
|
|
<module name="SuppressionCommentFilter">
|
|
<property name="offCommentFormat" value="CHECKSTYLE\: stop JavadocMethodCheck"/>
|
|
<property name="onCommentFormat" value="CHECKSTYLE\: resume JavadocMethodCheck"/>
|
|
<property name="checkFormat" value="JavadocMethodCheck"/>
|
|
</module>
|
|
|
|
</module>
|
|
|