X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=utils%2Fcheckstyle%2Fcheckstyle.xml;h=17946f781e29b0d9ffdd2d5eeb1b9923b022a88e;hb=4bbd068738ed2e685f580ea1b65a7b11e32d3f3e;hp=7ca2d26276d543e4640892e918d576bbd481d5ca;hpb=78d4775e4450ba6579c5d9824a78ad99cbccda22;p=jalview.git

diff --git a/utils/checkstyle/checkstyle.xml b/utils/checkstyle/checkstyle.xml
index 7ca2d26..17946f7 100644
--- a/utils/checkstyle/checkstyle.xml
+++ b/utils/checkstyle/checkstyle.xml
@@ -16,26 +16,6 @@
 	</module>
 
 	<!-- 
-		Allow suppression of rules by comments, e.g.:
-		// CHECKSTYLE.OFF: ParameterNumber
-		..method declaration
-		// CHECKSTYLE.ON: ParameterNumber
-	-->
-	<module name="SuppressionCommentFilter">
-		<property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)"/>
-		<property name="onCommentFormat" value="CHECKSTYLE.ON\: ([\w\|]+)"/>
-		<property name="checkFormat" value="$1"/>
-	</module>
-
-	<!--
-		Maximum line count for source files
-	-->
-	<module name="FileLength">
-		<property name="max" value="1200"/>
-		<property name="fileExtensions" value="java"/>
-	</module>
-
-	<!-- 
 		Check language bundles have the same keys and no duplicates
 		(ensure Checkstyle is configured to scan non-source files)
 	 -->
@@ -47,16 +27,31 @@
 	    <property name="fileExtensions" value="properties" />
 		<property name="severity" value="error"/>
 	</module>
+
+	<!--
+		Maximum line count for source files
+		(note this can't be inside TreeWalker)
+	-->
+	<module name="FileLength">
+		<property name="max" value="1200"/>
+		<property name="fileExtensions" value="java"/>
+	</module>
 	
 	<module name="TreeWalker">
 
 		<property name="tabWidth" value="4"/>
 
 		<!-- 
-			Enables parsing of suppressions comments
-			see http://checkstyle.sourceforge.net/config_filters.html#SuppressionCommentFilter 
+			Allow suppression of rules by comments, e.g.:
+			// CHECKSTYLE.OFF: ParameterNumber
+			..method declaration
+			// CHECKSTYLE.ON: ParameterNumber
 		-->
-		<module name="FileContentsHolder"/>
+		<module name="SuppressionCommentFilter">
+			<property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)"/>
+			<property name="onCommentFormat" value="CHECKSTYLE.ON\: ([\w\|]+)"/>
+			<property name="checkFormat" value="$1"/>
+		</module>
 
 	<!-- ****************************** -->
 	<!--         NAMING STANDARDS       -->
@@ -429,12 +424,20 @@
 		<module name="HiddenField"/> 
 
 		<!-- 
-			Check that proper logging is used and never printing to System.out.
+			Check that proper logging is used.
 			This may be suppressed in the class that provides logging functions.
 		-->
 		<module name="RegexpSinglelineJava">
+			<property name="id" value="NoSysout" />
 			<property name="format" value="System\.out\.println"/>
 			<property name="ignoreComments" value="true"/>
+			<message key="regexp.exceeded" value="Should use jalview.bin.Cache.log for logging"/>
+		</module>
+		<module name="RegexpSinglelineJava">
+			<property name="id" value="NoSyserr" />
+			<property name="format" value="System\.err\.println"/>
+			<property name="ignoreComments" value="true"/>
+			<message key="regexp.exceeded" value="Should use jalview.bin.Cache.log for logging"/>
 		</module>
 
 		<!--
@@ -585,7 +588,13 @@
 			Check for TODO and similar comments 
 	 	-->
 		<module name="TodoComment">
-			<property name="format" value="(TODO)|(FIXME)|(DOCUMENT ME)"/>
+			<property name="format" value="(TODO)|(FIXME)"/>
+			<message key="todo.match" value="TODO or FIXME comment"/>
+		</module>
+
+		<module name="TodoComment">
+			<property name="format" value="DOCUMENT ME"/>
+			<message key="todo.match" value="Documentation incomplete"/>
 		</module>
 
 	</module>