bit stricter checkstyle

Author: ianardee

checkstyle.xml

@@ -326,6 +326,7 @@
     <module name="SummaryJavadoc">
       <property name="forbiddenSummaryFragments"
                value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
+      <property name="severity" value="error"/>
     </module>
     <module name="JavadocParagraph"/>
     <module name="RequireEmptyLineBeforeBlockTagGroup"/>

pom.xml

@@ -97,7 +97,7 @@
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-checkstyle-plugin</artifactId>
-          <version>3.2.1</version>
+          <version>3.6.0</version>
           <dependencies>
             <dependency>
               <groupId>com.puppycrawl.tools</groupId>
@@ -132,6 +132,10 @@
           <target>8</target>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+      </plugin>
       <plugin>
         <groupId>org.sonatype.central</groupId>
         <artifactId>central-publishing-maven-plugin</artifactId>

src/main/java/com/mindee/MindeeClient.java

@@ -416,6 +416,7 @@ public <T extends Inference> AsyncPredictResponse<T> enqueueAndParse(
   }
 
   /**
+   * Validate async polling options.
    * @param pollingOptions Options for async call parameters
    * @throws MindeeException Throws if settings aren't set properly.
    */

src/main/java/com/mindee/cli/CommandLineInterfaceProducts.java

@@ -36,6 +36,7 @@ public class CommandLineInterfaceProducts {
   private final ProductProcessor processor;
 
   /**
+   * Default constructor.
    * @param processor Processor instance to render the products.
    */
   public CommandLineInterfaceProducts(ProductProcessor processor) {

src/main/java/com/mindee/cli/ProductProcessor.java

@@ -16,6 +16,7 @@
 )
 public interface ProductProcessor {
   /**
+   * Process a product synchronously.
    * @param productClass Product class to be processed for synchronous products.
    * @param file Input file.
    * @param <T> Type of the product.
@@ -25,6 +26,7 @@ public interface ProductProcessor {
   <T extends Inference<?, ?>> String standardProductOutput(Class<T> productClass, File file) throws IOException;
 
   /**
+   * Process a product asynchronously.
    * @param productClass Product class to be processed for asynchronous products.
    * @param file Input file.
    * @param <T> Type of the product.

src/main/java/com/mindee/extraction/ExtractedImage.java

@@ -20,6 +20,7 @@ public class ExtractedImage {
   private final String saveFormat;
 
   /**
+   * Default constructor.
    * @param image Buffered image object.
    * @param filename Name of the extracted image.
    * @param saveFormat Format to save the image as, defaults to PNG.

src/main/java/com/mindee/extraction/ExtractedPDF.java

@@ -19,6 +19,8 @@ public class ExtractedPDF {
   private final String filename;
 
   /**
+   * Default constructor.
+   *
    * @param pdf PDF wrapper object.
    * @param filename Name of the extracted file.
    */

src/main/java/com/mindee/extraction/ImageExtractor.java

@@ -57,6 +57,8 @@ public ImageExtractor(LocalInputSource source) throws IOException {
   }
 
   /**
+   * Get the number of pages in the file.
+   *
    * @return The number of pages in the file.
    */
   public int getPageCount() {

src/main/java/com/mindee/extraction/PDFExtractor.java

@@ -64,7 +64,9 @@ public PDFExtractor(LocalInputSource source) throws IOException {
   }
 
   /**
-   * @return The number of pages in the file.
+   * Get the number of pages in the PDF file.
+   *
+   * @return The number of pages in the PDF file.
    */
   public int getPageCount() {
     return sourcePdf.getNumberOfPages();

src/main/java/com/mindee/http/MindeeHttpApi.java

@@ -50,7 +50,7 @@ public final class MindeeHttpApi extends MindeeApi {
   private final MindeeSettings mindeeSettings;
   /**
    * The HttpClientBuilder used to create HttpClient objects used to make api calls over http.
-   * Defaults to HttpClientBuilder.create().useSystemProperties()
+   * Defaults to HttpClientBuilder.create().useSystemProperties().
    */
   private final HttpClientBuilder httpClientBuilder;
   /**
@@ -145,7 +145,7 @@ private MindeeHttpApi(
   }
 
   /**
-   * GET job status and document for an enqueued job
+   * GET job status and document for an enqueued job.
    */
   public <DocT extends Inference> AsyncPredictResponse<DocT> documentQueueGet(
       Class<DocT> documentClass,