[Java] Update Checkstyle DTD and apply Javadoc method checks for when used.

Author: mjpt777

config/checkstyle/checkstyle.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
-<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
-        "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
+<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+        "https://checkstyle.org/dtds/configuration_1_3.dtd">
 <module name="Checker">
     <module name="SuppressionFilter">
         <property name="file" value="${config_loc}/suppressions.xml"/>
@@ -170,5 +170,10 @@
             <property name="illegalPattern" value="true"/>
             <property name="message" value="Trailing whitespace"/>
         </module>
+
+        <module name="JavadocMethod">
+            <property name="allowMissingJavadoc" value="true"/>
+            <property name="allowUndeclaredRTE" value="true"/>
+        </module>
     </module>
 </module>

sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/cpp/NamespaceOutputManager.java

@@ -35,8 +35,8 @@ public class NamespaceOutputManager implements OutputManager
     /**
      * Create a new {@link OutputManager} for generating C++98 source files into a given package.
      *
-     * @param baseDirName for the generated source code.
-     * @param namespaceName     for the generated source code relative to the baseDirName.
+     * @param baseDirName   for the generated source code.
+     * @param namespaceName for the generated source code relative to the baseDirName.
      */
     public NamespaceOutputManager(final String baseDirName, final String namespaceName)
     {
@@ -61,6 +61,7 @@ public NamespaceOutputManager(final String baseDirName, final String namespaceNa
      *
      * @param name the name of the C++ class.
      * @return a {@link java.io.Writer} to which the source code should be written.
+     * @throws IOException if an issue occurs when creating the file.
      */
     public Writer createOutput(final String name) throws IOException
     {

sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/csharp/CSharpNamespaceOutputManager.java

@@ -40,7 +40,7 @@ public class CSharpNamespaceOutputManager implements OutputManager
      * files into a given package.
      *
      * @param baseDirName for the generated source code.
-     * @param packageName       for the generated source code relative to the baseDirName.
+     * @param packageName for the generated source code relative to the baseDirName.
      */
     public CSharpNamespaceOutputManager(final String baseDirName, final String packageName)
     {
@@ -65,6 +65,7 @@ public CSharpNamespaceOutputManager(final String baseDirName, final String packa
      *
      * @param name the name of the C# class.
      * @return a {@link java.io.Writer} to which the source code should be written.
+     * @throws IOException if an issue occurs when creating the file.
      */
     public Writer createOutput(final String name) throws IOException
     {

sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/golang/GolangOutputManager.java

@@ -61,6 +61,7 @@ public GolangOutputManager(final String baseDirName, final String namespaceName)
      *
      * @param name the name of the golang class.
      * @return a {@link java.io.Writer} to which the source code should be written.
+     * @throws IOException if an issue occurs when creating the file.
      */
     public Writer createOutput(final String name) throws IOException
     {

sbe-tool/src/main/java/uk/co/real_logic/sbe/xml/CompositeType.java

@@ -36,10 +36,13 @@
 import static uk.co.real_logic.sbe.xml.XmlSchemaParser.getAttributeValueOrNull;
 
 /**
- * SBE compositeType.
+ * SBE compositeType which is a composite of other composites, sets, enums, or simple types.
  */
 public class CompositeType extends Type
 {
+    /**
+     * SBE schema composite type.
+     */
     public static final String COMPOSITE_TYPE = "composite";
     public static final String SUB_TYPES_EXP = "type|enum|set|composite|ref";
 

sbe-tool/src/main/java/uk/co/real_logic/sbe/xml/EncodedDataType.java

@@ -33,10 +33,13 @@
 import static uk.co.real_logic.sbe.xml.XmlSchemaParser.getAttributeValueOrNull;
 
 /**
- * SBE encodedDataType
+ * SBE simple encoded data type.
  */
 public class EncodedDataType extends Type
 {
+    /**
+     * SBE schema type.
+     */
     public static final String ENCODED_DATA_TYPE = "type";
 
     private final PrimitiveType primitiveType;
@@ -248,6 +251,11 @@ public boolean isVariableLength()
         return varLen;
     }
 
+    /**
+     * Set if the type is variable length or not.
+     *
+     * @param variableLength true if variable length.
+     */
     public void variableLength(final boolean variableLength)
     {
         this.varLen = variableLength;
@@ -289,7 +297,6 @@ public int encodedLength()
      * @return value of the constant for this type
      */
     public PrimitiveValue constVal()
-        throws IllegalArgumentException
     {
         if (presence() != CONSTANT)
         {

sbe-tool/src/main/java/uk/co/real_logic/sbe/xml/EnumType.java

@@ -36,10 +36,13 @@
 import static uk.co.real_logic.sbe.xml.XmlSchemaParser.getAttributeValueOrNull;
 
 /**
- * SBE enumType
+ * SBE enum type for representing an enumeration of values.
  */
 public class EnumType extends Type
 {
+    /**
+     * SBE schema enum type.
+     */
     public static final String ENUM_TYPE = "enum";
 
     private final PrimitiveType encodingType;

sbe-tool/src/main/java/uk/co/real_logic/sbe/xml/SetType.java

@@ -31,10 +31,13 @@
 import static uk.co.real_logic.sbe.xml.XmlSchemaParser.*;
 
 /**
- * SBE setType representing a bitset of options.
+ * SBE set tpe representing a bitset of options.
  */
 public class SetType extends Type
 {
+    /**
+     * SBE schema set type.
+     */
     public static final String SET_TYPE = "set";
 
     private final PrimitiveType encodingType;
@@ -172,6 +175,11 @@ public Collection<Choice> choices()
         return choiceByNameMap.values();
     }
 
+    /**
+     * Always false.
+     *
+     * {@inheritDoc}
+     */
     public boolean isVariableLength()
     {
         return false;
@@ -187,7 +195,7 @@ public String toString()
     }
 
     /**
-     * Holder for valid values for EnumType
+     * Holder for valid values for SBE schema enum type.
      */
     public static class Choice
     {
@@ -260,7 +268,6 @@ public int sinceVersion()
             return sinceVersion;
         }
 
-
         /**
          * Version in which {@link Choice} was deprecated. Only valid if greater than zero.
          *