javadoc

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

@@ -47,7 +47,7 @@ public BodyIdArray(int length) {
     /**
      * Copy the ID at the specified index.
      *
-     * @param elementIndex the index from which to get the ID (≥0)
+     * @param elementIndex the index from which to copy the ID (≥0)
      * @return a new JVM object with the pre-existing native object assigned
      */
     public ConstBodyId get(int elementIndex) {
@@ -59,10 +59,10 @@ public ConstBodyId get(int elementIndex) {
     }
 
     /**
-     * Alter the specified ID at the specified index.
+     * Store the specified ID at the specified index.
      *
-     * @param elementIndex the index at which to put the ID (≥0)
-     * @param id the ID to put (not null)
+     * @param elementIndex the index at which to store the ID (≥0)
+     * @param id the ID to store (not null, unaffected)
      */
     public void set(int elementIndex, BodyId id) {
         long vectorId = va();

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

@@ -151,10 +151,10 @@ public void resize(int numIds) {
     }
 
     /**
-     * Put the specified ID at the specified index.
+     * Store the specified ID at the specified index.
      *
-     * @param elementIndex the index at which to put the ID (≥0)
-     * @param id the ID to put (not null)
+     * @param elementIndex the index at which to store the ID (≥0)
+     * @param id the ID to store (not null)
      */
     @Override
     public void set(int elementIndex, BodyId id) {

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

@@ -134,7 +134,8 @@ public void getRootTransform(RVec3 storeLocation, Quat storeOrientation) {
      * @param storeLocation storage for the root location (not null, modified)
      * @param storeOrientation storage for the root orientation (not null,
      * modified)
-     * @param lockBodies (default=true)
+     * @param lockBodies {@code true} → use the locking body interface,
+     * {@code false} → use the non-locking body interface (default=true)
      */
     public void getRootTransform(
             RVec3 storeLocation, Quat storeOrientation, boolean lockBodies) {

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

@@ -69,7 +69,7 @@ public void calculateConstraintIndexToBodyIdxPair() {
     }
 
     /**
-     * Generate a ragdoll instance from the settings.
+     * Generate a ragdoll instance from the settings, which are unaffected.
      *
      * @param groupId the collision group for the bodies
      * @param userData the desired user-data value