diff options
| author | Benoit Lamarche <benoitlamarche@google.com> | 2014-06-25 11:16:16 +0200 |
|---|---|---|
| committer | Benoit Lamarche <benoitlamarche@google.com> | 2014-06-25 11:16:16 +0200 |
| commit | dfd9c10ca16d5b6e72629cd60982e9d75ca9ac32 (patch) | |
| tree | 3536ef3a8166dc7dabf85ba27e4637ee6c40e151 /jill | |
| parent | c57830cfd8d39694e23250bfd0f6341922dfb66d (diff) | |
| download | toolchain_jill-dfd9c10ca16d5b6e72629cd60982e9d75ca9ac32.tar.gz toolchain_jill-dfd9c10ca16d5b6e72629cd60982e9d75ca9ac32.tar.bz2 toolchain_jill-dfd9c10ca16d5b6e72629cd60982e9d75ca9ac32.zip | |
Add javadoc check to Checkstyle
Change-Id: I940f2da8ea13420e08d163f67be8b84d00ca8e18
Diffstat (limited to 'jill')
| -rw-r--r-- | jill/jillstyle.xml | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/jill/jillstyle.xml b/jill/jillstyle.xml index 59286c8..3940973 100644 --- a/jill/jillstyle.xml +++ b/jill/jillstyle.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 --> |