library: javadoc

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

@@ -512,10 +512,10 @@ public CharacterRef toRef() {
     // ConstCharacter methods
 
     /**
-     * Return the ID of the body associated with this character. The character
-     * is unaffected.
+     * Copy the ID of the body associated with this character. The character is
+     * unaffected.
      *
-     * @return a new ID
+     * @return a new object
      */
     @Override
     public BodyId getBodyId() {

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

@@ -229,10 +229,10 @@ public boolean setShape(
     // ConstCharacter methods
 
     /**
-     * Return the ID of the body associated with this character. The character
-     * is unaffected.
+     * Copy the ID of the body associated with this character. The character is
+     * unaffected.
      *
-     * @return a new ID
+     * @return a new object
      */
     @Override
     public BodyId getBodyId() {

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

@@ -513,9 +513,9 @@ public float getHitReductionCosMaxAngle() {
     }
 
     /**
-     * Return the ID of the inner body. The character is unaffected.
+     * Copy the ID of the inner body. The character is unaffected.
      *
-     * @return the ID, or {@code null} if none
+     * @return a new object, or {@code null} if none
      */
     @Override
     public BodyId getInnerBodyId() {

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

@@ -516,9 +516,9 @@ public float getHitReductionCosMaxAngle() {
     }
 
     /**
-     * Return the ID of the inner body. The character is unaffected.
+     * Copy the ID of the inner body. The character is unaffected.
      *
-     * @return the ID, or {@code null} if none
+     * @return a new object, or {@code null} if none
      */
     @Override
     public BodyId getInnerBodyId() {

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

@@ -50,10 +50,10 @@ public class Contact extends JoltPhysicsObject implements ConstContact {
     // ConstContact methods
 
     /**
-     * Return the ID of the colliding body. The contact is unaffected. (native
+     * Copy the ID of the colliding body. The contact is unaffected. (native
      * attribute: mBodyB)
      *
-     * @return a new ID, or null if no colliding body
+     * @return a new object, or {@code null} if no colliding body
      */
     @Override
     public BodyId getBodyB() {

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

@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2024 Stephen Gold
+Copyright (c) 2024-2025 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
@@ -79,8 +79,8 @@ public float getPenetrationDepth() {
     }
 
     /**
-     * Return the ID of the first subshape that formed the manifold. The
-     * manifold is unaffected. (native attribute: mSubShapeID1)
+     * Copy the ID of the first subshape that formed the manifold. The manifold
+     * is unaffected. (native attribute: mSubShapeID1)
      *
      * @return a new object
      */
@@ -94,8 +94,8 @@ public SubShapeId getSubShapeId1() {
     }
 
     /**
-     * Return the ID of the 2nd subshape that formed the manifold. The manifold
-     * is unaffected. (native attribute: mSubShapeID2)
+     * Copy the ID of the 2nd subshape that formed the manifold. The manifold is
+     * unaffected. (native attribute: mSubShapeID2)
      *
      * @return a new object
      */

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

@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2024 Stephen Gold
+Copyright (c) 2024-2025 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
@@ -50,7 +50,7 @@ public SubShapeIdPair(long pairVa) {
     // ConstSubShapeIdPair methods
 
     /**
-     * Return the ID of the first body.
+     * Copy the ID of the first body.
      *
      * @return a new object
      */
@@ -64,7 +64,7 @@ public ConstBodyId getBody1Id() {
     }
 
     /**
-     * Return the ID of the 2nd body.
+     * Copy the ID of the 2nd body.
      *
      * @return a new object
      */
@@ -91,7 +91,7 @@ public long getHash() {
     }
 
     /**
-     * Return the ID of the first subshape.
+     * Copy the ID of the first subshape.
      *
      * @return a new object
      */
@@ -105,7 +105,7 @@ public ConstSubShapeId getSubShapeId1() {
     }
 
     /**
-     * Return the ID of the 2nd subshape.
+     * Copy the ID of the 2nd subshape.
      *
      * @return a new object
      */

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

@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2024 Stephen Gold
+Copyright (c) 2024-2025 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
@@ -81,7 +81,7 @@ public float getDifferentialRatio() {
     }
 
     /**
-     * Return the ID of the wheel powered by the engine. The settings are
+     * Return the index of the wheel powered by the engine. The settings are
      * unaffected. (native attribute: mDrivenWheel)
      *
      * @return the index of the driven wheel (≥0)