apps: javadoc

stephengold · May 18, 2024 · 2fa7fe8 · 2fa7fe8
1 parent 9f1e348
commit 2fa7fe8
Show file tree

Hide file tree

Showing 13 changed files with 26 additions and 26 deletions.
diff --git a/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloCharacter.java b/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloCharacter.java
@@ -135,7 +135,7 @@ public void populateSpace() {
      * Callback from Bullet, invoked just before each simulation step.
      *
      * @param space the space that's about to be stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void prePhysicsTick(PhysicsSpace space, float timeStep) {
@@ -149,7 +149,7 @@ public void prePhysicsTick(PhysicsSpace space, float timeStep) {
      * Callback from Bullet, invoked just after each simulation step.
      *
      * @param space the space that was just stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void physicsTick(PhysicsSpace space, float timeStep) {

diff --git a/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloDeactivation.java b/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloDeactivation.java
@@ -146,7 +146,7 @@ public void updatePhysics(float wallClockSeconds) {
      * Callback from Bullet, invoked just before each simulation step.
      *
      * @param space the space that's about to be stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void prePhysicsTick(PhysicsSpace space, float timeStep) {
@@ -157,7 +157,7 @@ public void prePhysicsTick(PhysicsSpace space, float timeStep) {
      * Callback from Bullet, invoked just after each simulation step.
      *
      * @param space the space that was just stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void physicsTick(PhysicsSpace space, float timeStep) {

diff --git a/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloDoor.java b/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloDoor.java
@@ -218,7 +218,7 @@ public void updateWindowTitle() {
      * Callback from Bullet, invoked just before each simulation step.
      *
      * @param space the space that's about to be stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void prePhysicsTick(PhysicsSpace space, float timeStep) {
@@ -231,7 +231,7 @@ public void prePhysicsTick(PhysicsSpace space, float timeStep) {
      * Callback from Bullet, invoked just after each simulation step.
      *
      * @param space the space that was just stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void physicsTick(PhysicsSpace space, float timeStep) {

diff --git a/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloDoubleEnded.java b/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloDoubleEnded.java
@@ -203,7 +203,7 @@ public void updateWindowTitle() {
      * Callback from Bullet, invoked just before each simulation step.
      *
      * @param space the space that's about to be stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void prePhysicsTick(PhysicsSpace space, float timeStep) {
@@ -216,7 +216,7 @@ public void prePhysicsTick(PhysicsSpace space, float timeStep) {
      * Callback from Bullet, invoked just after each simulation step.
      *
      * @param space the space that was just stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void physicsTick(PhysicsSpace space, float timeStep) {

diff --git a/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloGhost.java b/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloGhost.java
@@ -186,7 +186,7 @@ public void updateWindowTitle() {
      * Callback from Bullet, invoked just before each simulation step.
      *
      * @param space the space that's about to be stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void prePhysicsTick(PhysicsSpace space, float timeStep) {
@@ -225,7 +225,7 @@ public void prePhysicsTick(PhysicsSpace space, float timeStep) {
      * Callback from Bullet, invoked just after each simulation step.
      *
      * @param space the space that was just stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void physicsTick(PhysicsSpace space, float timeStep) {

diff --git a/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloJoint.java b/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloJoint.java
@@ -201,7 +201,7 @@ public void updateWindowTitle() {
      * Callback from Bullet, invoked just before each simulation step.
      *
      * @param space the space that's about to be stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void prePhysicsTick(PhysicsSpace space, float timeStep) {
@@ -214,7 +214,7 @@ public void prePhysicsTick(PhysicsSpace space, float timeStep) {
      * Callback from Bullet, invoked just after each simulation step.
      *
      * @param space the space that was just stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void physicsTick(PhysicsSpace space, float timeStep) {

diff --git a/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloKinematics.java b/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloKinematics.java
@@ -141,7 +141,7 @@ public void updatePhysics(float wallClockSeconds) {
      * Callback from Bullet, invoked just before each simulation step.
      *
      * @param space the space that's about to be stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void prePhysicsTick(PhysicsSpace space, float timeStep) {
@@ -162,7 +162,7 @@ public void prePhysicsTick(PhysicsSpace space, float timeStep) {
      * Callback from Bullet, invoked just after each simulation step.
      *
      * @param space the space that was just stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void physicsTick(PhysicsSpace space, float timeStep) {

diff --git a/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloLimit.java b/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloLimit.java
@@ -214,7 +214,7 @@ public void updateWindowTitle() {
      * Callback from Bullet, invoked just before each simulation step.
      *
      * @param space the space that's about to be stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void prePhysicsTick(PhysicsSpace space, float timeStep) {
@@ -227,7 +227,7 @@ public void prePhysicsTick(PhysicsSpace space, float timeStep) {
      * Callback from Bullet, invoked just after each simulation step.
      *
      * @param space the space that was just stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void physicsTick(PhysicsSpace space, float timeStep) {

diff --git a/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloNewHinge.java b/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloNewHinge.java
@@ -187,7 +187,7 @@ public void populateSpace() {
      * Callback from Bullet, invoked just before each simulation step.
      *
      * @param space the space that's about to be stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void prePhysicsTick(PhysicsSpace space, float timeStep) {
@@ -203,7 +203,7 @@ public void prePhysicsTick(PhysicsSpace space, float timeStep) {
      * Callback from Bullet, invoked just after each simulation step.
      *
      * @param space the space that was just stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void physicsTick(PhysicsSpace space, float timeStep) {

diff --git a/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloNonUniformGravity.java b/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloNonUniformGravity.java
@@ -149,7 +149,7 @@ public void updatePhysics(float wallClockSeconds) {
      * Callback from Bullet, invoked just before each simulation step.
      *
      * @param space the space that's about to be stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void prePhysicsTick(PhysicsSpace space, float timeStep) {
@@ -165,7 +165,7 @@ public void prePhysicsTick(PhysicsSpace space, float timeStep) {
      * Callback from Bullet, invoked just after each simulation step.
      *
      * @param space the space that was just stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void physicsTick(PhysicsSpace space, float timeStep) {

diff --git a/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloSpring.java b/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloSpring.java
@@ -214,7 +214,7 @@ public void updateWindowTitle() {
      * Callback from Bullet, invoked just before each simulation step.
      *
      * @param space the space that's about to be stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void prePhysicsTick(PhysicsSpace space, float timeStep) {
@@ -227,7 +227,7 @@ public void prePhysicsTick(PhysicsSpace space, float timeStep) {
      * Callback from Bullet, invoked just after each simulation step.
      *
      * @param space the space that was just stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void physicsTick(PhysicsSpace space, float timeStep) {

diff --git a/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloWalk.java b/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloWalk.java
@@ -162,7 +162,7 @@ public void updateWindowTitle() {
      * Callback from Bullet, invoked just before each simulation step.
      *
      * @param space the space that's about to be stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void prePhysicsTick(PhysicsSpace space, float timeStep) {
@@ -190,7 +190,7 @@ public void prePhysicsTick(PhysicsSpace space, float timeStep) {
      * Callback from Bullet, invoked just after each simulation step.
      *
      * @param space the space that was just stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void physicsTick(PhysicsSpace space, float timeStep) {

diff --git a/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloWind.java b/apps/src/main/java/com/github/stephengold/lbjexamples/apps/HelloWind.java
@@ -231,7 +231,7 @@ public void updateWindowTitle() {
      * Callback from Bullet, invoked just before each simulation step.
      *
      * @param space the space that's about to be stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void prePhysicsTick(PhysicsSpace space, float timeStep) {
@@ -252,7 +252,7 @@ public void prePhysicsTick(PhysicsSpace space, float timeStep) {
      * Callback from Bullet, invoked just after each simulation step.
      *
      * @param space the space that was just stepped (not null)
-     * @param timeStep the time per simulation step (in seconds, &ge;0)
+     * @param timeStep the duration of the simulation step (in seconds, &ge;0)
      */
     @Override
     public void physicsTick(PhysicsSpace space, float timeStep) {