Checkstyle updates

- remove MagicNumber
- add MissingJavadocType
- remove rules about contents of javadocs

checkstyle/config.xml

@@ -213,18 +213,6 @@
          <property name="tokens" value="VARIABLE_DEF"/>
          <property name="allowSamelineMultipleAnnotations" value="true"/>
       </module>
-      <module name="NonEmptyAtclauseDescription"/>
-      <!-- <module name="JavadocTagContinuationIndentation"/> -->
-      <!--
-      <module name="SummaryJavadoc">
-         <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
-      </module>
-      -->
-      <!-- <module name="JavadocParagraph"/> -->
-      <module name="AtclauseOrder">
-         <property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
-         <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
-      </module>
       <module name="JavadocMethod">
          <property name="allowMissingParamTags" value="true"/>
          <property name="allowMissingReturnTag" value="true"/>
@@ -233,23 +221,14 @@
       <module name="MissingJavadocMethod">
          <property name="scope" value="private"/>
       </module>
+      <module name="MissingJavadocType">
+         <property name="scope" value="private"/>
+      </module>
       <module name="MethodName">
          <property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
          <message key="name.invalidPattern"
           value="Method name ''{0}'' must match pattern ''{1}''."/>
       </module>
-      <module name="SingleLineJavadoc">
-         <property name="ignoreInlineTags" value="false"/>
-      </module>
-
-      <module name="MagicNumber">
-         <property name="severity" value="info"/>
-         <property name="tokens" value="NUM_DOUBLE, NUM_FLOAT, NUM_INT"/>
-         <property name="ignoreNumbers" value="0, 1, 2, 3, 4, 5, 6, 7, 8"/>
-         <property name="ignoreFieldDeclaration" value="true"/>
-         <property name="ignoreAnnotation" value="true"/>
-      </module>
-
       <module name="EmptyCatchBlock">
          <property name="exceptionVariableName" value="expected"/>
       </module>

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/actions/automation/RecordAutomationStatusUpdater.java

@@ -344,6 +344,9 @@ public class RecordAutomationStatusUpdater
 
 
 
+   /***************************************************************************
+    **
+    ***************************************************************************/
    private record Key(QTableMetaData table, TriggerEvent triggerEvent) {}
 
 }

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/actions/customizers/AbstractPreInsertCustomizer.java

@@ -55,10 +55,10 @@ public abstract class AbstractPreInsertCustomizer implements TableCustomizerInte
 
 
 
-   /////////////////////////////////////////////////////////////////////////////////
+   /***************************************************************************
-   // allow the customizer to specify when it should be executed as part of the   //
+    ** allow the customizer to specify when it should be executed as part of the
-   // insert action.  default (per method in this class) is AFTER_ALL_VALIDATIONS //
+    ** insert action.  default (per method in this class) is AFTER_ALL_VALIDATIONS
-   /////////////////////////////////////////////////////////////////////////////////
+    ***************************************************************************/
    public enum WhenToRun
    {
       BEFORE_ALL_VALIDATIONS,

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/actions/customizers/ChildInserterPostInsertCustomizer.java

@@ -49,6 +49,9 @@ import com.kingsrook.qqq.backend.core.utils.CollectionUtils;
  *******************************************************************************/
 public abstract class ChildInserterPostInsertCustomizer extends AbstractPostInsertCustomizer
 {
+   /***************************************************************************
+    **
+    ***************************************************************************/
    public enum RelationshipType
    {
       PARENT_POINTS_AT_CHILD,

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/actions/audits/AuditDetailAccumulator.java

@@ -152,5 +152,8 @@ public class AuditDetailAccumulator implements Serializable
    }
 
 
+   /***************************************************************************
+    **
+    ***************************************************************************/
    private record TableNameAndPrimaryKey(String tableName, Serializable primaryKey) {}
 }

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/actions/tables/query/expressions/NowWithOffset.java

@@ -42,6 +42,9 @@ public class NowWithOffset extends AbstractFilterExpression<Instant>
 
 
 
+   /***************************************************************************
+    **
+    ***************************************************************************/
    public enum Operator
    {PLUS, MINUS}
 

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/actions/tables/query/expressions/ThisOrLastPeriod.java

@@ -43,6 +43,9 @@ public class ThisOrLastPeriod extends AbstractFilterExpression<Instant>
 
 
 
+   /***************************************************************************
+    **
+    ***************************************************************************/
    public enum Operator
    {THIS, LAST}
 

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/dashboard/widgets/AlertData.java

@@ -28,6 +28,9 @@ package com.kingsrook.qqq.backend.core.model.dashboard.widgets;
  *******************************************************************************/
 public class AlertData extends QWidgetData
 {
+   /***************************************************************************
+    **
+    ***************************************************************************/
    public enum AlertType
    {
       ERROR,

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/dashboard/widgets/blocks/BlockTooltip.java

@@ -33,6 +33,9 @@ public class BlockTooltip
 
 
 
+   /***************************************************************************
+    **
+    ***************************************************************************/
    public enum Placement
    {BOTTOM, LEFT, RIGHT, TOP}
 

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/metadata/dashboard/ParentWidgetMetaData.java

@@ -39,6 +39,9 @@ public class ParentWidgetMetaData extends QWidgetMetaData
 
 
 
+   /***************************************************************************
+    **
+    ***************************************************************************/
    public enum LayoutType
    {
       GRID,

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/model/metadata/tables/cache/CacheUseCase.java

@@ -32,6 +32,9 @@ import com.kingsrook.qqq.backend.core.model.metadata.tables.UniqueKey;
  *******************************************************************************/
 public class CacheUseCase
 {
+   /***************************************************************************
+    **
+    ***************************************************************************/
    public enum Type
    {
       PRIMARY_KEY_TO_PRIMARY_KEY, // e.g., the primary key in the cache table equals the primary key in the source table.

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/utils/collections/ListBuilder.java

@@ -26,7 +26,6 @@ import java.util.ArrayList;
 import java.util.List;
 
 
-@SuppressWarnings({ "checkstyle:javadoc", "DanglingJavadoc" })
 /*******************************************************************************
  ** List.of is "great", but annoying because it makes unmodifiable lists...
  ** So, replace it with this, which returns ArrayLists, which "don't suck"

qqq-backend-core/src/main/java/com/kingsrook/qqq/backend/core/utils/collections/MapBuilder.java

@@ -27,7 +27,6 @@ import java.util.Map;
 import java.util.function.Supplier;
 
 
-@SuppressWarnings({ "checkstyle:javadoc", "DanglingJavadoc" })
 /*******************************************************************************
  ** Map.of is "great", but annoying because it makes unmodifiable maps, and it
  ** NPE's on nulls...  So, replace it with this, which returns HashMaps (or maps

qqq-backend-module-api/src/main/java/com/kingsrook/qqq/backend/module/api/actions/BaseAPIActionUtil.java

@@ -117,6 +117,9 @@ public class BaseAPIActionUtil
 
 
 
+   /***************************************************************************
+    **
+    ***************************************************************************/
    public enum UpdateHttpMethod
    {PUT, POST}
 

qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/model/metadata/processes/ApiProcessMetaData.java

@@ -69,6 +69,9 @@ public class ApiProcessMetaData
 
 
 
+   /***************************************************************************
+    **
+    ***************************************************************************/
    public enum AsyncMode
    {
       NEVER,