summaryrefslogtreecommitdiffstats
path: root/checkstyle
diff options
context:
space:
mode:
authorliamfallon <liam.fallon@est.tech>2019-12-09 16:20:24 +0000
committerliamfallon <liam.fallon@est.tech>2019-12-09 16:20:27 +0000
commitb080421073ed777fa4246a7a9d419bbc748741f2 (patch)
tree098dfc6ea01f799a89b3d7a181beefed1af8175f /checkstyle
parent5a4892d3f1842b80ac5d28f035a6d1e151b9897d (diff)
Update checkstyle rules to exclude methods
Checkstyle rules updated to: 1) allow getters and setters not to have javadoc 2) allow methods with less than 2 lines to not have javadoc 3) allow protected and private methods not to have javadoc 4) allow methods with names beginning with test|before|after not to have javaodc Issue-ID: INT-1395 Change-Id: I570cd90034c7b20d45a7e5a6ecacacdef80876a1 Signed-off-by: liamfallon <liam.fallon@est.tech>
Diffstat (limited to 'checkstyle')
-rw-r--r--checkstyle/src/main/resources/onap-checkstyle/onap-java-style.xml3
1 files changed, 3 insertions, 0 deletions
diff --git a/checkstyle/src/main/resources/onap-checkstyle/onap-java-style.xml b/checkstyle/src/main/resources/onap-checkstyle/onap-java-style.xml
index e6b249d..de1316f 100644
--- a/checkstyle/src/main/resources/onap-checkstyle/onap-java-style.xml
+++ b/checkstyle/src/main/resources/onap-checkstyle/onap-java-style.xml
@@ -205,7 +205,10 @@
<property name="allowThrowsTagsForSubclasses" value="true"/>
</module>
<module name="MissingJavadocMethod">
+ <property name="scope" value="public"/>
<property name="minLineCount" value="2"/>
+ <property name="allowMissingPropertyJavadoc" value="true"/>
+ <property name="ignoreMethodNamesRegex" value="^(test|before|after)[a-zA-Z0-9_]*$"/>
</module>
<module name="MethodName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>