diff options
| author | Benoit Lamarche <benoitlamarche@google.com> | 2014-06-25 09:21:19 +0000 |
|---|---|---|
| committer | Android (Google) Code Review <android-gerrit@google.com> | 2014-06-24 06:38:28 +0000 |
| commit | 3872ebe60e94cb1e671fa4d2ae7715f76626f44d (patch) | |
| tree | 37363b45d0a5c887d4aab87d8bb4851a6671d1f5 | |
| parent | 06f824afadee15e94b4192e6bf75868b104cc56b (diff) | |
| parent | dfd9c10ca16d5b6e72629cd60982e9d75ca9ac32 (diff) | |
| download | toolchain_jill-3872ebe60e94cb1e671fa4d2ae7715f76626f44d.zip toolchain_jill-3872ebe60e94cb1e671fa4d2ae7715f76626f44d.tar.gz toolchain_jill-3872ebe60e94cb1e671fa4d2ae7715f76626f44d.tar.bz2 | |
Merge "Add javadoc check to Checkstyle" into jack-wip-dev
| -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 --> |