Skip to content

Commit

Permalink
readonly javadoc: add native type information
Browse files Browse the repository at this point in the history
  • Loading branch information
stephengold committed Sep 10, 2024
1 parent a423bd7 commit d501ce7
Show file tree
Hide file tree
Showing 32 changed files with 49 additions and 32 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.Vec3;

/**
* Read-only access to an {@code AaBox}.
* Read-only access to an {@code AaBox}. (native type: const AABox)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.enumerate.EMotionType;

/**
* Read-only access to a {@code Body}.
* Read-only access to a {@code Body}. (native type: const Body)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.enumerate.EOverrideMassProperties;

/**
* Read-only access to a {@code BodyCreationSettings} object.
* Read-only access to a {@code BodyCreationSettings} object. (native type:
* const BodyCreationSettings)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.BodyId;

/**
* Read-only access to a {@code BodyId}.
* Read-only access to a {@code BodyId}. (native type: const BodyID)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ of this software and associated documentation files (the "Software"), to deal
package com.github.stephengold.joltjni.readonly;

/**
* Read-only access to a {@code BroadPhaseLayerInterface}.
* Read-only access to a {@code BroadPhaseLayerInterface}. (native type: const
* BroadPhaseLayerInterface)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.Vec3;

/**
* Read-only access to a {@code Character}.
* Read-only access to a {@code Character}. (native type: const Character)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.enumerate.EGroundState;

/**
* Read-only access to a {@code CharacterBase}.
* Read-only access to a {@code CharacterBase}. (native type: const
* CharacterBase)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.Vec3;

/**
* Read-only access to a {@code CharacterBaseSettings} object.
* Read-only access to a {@code CharacterBaseSettings} object. (native type:
* const CharacterBaseSettings)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ of this software and associated documentation files (the "Software"), to deal
package com.github.stephengold.joltjni.readonly;

/**
* Read-only access to a {@code CharacterSettings} object.
* Read-only access to a {@code CharacterSettings} object. (native type: const
* CharacterSettings)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.Vec3;

/**
* Read-only access to a {@code CharacterVirtual}.
* Read-only access to a {@code CharacterVirtual}. (native type: const
* CharacterVirtual)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.enumerate.EBackFaceMode;

/**
* Read-only access to a {@code CharacterVirtualSettings} object.
* Read-only access to a {@code CharacterVirtualSettings} object. (native type:
* const CharacterVirtualSettings)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.Vec3;

/**
* Read-only access to a {@code CollideShapeResult}.
* Read-only access to a {@code CollideShapeResult}. (native type: const
* CollideShapeResult)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.enumerate.EConstraintType;

/**
* Read-only access to a {@code Constraint}.
* Read-only access to a {@code Constraint}. (native type: const Constraint)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ of this software and associated documentation files (the "Software"), to deal
package com.github.stephengold.joltjni.readonly;

/**
* Read-only access to a {@code ConstraintSettings} object.
* Read-only access to a {@code ConstraintSettings} object. (native type: const
* ConstraintSettings)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.enumerate.EMotionType;

/**
* Read-only access to a {@code Contact}.
* Read-only access to a {@code Contact}. (native type: const Contact)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.Vec3;

/**
* Read-only access to a {@code ContactManifold}.
* Read-only access to a {@code ContactManifold}. (native type: const
* ContactManifold)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.Vec3;

/**
* Read-only access to a {@code ContactSettings} object.
* Read-only access to a {@code ContactSettings} object. (native type: const
* ContactSettings)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ of this software and associated documentation files (the "Software"), to deal
package com.github.stephengold.joltjni.readonly;

/**
* Read-only access to a {@code ConvexShapeSettings} object.
* Read-only access to a {@code ConvexShapeSettings} object. (native type: const
* ConvexShapeSettings)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.Vec3;

/**
* Read-only access to a {@code MassProperties} object.
* Read-only access to a {@code MassProperties} object. (native type: const
* MassProperties)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ of this software and associated documentation files (the "Software"), to deal
package com.github.stephengold.joltjni.readonly;

/**
* Read-only access to an {@code ObjectLayerPairFilter}.
* Read-only access to an {@code ObjectLayerPairFilter}. (native type: const
* ObjectLayerPairFilter)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ of this software and associated documentation files (the "Software"), to deal
package com.github.stephengold.joltjni.readonly;

/**
* Read-only access to an {@code ObjectVsBroadPhaseLayerFilter}.
* Read-only access to an {@code ObjectVsBroadPhaseLayerFilter}. (native type:
* const ObjectVsBroadPhaseLayerFilter)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ of this software and associated documentation files (the "Software"), to deal
package com.github.stephengold.joltjni.readonly;

/**
* Read-only access to a {@code PhysicsMaterial}.
* Read-only access to a {@code PhysicsMaterial}. (native type: const
* PhysicsMaterial)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.Vec3;

/**
* Read-only access to an {@code Plane}.
* Read-only access to an {@code Plane}. (native type: const Plane)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ of this software and associated documentation files (the "Software"), to deal
import java.nio.FloatBuffer;

/**
* Read-only access to a {@code Shape}.
* Read-only access to a {@code Shape}. (native type: const Shape)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ of this software and associated documentation files (the "Software"), to deal
package com.github.stephengold.joltjni.readonly;

/**
* Read-only access to a {@code SubShapeId}.
* Read-only access to a {@code SubShapeId}. (native type: const SubShapeID)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ of this software and associated documentation files (the "Software"), to deal
package com.github.stephengold.joltjni.readonly;

/**
* Read-only access to a {@code SubShapeIdPair}.
* Read-only access to a {@code SubShapeIdPair}. (native type: const
* SubShapeIDPair)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.Vec3;

/**
* Read-only access to a {@code Mat44}.
* Read-only access to a {@code Mat44}. (native type: const Mat44)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ of this software and associated documentation files (the "Software"), to deal
package com.github.stephengold.joltjni.readonly;

/**
* Read-only access to a {@code Quat}.
* Read-only access to a {@code Quat}. (native type: const Quat)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ of this software and associated documentation files (the "Software"), to deal
package com.github.stephengold.joltjni.readonly;

/**
* Read-only access to an {@code RMat44}.
* Read-only access to an {@code RMat44}. (native type: const RMat44)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ of this software and associated documentation files (the "Software"), to deal
package com.github.stephengold.joltjni.readonly;

/**
* Read-only access to an {@code RVec3}.
* Read-only access to an {@code RVec3}. (native type: const RVec3)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ of this software and associated documentation files (the "Software"), to deal
package com.github.stephengold.joltjni.readonly;

/**
* Read-only access to a {@code UVec4}.
* Read-only access to a {@code UVec4}. (native type: const UVec4)
*
* @author Stephen Gold [email protected]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ of this software and associated documentation files (the "Software"), to deal
import com.github.stephengold.joltjni.Vec3;

/**
* Read-only access to a {@code Vec3}.
* Read-only access to a {@code Vec3}. (native type: const Vec3)
*
* @author Stephen Gold [email protected]
*/
Expand Down

0 comments on commit d501ce7

Please sign in to comment.