main: javadoc

stephengold · Jan 6, 2025 · e19afcd · e19afcd
1 parent 654687c
commit e19afcd
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 13 deletions.
diff --git a/src/main/java/com/github/stephengold/joltjni/BodyManagerDrawSettings.java b/src/main/java/com/github/stephengold/joltjni/BodyManagerDrawSettings.java
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2024 Stephen Gold
+Copyright (c) 2024-2025 Stephen Gold
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -23,7 +23,7 @@ of this software and associated documentation files (the "Software"), to deal
 
 /**
  * Render settings for debug visualization. (native type:
- * BodyManager::DrawSettings)
+ * {@code BodyManager::DrawSettings})
  *
  * @author Stephen Gold [email protected]
  */

diff --git a/src/main/java/com/github/stephengold/joltjni/Character.java b/src/main/java/com/github/stephengold/joltjni/Character.java
@@ -67,7 +67,7 @@ public class Character extends CharacterBase implements ConstCharacter {
      * @param orientation the desired initial orientation (in system
      * coordinates, not null, unaffected)
      * @param userData the desired user-data value
-     * @param system the system to which the character will be added (not null)
+     * @param system where to add the body (not null)
      */
     public Character(ConstCharacterSettings settings, RVec3Arg location,
             QuatArg orientation, long userData, PhysicsSystem system) {

diff --git a/src/main/java/com/github/stephengold/joltjni/CharacterVirtual.java b/src/main/java/com/github/stephengold/joltjni/CharacterVirtual.java
@@ -80,7 +80,7 @@ public CharacterVirtual(long characterVa, PhysicsSystem physicsSystem) {
      * @param orientation the desired initial orientation (in system
      * coordinates, not null, unaffected)
      * @param userData the desired user-data value
-     * @param system the system to which the character will be added (not null)
+     * @param system where to add the body (not null)
      */
     public CharacterVirtual(
             ConstCharacterVirtualSettings settings, RVec3Arg location,

diff --git a/src/main/java/com/github/stephengold/joltjni/CombineFunction.java b/src/main/java/com/github/stephengold/joltjni/CombineFunction.java
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2024 Stephen Gold
+Copyright (c) 2024-2025 Stephen Gold
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -23,7 +23,7 @@ of this software and associated documentation files (the "Software"), to deal
 
 /**
  * Combine the restitution or friction of 2 bodies. (native type:
- * ContactConstraintManager::CombineFunction)
+ * {@code ContactConstraintManager::CombineFunction})
  *
  * @author Stephen Gold [email protected]
  */

diff --git a/src/main/java/com/github/stephengold/joltjni/Contact.java b/src/main/java/com/github/stephengold/joltjni/Contact.java
@@ -26,7 +26,7 @@ of this software and associated documentation files (the "Software"), to deal
 
 /**
  * Describe a contact between a {@code Character} and a body or another
- * character.
+ * character. (native type: {@code CharacterVirtual::Contact})
  *
  * @author Stephen Gold [email protected]
  */

diff --git a/src/main/java/com/github/stephengold/joltjni/JointState.java b/src/main/java/com/github/stephengold/joltjni/JointState.java
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2024 Stephen Gold
+Copyright (c) 2024-2025 Stephen Gold
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -26,7 +26,7 @@ of this software and associated documentation files (the "Software"), to deal
 
 /**
  * The local-space coordinate transform of an animation joint relative to its
- * parent joint. (native type: SkeletonPose::JointState)
+ * parent joint. (native type: {@code SkeletonPose::JointState})
  *
  * @author Stephen Gold [email protected]
  */

diff --git a/src/main/java/com/github/stephengold/joltjni/Part.java b/src/main/java/com/github/stephengold/joltjni/Part.java
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2024 Stephen Gold
+Copyright (c) 2024-2025 Stephen Gold
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -25,7 +25,7 @@ of this software and associated documentation files (the "Software"), to deal
 
 /**
  * Settings used to generate a rigid body in a {@code Ragdoll}. (native type:
- * RagdollSettings::Part)
+ * {@code RagdollSettings::Part})
  *
  * @author Stephen Gold [email protected]
  */

diff --git a/src/main/java/com/github/stephengold/joltjni/SkeletonPoseDrawSettings.java b/src/main/java/com/github/stephengold/joltjni/SkeletonPoseDrawSettings.java
@@ -1,5 +1,5 @@
 /*
-Copyright (c) 2024 Stephen Gold
+Copyright (c) 2024-2025 Stephen Gold
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -23,7 +23,7 @@ of this software and associated documentation files (the "Software"), to deal
 
 /**
  * Render settings for debug visualization. (native type:
- * SkeletonPose::DrawSettings)
+ * {@code SkeletonPose::DrawSettings})
  *
  * @author Stephen Gold [email protected]
  */