Check missing doc on method

Author: shadromani

checkstyle.xml

@@ -333,6 +333,13 @@
             <property name="allowedAnnotations" value="Override, Test"/>
             <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF"/>
         </module>
+        <module name="MissingJavadocMethod">
+            <property name="scope" value="public"/>
+            <property name="minLineCount" value="2"/>
+            <property name="allowedAnnotations" value="Override, Test"/>
+            <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF,
+                                   COMPACT_CTOR_DEF"/>
+        </module>
         <module name="JavadocType"/>
         <module name="MissingJavadocType">
             <property name="scope" value="protected"/>

src/main/java/com/maxmind/db/MaxMindDbParameter.java

@@ -10,5 +10,8 @@
  */
 @Retention(RetentionPolicy.RUNTIME)
 public @interface MaxMindDbParameter {
+    /**
+     * @return the name of the parameter in the MaxMind DB file
+     */
     String name();
 }

src/main/java/com/maxmind/db/Metadata.java

@@ -30,27 +30,40 @@ public final class Metadata {
 
     private final int searchTreeSize;
 
+    /**
+     * Constructs a Metadata object.
+     * 
+     * @param binaryFormatMajorVersion The major version number for the database's
+     *                                 binary format.
+     * @param binaryFormatMinorVersion The minor version number for the database's
+     *                                 binary format.
+     * @param buildEpoch               The date of the database build.
+     * @param databaseType             A string that indicates the structure of each
+     *                                 data record associated with an IP address.
+     *                                 The actual definition of these structures is
+     *                                 left up to the database creator.
+     * @param languages                List of languages supported by the database.
+     * @param description              Map from language code to description in that
+     *                                 language.
+     * @param ipVersion                Whether the database contains IPv4 or IPv6
+     *                                 address data. The only possible values are 4
+     *                                 and 6.
+     * @param nodeCount                The number of nodes in the search tree.
+     * @param recordSize               The number of bits in a record in the search
+     *                                 tree. Note that each node consists of two
+     *                                 records.
+     */
     @MaxMindDbConstructor
     public Metadata(
-        @MaxMindDbParameter(name = "binary_format_major_version")
-        int binaryFormatMajorVersion,
-        @MaxMindDbParameter(name = "binary_format_minor_version")
-        int binaryFormatMinorVersion,
-        @MaxMindDbParameter(name = "build_epoch")
-        BigInteger buildEpoch,
-        @MaxMindDbParameter(name = "database_type")
-        String databaseType,
-        @MaxMindDbParameter(name = "languages")
-        List<String> languages,
-        @MaxMindDbParameter(name = "description")
-        Map<String, String> description,
-        @MaxMindDbParameter(name = "ip_version")
-        int ipVersion,
-        @MaxMindDbParameter(name = "node_count")
-        long nodeCount,
-        @MaxMindDbParameter(name = "record_size")
-        int recordSize
-    ) {
+            @MaxMindDbParameter(name = "binary_format_major_version") int binaryFormatMajorVersion,
+            @MaxMindDbParameter(name = "binary_format_minor_version") int binaryFormatMinorVersion,
+            @MaxMindDbParameter(name = "build_epoch") BigInteger buildEpoch,
+            @MaxMindDbParameter(name = "database_type") String databaseType,
+            @MaxMindDbParameter(name = "languages") List<String> languages,
+            @MaxMindDbParameter(name = "description") Map<String, String> description,
+            @MaxMindDbParameter(name = "ip_version") int ipVersion,
+            @MaxMindDbParameter(name = "node_count") long nodeCount,
+            @MaxMindDbParameter(name = "record_size") int recordSize) {
         this.binaryFormatMajorVersion = binaryFormatMajorVersion;
         this.binaryFormatMinorVersion = binaryFormatMinorVersion;
         this.buildEpoch = buildEpoch;
@@ -88,8 +101,8 @@ public Date getBuildDate() {
 
     /**
      * @return a string that indicates the structure of each data record
-     * associated with an IP address. The actual definition of these
-     * structures is left up to the database creator.
+     *         associated with an IP address. The actual definition of these
+     *         structures is left up to the database creator.
      */
     public String getDatabaseType() {
         return this.databaseType;
@@ -104,7 +117,7 @@ public Map<String, String> getDescription() {
 
     /**
      * @return whether the database contains IPv4 or IPv6 address data. The only
-     * possible values are 4 and 6.
+     *         possible values are 4 and 6.
      */
     public int getIpVersion() {
         return this.ipVersion;
@@ -133,7 +146,7 @@ int getNodeCount() {
 
     /**
      * @return the number of bits in a record in the search tree. Note that each
-     * node consists of two records.
+     *         node consists of two records.
      */
     int getRecordSize() {
         return this.recordSize;
@@ -154,11 +167,11 @@ int getSearchTreeSize() {
     @Override
     public String toString() {
         return "Metadata [binaryFormatMajorVersion="
-            + this.binaryFormatMajorVersion + ", binaryFormatMinorVersion="
-            + this.binaryFormatMinorVersion + ", buildEpoch="
-            + this.buildEpoch + ", databaseType=" + this.databaseType
-            + ", description=" + this.description + ", ipVersion="
-            + this.ipVersion + ", nodeCount=" + this.nodeCount
-            + ", recordSize=" + this.recordSize + "]";
+                + this.binaryFormatMajorVersion + ", binaryFormatMinorVersion="
+                + this.binaryFormatMinorVersion + ", buildEpoch="
+                + this.buildEpoch + ", databaseType=" + this.databaseType
+                + ", description=" + this.description + ", ipVersion="
+                + this.ipVersion + ", nodeCount=" + this.nodeCount
+                + ", recordSize=" + this.recordSize + "]";
     }
 }