Merge "Refine Checkstyle rules: optional JavaDoc on c'str & getter/setter"

[odlparent.git] / checkstyle / src / main / resources / odl_checks.xml

diff --git a/checkstyle/src/main/resources/odl_checks.xml b/checkstyle/src/main/resources/odl_checks.xml
index abbc022cc8744114ee19ff5a9b83630f6f1da197..56608259fd4a4e42071bcec516052f0d311cb6e2 100644 (file)
--- a/checkstyle/src/main/resources/odl_checks.xml
+++ b/checkstyle/src/main/resources/odl_checks.xml
@@ -5,7 +5,7 @@
 
 <!--
 
-    Checkstyle configuration that checks the Google coding conventions from:
+    ODL Checkstyle configuration, originally based on the the Google coding conventions from:
 
     -  Google Java Style
        https://google-styleguide.googlecode.com/svn-history/r130/trunk/javaguide.html
@@ -151,7 +151,7 @@
         </module>
         <module name="AbbreviationAsWordInName">
             <property name="ignoreFinal" value="false"/>
-            <property name="allowedAbbreviationLength" value="1"/>
+            <property name="allowedAbbreviationLength" value="3"/>
         </module>
         <module name="OverloadMethodsDeclarationOrder"/>
         <module name="VariableDeclarationUsageDistance"/>
@@ -185,6 +185,8 @@
         </module>
         <module name="JavadocMethod">
             <property name="scope" value="public"/>
+            <property name="tokens" value="METHOD_DEF"/> <!-- JavaDoc on constructors is optional -->
+            <property name="allowMissingPropertyJavadoc" value="true" /> <!-- JavaDoc on STRICT (!) getters and setters is optional -->
             <property name="allowMissingParamTags" value="true"/>
             <property name="allowMissingThrowsTags" value="true"/>
             <property name="allowMissingReturnTag" value="true"/>