diff options
| author | Benoit Lamarche <benoitlamarche@google.com> | 2014-06-25 11:15:08 +0200 |
|---|---|---|
| committer | Benoit Lamarche <benoitlamarche@google.com> | 2014-06-25 11:15:08 +0200 |
| commit | 23bfca15e21491af57ef9f24b9a44544bead8948 (patch) | |
| tree | 9694e2fe67126bb83e70618e6bcfcc9ddbd5dfab /dx | |
| parent | 9d2280a710ec51bd9eee80fe2a36a9c9a08af109 (diff) | |
| download | toolchain_jack-23bfca15e21491af57ef9f24b9a44544bead8948.zip toolchain_jack-23bfca15e21491af57ef9f24b9a44544bead8948.tar.gz toolchain_jack-23bfca15e21491af57ef9f24b9a44544bead8948.tar.bz2 | |
Add javadoc check to Checkstyle
Change-Id: I73353699430eff4d5d7a3abb42e62fe91f481a03
Diffstat (limited to 'dx')
| -rw-r--r-- | dx/jackstyle.xml | 19 |
1 files changed, 19 insertions, 0 deletions
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 --> |