javadoc and comments

Author: stephengold

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

@@ -1286,9 +1286,11 @@ public void saveBinaryState(StreamOut stream) {
      * unaffected.
      *
      * @param stream where to write objects (not {@code null})
-     * @param shapeMap track multiple uses of shapes (may be null)
-     * @param materialMap track multiple uses of physics materials (may be null)
-     * @param filterMap track multiple uses of group filters (may be null)
+     * @param shapeMap track multiple uses of shapes (may be {@code null})
+     * @param materialMap track multiple uses of physics materials (may be
+     * {@code null})
+     * @param filterMap track multiple uses of group filters (may be
+     * {@code null})
      */
     @Override
     public void saveWithChildren(StreamOut stream, ShapeToIdMap shapeMap,

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

@@ -409,7 +409,7 @@ public ConvexHullShapeSettings setPoints(Vec3Arg... points) {
     /**
      * Apply the specified linear transform to all points.
      *
-     * @param matrix the tranform to apply (not {@code null}, unaffected)
+     * @param matrix the transform to apply (not {@code null}, unaffected)
      * @return the modified settings, for chaining
      */
     public ConvexHullShapeSettings transformPoints(Mat44Arg matrix) {

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

@@ -46,7 +46,7 @@ public HairShadersRef() {
      *
      * @param refVa the virtual address of the native object to assign (not
      * zero)
-     * @param shaders the the shaders to target (not {@code null})
+     * @param shaders the shaders to target (not {@code null})
      */
     HairShadersRef(long refVa, HairShaders shaders) {
         assert shaders != null;

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

@@ -84,7 +84,7 @@ public MassProperties(ConstMassProperties original) {
     /**
      * Rotate the inertia by the specified 3x3 matrix.
      *
-     * @param rotation the rotation to apply (not null, unaffected)
+     * @param rotation the rotation to apply (not {@code null}, unaffected)
      */
     public void rotate(Mat44Arg rotation) {
         long propertiesVa = va();
@@ -96,7 +96,7 @@ public void rotate(Mat44Arg rotation) {
      * Scale the mass and inertia by the specified factors. Note that factors
      * can be <0 to flip the shape.
      *
-     * @param scaleFactors the desired scaling (not null unaffected)
+     * @param scaleFactors the desired scaling (not {@code null}, unaffected)
      */
     public void scale(Vec3Arg scaleFactors) {
         long propertiesVa = va();
@@ -119,7 +119,8 @@ public void scaleToMass(float mass) {
     /**
      * Alter the inertia tensor. (native attribute: mInertia)
      *
-     * @param inertia the desired value (not null, unaffected, default=zero)
+     * @param inertia the desired value (not {@code null}, unaffected,
+     * default=zero)
      * @return the modified properties, for chaining
      */
     public MassProperties setInertia(Mat44Arg inertia) {
@@ -147,7 +148,7 @@ public MassProperties setMass(float mass) {
      * Alter the mass and inertia to that of a box with the specified dimensions
      * and uniform density.
      *
-     * @param boxSize the edge lengths of the box (not null, unaffected)
+     * @param boxSize the edge lengths of the box (not {@code null}, unaffected)
      * @param density the density to use
      */
     public void setMassAndInertiaOfSolidBox(Vec3Arg boxSize, float density) {
@@ -161,7 +162,7 @@ public void setMassAndInertiaOfSolidBox(Vec3Arg boxSize, float density) {
     /**
      * Translate the inertia by the specified offset.
      *
-     * @param offset the amount of translation (not null, unaffected)
+     * @param offset the amount of translation (not {@code null}, unaffected)
      */
     public void translate(Vec3Arg offset) {
         long propertiesVa = va();
@@ -177,8 +178,10 @@ public void translate(Vec3Arg offset) {
      * Decompose the inertia tensor into a diagonal matrix and a right-handed
      * rotation matrix. The properties are unaffected.
      *
-     * @param storeRotation storage for the rotation matrix (not null, modified)
-     * @param storeDiagonal storage for the diagonal matrix (not null, modified)
+     * @param storeRotation storage for the rotation matrix (not {@code null},
+     * modified)
+     * @param storeDiagonal storage for the diagonal matrix (not {@code null},
+     * modified)
      * @return {@code true} if successful, otherwise {@code false}
      */
     @Override
@@ -198,7 +201,7 @@ public boolean decomposePrincipalMomentsOfInertia(
      * Copy the inertia tensor. The properties are unaffected. (native
      * attribute: mInertia)
      *
-     * @return a new matrix (in kilogram.meters squared)
+     * @return a new matrix (in kilogram.meters^2)
      */
     @Override
     public Mat44 getInertia() {
@@ -245,7 +248,7 @@ public boolean isEqual(ConstMassProperties other) {
      * Return a string representation of the properties object, which is
      * unaffected.
      *
-     * @return the string representation (not null, not empty)
+     * @return the string representation (not {@code null}, not empty)
      */
     @Override
     public String toString() {

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

@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2024-2025 Stephen Gold
+Copyright (c) 2024-2026 Stephen Gold
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -167,7 +167,7 @@ public void setContactNormalCosMaxDeltaRotation(float cosine) {
      * (native member: mContactPointPreserveLambdaMaxDistSq)
      *
      * @param squaredDistance the square of the desired threshold distance (in
-     * meters squared, ≥0, default=1e-4)
+     * meters^2, ≥0, default=1e-4)
      */
     public void setContactPointPreserveLambdaMaxDistSq(float squaredDistance) {
         assert squaredDistance >= 0f : squaredDistance;
@@ -519,7 +519,7 @@ public float getContactNormalCosMaxDeltaRotation() {
      * settings are unaffected. (native member:
      * mContactPointPreserveLambdaMaxDistSq)
      *
-     * @return the square of the threshold distance (in meters squared, ≥0)
+     * @return the square of the threshold distance (in meters^2, ≥0)
      */
     @Override
     public float getContactPointPreserveLambdaMaxDistSq() {

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

@@ -707,7 +707,7 @@ public float getVertexRadius() {
      * shared settings, materials, and group filter. The settings are
      * unaffected.
      *
-     * @param stream where to write objects (not null)
+     * @param stream where to write objects (not {@code null})
      */
     @Override
     public void saveBinaryState(StreamOut stream) {
@@ -720,10 +720,13 @@ public void saveBinaryState(StreamOut stream) {
      * Write the state of this object to the specified stream. The settings are
      * unaffected.
      *
-     * @param stream where to write objects (not null)
-     * @param sbssMap track multiple uses of shared settings (may be null)
-     * @param materialMap track multiple uses of physics materials (may be null)
-     * @param filterMap track multiple uses of group filters (may be null)
+     * @param stream where to write objects (not {@code null})
+     * @param sbssMap track multiple uses of shared settings (may be
+     * {@code null})
+     * @param materialMap track multiple uses of physics materials (may be
+     * {@code null})
+     * @param filterMap track multiple uses of group filters (may be
+     * {@code null})
      */
     @Override
     public void saveWithChildren(

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

@@ -86,7 +86,7 @@ public long targetVa() {
     }
 
     /**
-     * Create a additional counted reference to the targeted tester.
+     * Create an additional counted reference to the targeted tester.
      *
      * @return a new JVM object with a new native object assigned
      */

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

@@ -181,7 +181,7 @@ public void setSwitchTime(float latency) {
         setSwitchTime(settingsVa, latency);
     }
     // *************************************************************************
-    // ConstVechicleTransmissionSettings methods
+    // ConstVehicleTransmissionSettings methods
 
     /**
      * Return how long it takes to release the clutch in {@code Auto} mode. The

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

@@ -88,7 +88,7 @@ public void setAngularDamping(float damping) {
      * Alter the moment of inertia around the wheel's rolling axis. (native
      * attribute: mInertia)
      *
-     * @param moment the desired moment of inertia (in kilogram.meters squared,
+     * @param moment the desired moment of inertia (in kilogram.meters^2,
      * default=0.9)
      */
     public void setInertia(float moment) {
@@ -173,7 +173,7 @@ public float getAngularDamping() {
      * Return the moment of inertia around the wheel's rolling axis. The
      * settings are unaffected. (native attribute: mInertia)
      *
-     * @return the moment of inertia (in kilogram.meters squared, ≥0)
+     * @return the moment of inertia (in kilogram.meters^2, ≥0)
      */
     @Override
     public float getInertia() {

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

@@ -96,7 +96,7 @@ public WheelSettingsWvRef setEnableSuspensionForcePoint(boolean enable) {
      * Alter the moment of inertia around the wheel's rolling axis. (native
      * attribute: mInertia)
      *
-     * @param moment the desired moment of inertia (in kilogram.meters squared,
+     * @param moment the desired moment of inertia (in kilogram.meters^2,
      * default=0.9)
      */
     public void setInertia(float moment) {
@@ -381,7 +381,7 @@ public boolean getEnableSuspensionForcePoint() {
      * Return the moment of inertia around the wheel's rolling axis. The
      * settings are unaffected. (native attribute: mInertia)
      *
-     * @return the moment of inertia (in kilogram.meters squared, ≥0)
+     * @return the moment of inertia (in kilogram.meters^2, ≥0)
      */
     @Override
     public float getInertia() {