Skip to content

Commit

Permalink
javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
stephengold committed Nov 7, 2024
1 parent 3a4cabb commit ab2998a
Show file tree
Hide file tree
Showing 31 changed files with 34 additions and 31 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ public com.github.stephengold.joltjni.Character getPtr() {
}

/**
* Create a counted reference to the native {@code Character}.
* Create another counted reference to the native {@code Character}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public CharacterSettings getPtr() {
}

/**
* Create a counted reference to the native {@code CharacterSettings}.
* Create another counted reference to the native {@code CharacterSettings}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ public CharacterVirtual getPtr() {
}

/**
* Create a counted reference to the native {@code CharacterVirtual}.
* Create another counted reference to the native {@code CharacterVirtual}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ public void setInnerBodyLayer(int objectLayer) {
}

/**
* Alter the shape of the inner rigid body. (native attribute:
* Replace the shape of the inner rigid body. (native attribute:
* mInnerBodyShape)
*
* @param shape the desired shape, or null for no inner body (default=null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public CharacterVirtualSettings getPtr() {
}

/**
* Create a counted reference to the native {@code CharacterSettings}.
* Create another counted reference to the native {@code CharacterSettings}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public Constraint getPtr() {
}

/**
* Create a counted reference to the native {@code Constraint}.
* Create another counted reference to the native {@code Constraint}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public GroupFilter getPtr() {
}

/**
* Create a counted reference to the native {@code GroupFilter}.
* Create another counted reference to the native {@code GroupFilter}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@ public PathConstraintPath getPtr() {
}

/**
* Create a counted reference to the native {@code PathConstraintPath}.
* Create another counted reference to the native
* {@code PathConstraintPath}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public PhysicsMaterial getPtr() {
}

/**
* Create a counted reference to the native {@code PhysicsMaterial}.
* Create another counted reference to the native {@code PhysicsMaterial}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ public PhysicsScene getPtr() {
}

/**
* Create a counted reference to the native {@code PhysicsSceneRef}.
* Create another counted reference to the native {@code PhysicsScene}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ public Ragdoll getPtr() {
}

/**
* Create a counted reference to the native {@code RagdollRef}.
* Create another counted reference to the native {@code Ragdoll}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ public RagdollSettings getPtr() {
}

/**
* Create a counted reference to the native {@code RagdollSettingsRef}.
* Create another counted reference to the native {@code RagdollSettings}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/github/stephengold/joltjni/ShapeRef.java
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public Shape getPtr() {
}

/**
* Create a counted reference to the native {@code Shape}.
* Create another counted reference to the native {@code Shape}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public ConstShape getPtr() {
}

/**
* Create a counted reference to the native {@code Shape}.
* Create another counted reference to the native {@code Shape}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public ShapeSettings getPtr() {
}

/**
* Create a counted reference to the native {@code Shape}.
* Create another counted reference to the native {@code Shape}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ public SkeletalAnimation getPtr() {
}

/**
* Create a counted reference to the native {@code SkeletalAnimationRef}.
* Create another counted reference to the native {@code SkeletalAnimation}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public Skeleton getPtr() {
}

/**
* Create a counted reference to the native {@code SkeletonRef}.
* Create another counted reference to the native {@code Skeleton}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ public void createConstraints(
* @param bendType the desired type of bend constraint (not null,
* default=Distance)
* @param angleTolerance the desired tolerance for creating shear edges (in
* radians, default=2/45)
* radians, default=2*Pi/45)
*/
public void createConstraints(ConstVertexAttributes[] vertexAttributes,
EBendType bendType, float angleTolerance) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ public SoftBodySharedSettings getPtr() {
}

/**
* Create a counted reference to the native {@code SoftBodySharedSettings}.
* Create another counted reference to the native
* {@code SoftBodySharedSettings}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public TrackedVehicleController getPtr() {
}

/**
* Create a counted reference to the native
* Create another counted reference to the native
* {@code TrackedVehicleController}.
*
* @return a new JVM object with a new native object assigned
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public TwoBodyConstraint getPtr() {
}

/**
* Create a counted reference to the native {@code TwoBodyConstraint}.
* Create another counted reference to the native {@code TwoBodyConstraint}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public VehicleCollisionTesterCastCylinder getPtr() {
}

/**
* Create a counted reference to the native
* Create another counted reference to the native
* {@code VehicleCollisionTesterCastCylinder}.
*
* @return a new JVM object with a new native object assigned
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public VehicleCollisionTesterRay getPtr() {
}

/**
* Create a counted reference to the native
* Create another counted reference to the native
* {@code VehicleCollisionTesterRay}.
*
* @return a new JVM object with a new native object assigned
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ public VehicleCollisionTester getPtr() {
}

/**
* Create a counted reference to the native {@code VehicleCollisionTester}.
* Create another counted reference to the native
* {@code VehicleCollisionTester}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public VehicleConstraint getPtr() {
}

/**
* Create a counted reference to the native {@code VehicleConstraint}.
* Create another counted reference to the native {@code VehicleConstraint}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public VehicleController getPtr() {
}

/**
* Create a counted reference to the native {@code VehicleController}.
* Create another counted reference to the native {@code VehicleController}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public VehicleControllerSettings getPtr() {
}

/**
* Create a counted reference to the native
* Create another counted reference to the native
* {@code VehicleControllerSettings}.
*
* @return a new JVM object with a new native object assigned
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public WheelSettingsTv getPtr() {
}

/**
* Create a counted reference to the native {@code WheelSettingsTV}.
* Create another counted reference to the native {@code WheelSettingsTV}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public WheelSettingsWv getPtr() {
}

/**
* Create a counted reference to the native {@code WheelSettingsWv}.
* Create another counted reference to the native {@code WheelSettingsWv}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public WheeledVehicleController getPtr() {
}

/**
* Create a counted reference to the native
* Create another counted reference to the native
* {@code WheeledVehicleController}.
*
* @return a new JVM object with a new native object assigned
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ protected Ref() {
abstract public RefTarget getPtr();

/**
* Create a counted reference to the native {@code RefTarget}.
* Create another counted reference to the native {@code RefTarget}.
*
* @return a new JVM object with a new native object assigned
*/
Expand Down

0 comments on commit ab2998a

Please sign in to comment.