diff options
| -rw-r--r-- | dexcomparator/jackstyle.xml | 19 | ||||
| -rw-r--r-- | dx/jackstyle.xml | 19 | ||||
| -rw-r--r-- | jack/jackstyle.xml | 19 | ||||
| -rw-r--r-- | sched/jackstyle.xml | 19 |
4 files changed, 76 insertions, 0 deletions
diff --git a/dexcomparator/jackstyle.xml b/dexcomparator/jackstyle.xml index 76fa6e9..cb4bf0b 100644 --- a/dexcomparator/jackstyle.xml +++ b/dexcomparator/jackstyle.xml @@ -75,6 +75,25 @@ by Joshua Bloch in his book Effective Java --> <!-- + JAVADOC CHECKS + + --> + + <module name="JavadocType"> + <!-- Item 28 - Write doc comments for all exposed API elements. --> + <!-- Ensure all classes with visability greater than or equal to + protected have class level documentation. --> + <property name="scope" value="protected"/> + <property name="severity" value="error"/> + <!-- Style guide doesn't prohibit custom tags. Typos will be caught by other tools. --> + <property name="allowUnknownTags" value="true"/> + <property name="allowMissingParamTags" value="true"/> + <message key="javadoc.missing" + value="Missing a Javadoc comment."/> + </module> + + <!-- + NAMING CHECKS --> diff --git a/dx/jackstyle.xml b/dx/jackstyle.xml index 59286c8..3940973 100644 --- a/dx/jackstyle.xml +++ b/dx/jackstyle.xml @@ -75,6 +75,25 @@ by Joshua Bloch in his book Effective Java --> <!-- + JAVADOC CHECKS + + --> + + <module name="JavadocType"> + <!-- Item 28 - Write doc comments for all exposed API elements. --> + <!-- Ensure all classes with visability greater than or equal to + protected have class level documentation. --> + <property name="scope" value="protected"/> + <property name="severity" value="error"/> + <!-- Style guide doesn't prohibit custom tags. Typos will be caught by other tools. --> + <property name="allowUnknownTags" value="true"/> + <property name="allowMissingParamTags" value="true"/> + <message key="javadoc.missing" + value="Missing a Javadoc comment."/> + </module> + + <!-- + NAMING CHECKS --> diff --git a/jack/jackstyle.xml b/jack/jackstyle.xml index 59286c8..3940973 100644 --- a/jack/jackstyle.xml +++ b/jack/jackstyle.xml @@ -75,6 +75,25 @@ by Joshua Bloch in his book Effective Java --> <!-- + JAVADOC CHECKS + + --> + + <module name="JavadocType"> + <!-- Item 28 - Write doc comments for all exposed API elements. --> + <!-- Ensure all classes with visability greater than or equal to + protected have class level documentation. --> + <property name="scope" value="protected"/> + <property name="severity" value="error"/> + <!-- Style guide doesn't prohibit custom tags. Typos will be caught by other tools. --> + <property name="allowUnknownTags" value="true"/> + <property name="allowMissingParamTags" value="true"/> + <message key="javadoc.missing" + value="Missing a Javadoc comment."/> + </module> + + <!-- + NAMING CHECKS --> diff --git a/sched/jackstyle.xml b/sched/jackstyle.xml index 59286c8..3940973 100644 --- a/sched/jackstyle.xml +++ b/sched/jackstyle.xml @@ -75,6 +75,25 @@ by Joshua Bloch in his book Effective Java --> <!-- + JAVADOC CHECKS + + --> + + <module name="JavadocType"> + <!-- Item 28 - Write doc comments for all exposed API elements. --> + <!-- Ensure all classes with visability greater than or equal to + protected have class level documentation. --> + <property name="scope" value="protected"/> + <property name="severity" value="error"/> + <!-- Style guide doesn't prohibit custom tags. Typos will be caught by other tools. --> + <property name="allowUnknownTags" value="true"/> + <property name="allowMissingParamTags" value="true"/> + <message key="javadoc.missing" + value="Missing a Javadoc comment."/> + </module> + + <!-- + NAMING CHECKS --> |