mirror of
https://github.com/apache/commons-lang.git
synced 2025-02-06 01:58:24 +00:00
1f8479a84b
The defacto style of the project requires Javadoc for public methods only, but the checkstyle Javadoc check defaults to requiring them even for private methods, generating 46 errors. This patch sets the checkstyle Javadoc check's scope to public to clean up the checkstyle report so it can be enabled in the CI. If we wish to reset the check to a laxer scope, the aforementioned errors should be fixed first.
49 lines
1.9 KiB
XML
49 lines
1.9 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 lang customization of default Checkstyle behavior -->
|
|
<module name="Checker">
|
|
<property name="localeLanguage" value="en"/>
|
|
<module name="JavadocPackage">
|
|
<!-- setting allowLegacy means it will check for package.html instead of just package-info.java -->
|
|
<property name="allowLegacy" value="true"/>
|
|
</module>
|
|
<module name="FileTabCharacter">
|
|
<property name="fileExtensions" value="java,xml"/>
|
|
</module>
|
|
<module name="TreeWalker">
|
|
<property name="cacheFile" value="target/cachefile"/>
|
|
<module name="AvoidStarImport"/>
|
|
<module name="RedundantImport"/>
|
|
<module name="UnusedImports"/>
|
|
<module name="NeedBraces"/>
|
|
<module name="RedundantThrows">
|
|
<property name="allowUnchecked" value="true"/>
|
|
</module>
|
|
<module name="JavadocMethod">
|
|
<property name="allowUndeclaredRTE" value="true"/>
|
|
<property name="scope" value="public" />
|
|
</module>
|
|
<module name="UpperEll" />
|
|
</module>
|
|
</module>
|