javadoc and comments

src/main/java/com/github/stephengold/joltjni/BoxShape.java

@@ -30,6 +30,12 @@ public class BoxShape extends ConvexShape {
     // *************************************************************************
     // constructors
 
+    /**
+     * Instantiate a shape with the specified native object assigned.
+     *
+     * @param virtualAddress the virtual address of the native object to assign
+     * (not zero)
+     */
     BoxShape(long va) {
         super(va);
     }

src/main/java/com/github/stephengold/joltjni/BoxShapeSettings.java

@@ -31,7 +31,7 @@ public class BoxShapeSettings extends ConvexShapeSettings {
     // constructors
 
     /**
-     * Instantiate box settings for the specified half extents.
+     * Instantiate settings for the specified half extents.
      *
      * @param halfExtents the desired half extents on each local axis (not null,
      * all components ≥0, unaffected)

src/main/java/com/github/stephengold/joltjni/JobSystemThreadPool.java

@@ -31,11 +31,14 @@ public class JobSystemThreadPool extends JobSystem {
     // constructors
 
     /**
-     * Instantiate a system with the specified limits.
+     * Instantiate a job system with the specified limits.
      *
-     * @param maxJobs the maximum number of jobs to be scheduled
-     * @param maxBarriers the maximum number of barriers
-     * @param numThreads the number of worker threads to be created
+     * @param maxJobs the maximum number of jobs that can be allocated at one
+     * time
+     * @param maxBarriers the maximum number of barriers that can be allocated
+     * at one time
+     * @param numThreads the number of worker threads to start (≥1) or -1 to
+     * auto detect
      */
     public JobSystemThreadPool(int maxJobs, int maxBarriers, int numThreads) {
         long systemVa = createJobSystem(maxJobs, maxBarriers, numThreads);

src/main/java/com/github/stephengold/joltjni/PhysicsSystem.java

@@ -22,8 +22,8 @@ of this software and associated documentation files (the "Software"), to deal
 package com.github.stephengold.joltjni;
 
 /**
- * Perform simulation on physics objects. Bodies are added via a separate
- * interface.
+ * Perform simulation on a collection of physics objects. Bodies are added via a
+ * separate interface.
  *
  * @author Stephen Gold [email protected]
  */

src/main/java/com/github/stephengold/joltjni/Vec3.java

@@ -23,7 +23,8 @@ of this software and associated documentation files (the "Software"), to deal
 
 /**
  * A vector composed of 3 single-precision components, used to represent
- * velocities and directions in 3-dimensional space.
+ * directions, extents, forces, impulses, offsets, scaling factors, torques,
+ * and velocities in 3-dimensional space.
  *
  * @author Stephen Gold [email protected]
  */

src/test/java/HelloWorld.java

@@ -24,7 +24,7 @@ of this software and associated documentation files (the "Software"), to deal
 
 /**
  * A straightforward Java translation of the Jolt Physics "hello world" sample
- * application. 
+ * application.
  * <p>
  * Derived from HelloWorld/HelloWorld.cpp by Jorrit Rouwe.
  *

src/test/java/Test001.java

@@ -72,9 +72,12 @@ public void test001() {
         JobSystemThreadPool jobSystem
                 = new JobSystemThreadPool(maxJobs, maxBarriers, numThreads);
 
+        // object layers:
         final int objLayerNonMoving = 0;
         final int objLayerMoving = 1;
         final int numObjLayers = 2;
+
+        // broadphase layers:
         final int bpLayerNonMoving = 0;
         final int bpLayerMoving = 1;
         final int numBpLayers = 2;