javadoc and whitespace

stephengold · Jan 31, 2025 · 51b8439 · 51b8439
1 parent 7ef5762
commit 51b8439
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 12 deletions.
diff --git a/build.gradle b/build.gradle
@@ -268,6 +268,7 @@ application {
     // default settings for the 'run' task:
     mainClass = 'testjoltjni.app.helloworld.HelloWorld'
 }
+
 tasks.register('debugConvexVsMesh', JavaExec) {
     args '-s=ConvexVsMesh'
     debug = true
@@ -288,6 +289,7 @@ tasks.register('debugRagdoll', JavaExec) {
     dependsOn('unpackJoltAssets')
     mainClass = 'testjoltjni.app.performancetest.PerformanceTest'
 }
+
 tasks.register('runConvexVsMesh', JavaExec) {
     args '-s=ConvexVsMesh'
     enableAssertions = false
@@ -322,6 +324,7 @@ tasks.register('runSmokeTestAll', JavaExec) {
     dependsOn('unpackJoltAssets')
     mainClass = 'testjoltjni.app.samples.SmokeTestAll'
 }
+
 tasks.withType(JavaExec).configureEach { // Java runtime options:
     classpath sourceSets.test.runtimeClasspath
     dependsOn('assemble')

diff --git a/src/main/java/com/github/stephengold/joltjni/CharacterContactListener.java b/src/main/java/com/github/stephengold/joltjni/CharacterContactListener.java
@@ -53,7 +53,7 @@ void onAdjustBodyVelocity(
      * @param otherCharacterVa the virtual address of the other
      * {@code ConstCharacterVirtual} (not zero)
      * @param subShapeId2Va the virtual address of the {@code ConstSubShapeId}
-     * of the shape that is being hit (not zero)
+     * of the shape that is in contact (not zero)
      * @param contactLocationX the X component of the contact location (in
      * system coordinates)
      * @param contactLocationY the Y component of the contact location (in
@@ -129,7 +129,7 @@ void onCharacterContactRemoved(
      * @param otherCharacterVa the virtual address of the other
      * {@code ConstCharacterVirtual} (not zero)
      * @param subShapeId2Va the virtual address of the {@code ConstSubShapeId}
-     * of the shape that is being hit (not zero)
+     * of the shape that is in contact (not zero)
      * @param contactLocationX the X component of the contact location (in
      * system coordinates)
      * @param contactLocationY the Y component of the contact location (in
@@ -177,7 +177,7 @@ void onCharacterContactSolve(long characterVa, long otherCharacterVa,
      * @param otherCharacterVa the virtual address of the other
      * {@code ConstCharacterVirtual} (not zero)
      * @param subShapeId2Va the virtual address of the {@code ConstSubShapeId}
-     * of the shape that is being hit (not zero)
+     * of the shape that is in contact (not zero)
      * @return {@code true} if the contact is valid, otherwise {@code false}
      */
     boolean onCharacterContactValidate(
@@ -192,7 +192,7 @@ boolean onCharacterContactValidate(
      * @param bodyId2Va the virtual address of the {@code ConstBody} being
      * solved (not zero)
      * @param subShapeId2Va the virtual address of the {@code ConstSubShapeId}
-     * of the shape that is being hit (not zero)
+     * of the shape that is in contact (not zero)
      * @param contactLocationX the X component of the contact location (in
      * system coordinates)
      * @param contactLocationY the Y component of the contact location (in
@@ -266,7 +266,7 @@ void onContactPersisted(long characterVa, long bodyId2Va,
      * @param bodyId2Va the virtual address of the {@code ConstBody} being
      * solved (not zero)
      * @param subShapeId2Va the virtual address of the {@code ConstSubShapeId}
-     * of the shape that is being hit (not zero)
+     * of the shape that is in contact (not zero)
      * @param contactLocationX the X component of the contact location (in
      * system coordinates)
      * @param contactLocationY the Y component of the contact location (in
@@ -313,7 +313,7 @@ void onContactSolve(long characterVa, long bodyId2Va, long subShapeId2Va,
      * @param bodyId2Va the virtual address of the {@code ConstBody} being
      * solved (not zero)
      * @param subShapeId2Va the virtual address of the {@code ConstSubShapeId}
-     * of the shape that is being hit (not zero)
+     * of the shape that is in contact (not zero)
      * @return {@code true} if the contact is valid, otherwise {@code false}
      */
     boolean onContactValidate(

diff --git a/src/main/java/com/github/stephengold/joltjni/CustomCharacterContactListener.java b/src/main/java/com/github/stephengold/joltjni/CustomCharacterContactListener.java
@@ -65,7 +65,7 @@ public void onAdjustBodyVelocity(
      * @param otherCharacterVa the virtual address of the other
      * {@code ConstCharacterVirtual} (not zero)
      * @param subShapeId2Va the virtual address of the {@code ConstSubShapeId}
-     * of the shape that is being hit (not zero)
+     * of the shape that is in contact (not zero)
      * @param contactLocationX the X component of the contact location (in
      * system coordinates)
      * @param contactLocationY the Y component of the contact location (in
@@ -147,7 +147,7 @@ public void onCharacterContactRemoved(
      * @param otherCharacterVa the virtual address of the other
      * {@code ConstCharacterVirtual} (not zero)
      * @param subShapeId2Va the virtual address of the {@code ConstSubShapeId}
-     * of the shape that is being hit (not zero)
+     * of the shape that is in contact (not zero)
      * @param contactLocationX the X component of the contact location (in
      * system coordinates)
      * @param contactLocationY the Y component of the contact location (in
@@ -197,7 +197,7 @@ public void onCharacterContactSolve(long characterVa, long otherCharacterVa,
      * @param otherCharacterVa the virtual address of the other
      * {@code ConstCharacterVirtual} (not zero)
      * @param subShapeId2Va the virtual address of the {@code ConstSubShapeId}
-     * of the shape that is being hit (not zero)
+     * of the shape that is in contact (not zero)
      * @return {@code true} if the contact is valid, otherwise {@code false}
      */
     @Override
@@ -215,7 +215,7 @@ public boolean onCharacterContactValidate(
      * @param bodyId2Va the virtual address of the {@code ConstBody} being
      * solved (not zero)
      * @param subShapeId2Va the virtual address of the {@code ConstSubShapeId}
-     * of the shape that is being hit (not zero)
+     * of the shape that is in contact (not zero)
      * @param contactLocationX the X component of the contact location (in
      * system coordinates)
      * @param contactLocationY the Y component of the contact location (in
@@ -297,7 +297,7 @@ public void onContactRemoved(
      * @param bodyId2Va the virtual address of the {@code ConstBody} being
      * solved (not zero)
      * @param subShapeId2Va the virtual address of the {@code ConstSubShapeId}
-     * of the shape that is being hit (not zero)
+     * of the shape that is in contact (not zero)
      * @param contactLocationX the X component of the contact location (in
      * system coordinates)
      * @param contactLocationY the Y component of the contact location (in
@@ -347,7 +347,7 @@ public void onContactSolve(long characterVa, long bodyId2Va,
      * @param bodyId2Va the virtual address of the {@code ConstBody} being
      * solved (not zero)
      * @param subShapeId2Va the virtual address of the {@code ConstSubShapeId}
-     * of the shape that is being hit (not zero)
+     * of the shape that is in contact (not zero)
      * @return {@code true} if the contact is valid, otherwise {@code false}
      */
     @Override