From 23bfca15e21491af57ef9f24b9a44544bead8948 Mon Sep 17 00:00:00 2001
From: Benoit Lamarche <benoitlamarche@google.com>
Date: Wed, 25 Jun 2014 11:15:08 +0200
Subject: Add javadoc check to Checkstyle

Change-Id: I73353699430eff4d5d7a3abb42e62fe91f481a03
---
 dexcomparator/jackstyle.xml | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'dexcomparator')

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
 
     -->
-- 
cgit v1.1