You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2012/02/25 17:23:57 UTC
svn commit: r1293636 -
/maven/doxia/doxia/trunk/src/main/resources/config/doxia_checkstyle.xml
Author: dennisl
Date: Sat Feb 25 16:23:56 2012
New Revision: 1293636
URL: http://svn.apache.org/viewvc?rev=1293636&view=rev
Log:
[DOXIA-457] Upgrade Doxia's checkstyle to version 5.x, and make it immediately useable within IDEs
o Upgraded to Checkstyle 5 syntax
o This file is however not currently used by the Doxia build
Modified:
maven/doxia/doxia/trunk/src/main/resources/config/doxia_checkstyle.xml
Modified: maven/doxia/doxia/trunk/src/main/resources/config/doxia_checkstyle.xml
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/src/main/resources/config/doxia_checkstyle.xml?rev=1293636&r1=1293635&r2=1293636&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/src/main/resources/config/doxia_checkstyle.xml (original)
+++ maven/doxia/doxia/trunk/src/main/resources/config/doxia_checkstyle.xml Sat Feb 25 16:23:56 2012
@@ -28,9 +28,11 @@ under the License.
<module name="Checker">
- <!-- Checks that a package.html file exists for each package. -->
- <!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->
- <!-- module name="PackageHtml"/ -->
+ <!-- Checks that each Java package has a Javadoc file used for commenting. -->
+ <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
+ <!-- module name="JavadocPackage">
+ <property name="allowLegacy" value="true"/>
+ </module-->
<!-- Checks whether files end with a new line. -->
<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
@@ -40,6 +42,24 @@ under the License.
<!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
<!-- module name="Translation"/ -->
+ <module name="FileLength"/>
+
+ <!-- Checks for Headers -->
+ <!-- See http://checkstyle.sf.net/config_header.html -->
+ <module name="RegexpHeader">
+ <property name="headerFile" value="${checkstyle.header.file}"/>
+ </module>
+
+ <module name="FileTabCharacter">
+ <property name="eachLine" value="true"/>
+ </module>
+
+ <!-- Line with trailing spaces -->
+ <module name="RegexpSingleline">
+ <property name="format" value="\s+$"/>
+ <property name="message" value="Line has trailing spaces."/>
+ </module>
+
<module name="TreeWalker">
<property name="cacheFile" value="${checkstyle.cache.file}"/>
@@ -67,7 +87,10 @@ under the License.
<property name="severity" value="warning"/>
<property name="scope" value="protected"/>
</module>
- <module name="JavadocType"/>
+ <module name="JavadocType">
+ <property name="scope" value="protected"/>
+ <property name="allowUnknownTags" value="true" />
+ </module>
<module name="JavadocVariable">
<property name="severity" value="info"/>
<property name="scope" value="protected"/>
@@ -79,7 +102,6 @@ under the License.
<module name="ConstantName"/>
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
- <!-- <module name="MethodName"/> -->
<module name="MethodName">
<property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
</module>
@@ -88,13 +110,6 @@ under the License.
<module name="StaticVariableName"/>
<module name="TypeName"/>
-
- <!-- Checks for Headers -->
- <!-- See http://checkstyle.sf.net/config_header.html -->
- <module name="RegexpHeader">
- <property name="headerFile" value="${checkstyle.header.file}"/>
- </module>
-
<!-- Checks for imports -->
<!-- See http://checkstyle.sf.net/config_import.html -->
<module name="AvoidStarImport"/>
@@ -105,7 +120,6 @@ under the License.
<!-- Checks for Size Violations. -->
<!-- See http://checkstyle.sf.net/config_sizes.html -->
- <module name="FileLength"/>
<module name="MethodLength"/>
<module name="ParameterNumber"/>
@@ -121,7 +135,6 @@ under the License.
<module name="ParenPad">
<property name="option" value="space" />
</module>
- <module name="TabCharacter"/>
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround"/>
<!-- module name="MethodParamPad"/ -->
@@ -169,20 +182,16 @@ under the License.
<!-- module name="DesignForExtension"/ -->
<!-- module name="FinalClass"/ -->
<!-- module name="HideUtilityClassConstructor"/ -->
- <!-- <module name="InterfaceIsType"/> -->
+ <!-- module name="InterfaceIsType"/ -->
<module name="VisibilityModifier">
<property name="protectedAllowed" value="true"/>
+ <property name="packageAllowed" value="true"/>
</module>
<!-- Miscellaneous other checks. -->
<!-- See http://checkstyle.sf.net/config_misc.html -->
<!-- module name="ArrayTypeStyle"/ -->
<!-- module name="FinalParameters"/ -->
- <!-- Line with Trailing Spaces -->
- <module name="GenericIllegalRegexp">
- <property name="format" value="\s+$"/>
- <property name="message" value="Line has trailing spaces."/>
- </module>
<!-- Let todo plugin handle this.
<module name="TodoComment"/>
-->