standardize the explanations of explicit no-arg constructors

stephengold · Feb 27, 2024 · ee2f4bf · ee2f4bf
1 parent 5a9c1ae
commit ee2f4bf
Show file tree

Hide file tree

Showing 58 changed files with 280 additions and 108 deletions.
diff --git a/DacWizard/src/main/java/jme3utilities/minie/wizard/DacWizard.java b/DacWizard/src/main/java/jme3utilities/minie/wizard/DacWizard.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2019-2023, Stephen Gold
+ Copyright (c) 2019-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -151,8 +151,11 @@ public class DacWizard extends GuiApplication {
 
     /**
      * Instantiate the DacWizard application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public DacWizard() { // explicit to avoid a warning from JDK 18 javadoc
+    public DacWizard() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3test/batching/TowerPerformance.java b/MinieExamples/src/main/java/jme3test/batching/TowerPerformance.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2023 jMonkeyEngine
+ * Copyright (c) 2009-2024 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -102,8 +102,11 @@ public class TowerPerformance
 
     /**
      * Instantiate the TowerPerformance application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public TowerPerformance() { // to avoid a warning from JDK 18 javadoc
+    public TowerPerformance() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/BalanceDemo.java b/MinieExamples/src/main/java/jme3utilities/minie/test/BalanceDemo.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2018-2023, Stephen Gold
+ Copyright (c) 2018-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -186,8 +186,11 @@ public class BalanceDemo extends PhysicsDemo {
 
     /**
      * Instantiate the BalanceDemo application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public BalanceDemo() { // to avoid a warning from JDK 18 javadoc
+    public BalanceDemo() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/BuoyDemo.java b/MinieExamples/src/main/java/jme3utilities/minie/test/BuoyDemo.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2019-2023, Stephen Gold
+ Copyright (c) 2019-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -151,8 +151,11 @@ public class BuoyDemo extends PhysicsDemo {
 
     /**
      * Instantiate the BuoyDemo application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public BuoyDemo() { // made explicit to avoid a warning from JDK 18 javadoc
+    public BuoyDemo() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/ConveyorDemo.java b/MinieExamples/src/main/java/jme3utilities/minie/test/ConveyorDemo.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2020-2023, Stephen Gold
+ Copyright (c) 2020-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -146,8 +146,11 @@ public class ConveyorDemo
 
     /**
      * Instantiate the ConveyorDemo application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public ConveyorDemo() { // explicit to avoid a warning from JDK 18 javadoc
+    public ConveyorDemo() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/DropTest.java b/MinieExamples/src/main/java/jme3utilities/minie/test/DropTest.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2018-2023, Stephen Gold
+ Copyright (c) 2018-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -153,8 +153,11 @@ public class DropTest
 
     /**
      * Instantiate the DropTest application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public DropTest() { // made explicit to avoid a warning from JDK 18 javadoc
+    public DropTest() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/ForceDemo.java b/MinieExamples/src/main/java/jme3utilities/minie/test/ForceDemo.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2019-2023, Stephen Gold
+ Copyright (c) 2019-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -93,8 +93,11 @@ public class ForceDemo
 
     /**
      * Instantiate the ForceDemo application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public ForceDemo() { // to avoid a warning from JDK 18 javadoc
+    public ForceDemo() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/JointDemo.java b/MinieExamples/src/main/java/jme3utilities/minie/test/JointDemo.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2019-2023, Stephen Gold
+ Copyright (c) 2019-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -122,8 +122,11 @@ public class JointDemo extends PhysicsDemo {
 
     /**
      * Instantiate the JointDemo application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public JointDemo() { // to avoid a warning from JDK 18 javadoc
+    public JointDemo() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/JointElasticity.java b/MinieExamples/src/main/java/jme3utilities/minie/test/JointElasticity.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2020-2023, Stephen Gold
+ Copyright (c) 2020-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -128,8 +128,11 @@ public class JointElasticity extends PhysicsDemo {
 
     /**
      * Instantiate the JointElasticity application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public JointElasticity() { // to avoid a warning from JDK 18 javadoc
+    public JointElasticity() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/NewtonsCradle.java b/MinieExamples/src/main/java/jme3utilities/minie/test/NewtonsCradle.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2020-2023, Stephen Gold
+ Copyright (c) 2020-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -111,8 +111,11 @@ public class NewtonsCradle
 
     /**
      * Instantiate the NewtonsCradle application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public NewtonsCradle() { // explicit to avoid a warning from JDK 18 javadoc
+    public NewtonsCradle() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/Pachinko.java b/MinieExamples/src/main/java/jme3utilities/minie/test/Pachinko.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2022-2023, Stephen Gold
+ Copyright (c) 2022-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -132,8 +132,11 @@ public class Pachinko
 
     /**
      * Instantiate the Pachinko application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public Pachinko() { // made explicit to avoid a warning from JDK 18 javadoc
+    public Pachinko() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/PoolDemo.java b/MinieExamples/src/main/java/jme3utilities/minie/test/PoolDemo.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2020-2023, Stephen Gold
+ Copyright (c) 2020-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -142,8 +142,11 @@ public class PoolDemo extends PhysicsDemo {
 
     /**
      * Instantiate the PoolDemo application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public PoolDemo() { // made explicit to avoid a warning from JDK 18 javadoc
+    public PoolDemo() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/RopeDemo.java b/MinieExamples/src/main/java/jme3utilities/minie/test/RopeDemo.java
@@ -219,8 +219,11 @@ private enum RopeShape {
 
     /**
      * Instantiate the RopeDemo application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public RopeDemo() { // made explicit to avoid a warning from JDK 18 javadoc
+    public RopeDemo() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/SeJointDemo.java b/MinieExamples/src/main/java/jme3utilities/minie/test/SeJointDemo.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2018-2023, Stephen Gold
+ Copyright (c) 2018-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -173,8 +173,11 @@ public class SeJointDemo extends PhysicsDemo {
 
     /**
      * Instantiate the SeJointDemo application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public SeJointDemo() { // explicit to avoid a warning from JDK 18 javadoc
+    public SeJointDemo() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/SplitDemo.java b/MinieExamples/src/main/java/jme3utilities/minie/test/SplitDemo.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2020-2023, Stephen Gold
+ Copyright (c) 2020-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -170,8 +170,11 @@ public class SplitDemo
 
     /**
      * Instantiate the SplitDemo application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public SplitDemo() { // made explicit to avoid a warning from JDK 18 javadoc
+    public SplitDemo() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/SweepDemo.java b/MinieExamples/src/main/java/jme3utilities/minie/test/SweepDemo.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2022-2023, Stephen Gold
+ Copyright (c) 2022-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -153,8 +153,11 @@ public class SweepDemo
 
     /**
      * Instantiate the SweepDemo application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public SweepDemo() { // made explicit to avoid a warning from JDK 18 javadoc
+    public SweepDemo() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/TargetDemo.java b/MinieExamples/src/main/java/jme3utilities/minie/test/TargetDemo.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2020-2023, Stephen Gold
+ Copyright (c) 2020-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -134,8 +134,11 @@ public class TargetDemo
 
     /**
      * Instantiate the TargetDemo application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public TargetDemo() { // explicit to avoid a warning from JDK 18 javadoc
+    public TargetDemo() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/TestDac.java b/MinieExamples/src/main/java/jme3utilities/minie/test/TestDac.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2018-2023, Stephen Gold
+ Copyright (c) 2018-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -211,8 +211,11 @@ public class TestDac extends PhysicsDemo {
 
     /**
      * Instantiate the TestDac application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public TestDac() { // made explicit to avoid a warning from JDK 18 javadoc
+    public TestDac() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/TestGearJoint.java b/MinieExamples/src/main/java/jme3utilities/minie/test/TestGearJoint.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2022-2023, Stephen Gold
+ Copyright (c) 2022-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -101,8 +101,11 @@ public class TestGearJoint
 
     /**
      * Instantiate the TestGearJoint application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public TestGearJoint() { // explicit to avoid a warning from JDK 18 javadoc
+    public TestGearJoint() {
     }
     // *************************************************************************
     // new methods exposed

diff --git a/MinieExamples/src/main/java/jme3utilities/minie/test/TestInsideTriangle.java b/MinieExamples/src/main/java/jme3utilities/minie/test/TestInsideTriangle.java
@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2021-2023, Stephen Gold
+ Copyright (c) 2021-2024 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -91,8 +91,11 @@ public class TestInsideTriangle extends AcorusDemo {
 
     /**
      * Instantiate the TestInsideTriangle application.
+     * <p>
+     * This no-arg constructor was made explicit to avoid javadoc warnings from
+     * JDK 18+.
      */
-    public TestInsideTriangle() { // to avoid a warning from JDK 18 javadoc
+    public TestInsideTriangle() {
     }
     // *************************************************************************
     // new methods exposed