Merge "Refine Checkstyle rules: optional JavaDoc on c'str & getter/setter"
authorRobert Varga <nite@hq.sk>
Tue, 17 May 2016 07:05:35 +0000 (07:05 +0000)
committerGerrit Code Review <gerrit@opendaylight.org>
Tue, 17 May 2016 07:05:35 +0000 (07:05 +0000)
checkstyle/src/main/resources/odl_checks.xml

index c44008b10baaa4c494e5d0fa0152073e4b272e45..56608259fd4a4e42071bcec516052f0d311cb6e2 100644 (file)
@@ -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
         </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"/>