From d82ef2337e24639a6a09928764c0dd842dec7add Mon Sep 17 00:00:00 2001
From: Paul Campbell <pcampbell@kemitix.net>
Date: Mon, 5 Sep 2016 07:22:33 +0100
Subject: [PATCH] JavadocMethod: require on protected and package

Also:
* warn about unused @throws tags
* skip basic setters and getters
---
 README.md                                     | 8 +-------
 src/main/resources/net/kemitix/checkstyle.xml | 4 +++-
 2 files changed, 4 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 63b4aeb..3a9db02 100644
--- a/README.md
+++ b/README.md
@@ -1229,13 +1229,7 @@ interface Foo {
 
 #### [JavadocMethod](http://checkstyle.sourceforge.net/config_javadoc.html#JavadocMethod)
 
-Checks that all public methods have a Javadoc block.
-
-> TODO: scope = private (reset to default) - will require lots of new javadoc blocks
-
-> TODO: validateThrows = true
-
-> TODO: allowMissingPropertyJavadoc = true
+Checks that all public, protected and package methods have a Javadoc block, that all `@throws` tags are used. Basic setters and getters do not require javadoc.
 
 #### [JavadocPackage](http://checkstyle.sourceforge.net/config_javadoc.html#JavadocPackage)
 
diff --git a/src/main/resources/net/kemitix/checkstyle.xml b/src/main/resources/net/kemitix/checkstyle.xml
index 7732808..33329a8 100644
--- a/src/main/resources/net/kemitix/checkstyle.xml
+++ b/src/main/resources/net/kemitix/checkstyle.xml
@@ -98,7 +98,9 @@
         <module name="InterfaceIsType"/> <!-- interface must define method not just constants -->
 
         <module name="JavadocMethod"> <!-- methods should have javadoc block -->
-            <property name="scope" value="public"/> <!-- if they are public -->
+            <property name="scope" value="package"/> <!-- if they are public, protected or package -->
+            <property name="validateThrows" value="true"/> <!-- warn about unused @throws tags -->
+            <property name="allowMissingPropertyJavadoc" value="true"/> <!-- skip basic setters and getters -->
         </module>
         <module name="JavadocParagraph"/> <!-- javadoc paragraphs have opening <p> elements -->
         <module name="JavadocStyle"/> <!-- javadoc comments are well formed -->