Skip to content

Commit

Permalink
javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
stephengold committed Jul 8, 2024
1 parent 2f43615 commit 0b9025f
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -262,9 +262,10 @@ public Quat getRotation() {
}

/**
* Access the shape.
* Access the {@code Shape}.
*
* @return a new JVM object referencing the pre-existing native object
* @return a new JVM object referencing the pre-existing native object, or
* {@code null} if the native field is {@code NULL}
*/
public Shape getShape() {
long bodySettingsVa = va();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ protected JobSystem() {
/**
* Return maximum number of jobs that can execute concurrently.
*
* @return the count (≥1)
* @return the number (≥1)
*/
public int getMaxConcurrency() {
long systemVa = va();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public JobSystemThreadPool(int maxJobs, int maxBarriers) {
* time
* @param maxBarriers the maximum number of barriers that can be allocated
* at one time
* @param numThreads the number of worker threads to start (≥1) or -1 to
* @param numThreads the number of worker threads to start (≥0) or -1 to
* auto detect
*/
public JobSystemThreadPool(int maxJobs, int maxBarriers, int numThreads) {
Expand Down
2 changes: 1 addition & 1 deletion src/test/java/testjoltjni/junit/Test001.java
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ of this software and associated documentation files (the "Software"), to deal
import testjoltjni.Utils;

/**
* An automated test for jolt-jni using JUnit 4.
* Automated JUnit4 tests for jolt-jni.
*
* @author Stephen Gold [email protected]
*/
Expand Down
3 changes: 1 addition & 2 deletions src/test/java/testjoltjni/junit/Test002.java
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,7 @@ of this software and associated documentation files (the "Software"), to deal
import testjoltjni.Utils;

/**
* An automated test for jolt-jni using JUnit 4: drop 1,764 convex shapes onto a
* static mesh shape.
* Automated JUnit4 tests for jolt-jni.
* <p>
* Derived from PerformanceTest/ConvexVsMeshScene.h by Jorrit Rouwe.
*
Expand Down
6 changes: 3 additions & 3 deletions src/test/java/testjoltjni/junit/Test003.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ of this software and associated documentation files (the "Software"), to deal
import testjoltjni.Utils;

/**
* An automated JUnit4 test for jolt-jni object creation, destruction, and
* defaults.
* Automated JUnit4 tests for jolt-jni object creation, destruction, accessors,
* and defaults.
*
* @author Stephen Gold [email protected]
*/
Expand All @@ -47,7 +47,7 @@ public class Test003 {
// new methods exposed

/**
* Test jolt-jni object creation, destruction, and defaults.
* Test object creation, destruction, accessors, and defaults.
*/
@Test
public void test003() {
Expand Down

0 comments on commit 0b9025f

Please sign in to comment.