From f5c592cf4096d92556511e33340561620de112d2 Mon Sep 17 00:00:00 2001
From: stephengold <sgold@sonic.net>
Date: Tue, 10 Dec 2024 13:06:17 -0800
Subject: [PATCH] javadoc

---
 .../java/com/github/stephengold/joltjni/BodyIdArray.java  | 8 ++++----
 .../java/com/github/stephengold/joltjni/BodyIdVector.java | 6 +++---
 .../java/com/github/stephengold/joltjni/RagdollRef.java   | 3 ++-
 .../com/github/stephengold/joltjni/RagdollSettings.java   | 2 +-
 4 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/src/main/java/com/github/stephengold/joltjni/BodyIdArray.java b/src/main/java/com/github/stephengold/joltjni/BodyIdArray.java
index d04ef9bb..752b4a34 100644
--- a/src/main/java/com/github/stephengold/joltjni/BodyIdArray.java
+++ b/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 (&ge;0)
+     * @param elementIndex the index from which to copy the ID (&ge;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 (&ge;0)
-     * @param id the ID to put (not null)
+     * @param elementIndex the index at which to store the ID (&ge;0)
+     * @param id the ID to store (not null, unaffected)
      */
     public void set(int elementIndex, BodyId id) {
         long vectorId = va();
diff --git a/src/main/java/com/github/stephengold/joltjni/BodyIdVector.java b/src/main/java/com/github/stephengold/joltjni/BodyIdVector.java
index 0b1467f9..b7b941f9 100644
--- a/src/main/java/com/github/stephengold/joltjni/BodyIdVector.java
+++ b/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 (&ge;0)
-     * @param id the ID to put (not null)
+     * @param elementIndex the index at which to store the ID (&ge;0)
+     * @param id the ID to store (not null)
      */
     @Override
     public void set(int elementIndex, BodyId id) {
diff --git a/src/main/java/com/github/stephengold/joltjni/RagdollRef.java b/src/main/java/com/github/stephengold/joltjni/RagdollRef.java
index f1e75148..26026c3f 100644
--- a/src/main/java/com/github/stephengold/joltjni/RagdollRef.java
+++ b/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} &rarr; use the locking body interface,
+     * {@code false} &rarr; use the non-locking body interface (default=true)
      */
     public void getRootTransform(
             RVec3 storeLocation, Quat storeOrientation, boolean lockBodies) {
diff --git a/src/main/java/com/github/stephengold/joltjni/RagdollSettings.java b/src/main/java/com/github/stephengold/joltjni/RagdollSettings.java
index 719d10a3..51b1d268 100644
--- a/src/main/java/com/github/stephengold/joltjni/RagdollSettings.java
+++ b/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