Improve docs

Author: Josef-Friedrich

jbox2d-library/src/main/java/de/pirckheimer_gymnasium/jbox2d/dynamics/joints/DistanceJoint.java

@@ -49,7 +49,11 @@
  * These points imply the length of the distance constraint.
  * </p>
  *
- * <p><img src="https://github.com/engine-pi/jbox2d/blob/main/misc/images/joints/distance_joint.svg" alt="distance joint"></p>
+ * <p>
+ * <img src=
+ * "https://github.com/engine-pi/jbox2d/blob/main/misc/images/joints/distance_joint.svg"
+ * alt="distance joint">
+ * </p>
  *
  * <p>
  * Here is an example of a distance joint definition. In this case we decide to

jbox2d-library/src/main/java/de/pirckheimer_gymnasium/jbox2d/dynamics/joints/GearJoint.java

@@ -57,7 +57,11 @@
  * a prismatic joint, then the ratio will have units of length or units of
  * 1/length.
  *
- * <p><img src="https://github.com/engine-pi/jbox2d/blob/main/misc/images/joints/gear_joint.gif" alt="gear joint"></p>
+ * <p>
+ * <img src=
+ * "https://github.com/engine-pi/jbox2d/blob/main/misc/images/joints/gear_joint.gif"
+ * alt="gear joint">
+ * </p>
  *
  * @warning The revolute and prismatic joints must be attached to fixed bodies
  *          (which must be body1 on those joints).

jbox2d-library/src/main/java/de/pirckheimer_gymnasium/jbox2d/dynamics/joints/Joint.java

@@ -33,20 +33,26 @@
  * The base joint class. Joints are used to constrain two bodies together in
  * various fashions. Some joints also feature limits and motors.
  *
- * <p>Joints are used to constrain bodies to the world or to each other. Typical
+ * <p>
+ * Joints are used to constrain bodies to the world or to each other. Typical
  * examples in games include ragdolls, teeters, and pulleys. Joints can be
- * combined in many different ways to create interesting motions.</p>
+ * combined in many different ways to create interesting motions.
+ * </p>
  *
- * <p>Some joints provide limits so you can control the range of motion. Some joint
+ * <p>
+ * Some joints provide limits so you can control the range of motion. Some joint
  * provide motors which can be used to drive the joint at a prescribed speed
- * until a prescribed force/torque is exceeded.</p>
+ * until a prescribed force/torque is exceeded.
+ * </p>
  *
- * <p>Joint motors can be used in many ways. You can use motors to control position
+ * <p>
+ * Joint motors can be used in many ways. You can use motors to control position
  * by specifying a joint velocity that is proportional to the difference between
  * the actual and desired position. You can also use motors to simulate joint
  * friction: set the joint velocity to zero and provide a small, but significant
  * maximum motor force/torque. Then the motor will attempt to keep the joint
- * from moving until the load becomes too strong.</p>
+ * from moving until the load becomes too strong.
+ * </p>
  *
  * https://box2d.org/documentation/md__d_1__git_hub_box2d_docs_dynamics.html#autotoc_md81
  *

jbox2d-library/src/main/java/de/pirckheimer_gymnasium/jbox2d/dynamics/joints/JointDef.java

@@ -38,18 +38,17 @@
  * <p>
  * You can specify user data for any joint type and you can provide a flag to
  * prevent the attached bodies from colliding with each other. This is actually
- * the default behavior and you must set the
- * {@link JointDef#collideConnectedcollideConnected} Boolean to allow collision
- * between to connected bodies.
+ * the default behavior and you must set the {@link JointDef#collideConnected}
+ * Boolean to allow collision between to connected bodies.
  * </p>
  *
  * <p>
  * Many joint definitions require that you provide some geometric data. Often a
  * joint will be defined by anchor points. These are points fixed in the
  * attached bodies. jbox2d requires these points to be specified in local
  * coordinates. This way the joint can be specified even when the current body
- * transforms violate the joint constraint - a common occurrence when a game
- * is saved and reloaded. Additionally, some joint definitions need to know the
+ * transforms violate the joint constraint - a common occurrence when a game is
+ * saved and reloaded. Additionally, some joint definitions need to know the
  * default relative angle between the bodies. This is necessary to constrain
  * rotation correctly.
  * </p>

jbox2d-library/src/main/java/de/pirckheimer_gymnasium/jbox2d/dynamics/joints/PrismaticJoint.java

@@ -102,7 +102,11 @@
  * joint limit to restrict the range of motion and a joint motor to drive the
  * motion or to model joint friction.
  *
- * <p><img src="https://github.com/engine-pi/jbox2d/blob/main/misc/images/joints/prismatic_joint.svg" alt="prismatic joint"></p>
+ * <p>
+ * <img src=
+ * "https://github.com/engine-pi/jbox2d/blob/main/misc/images/joints/prismatic_joint.svg"
+ * alt="prismatic joint">
+ * </p>
  *
  * @author Daniel Murphy
  */
@@ -163,7 +167,7 @@ public class PrismaticJoint extends Joint
     private final Mat33 K;
 
     /**
-     * effective mass for motor/limit translational constraint.
+     * The effective mass for motor/limit translational constraint.
      */
     private float motorMass;
 

jbox2d-library/src/main/java/de/pirckheimer_gymnasium/jbox2d/dynamics/joints/PulleyJoint.java

@@ -39,7 +39,11 @@
  * should also cover the anchor points with static shapes to prevent one side
  * from going to zero length.
  *
- * <p><img src="https://github.com/engine-pi/jbox2d/blob/main/misc/images/joints/pulley_joint.gif" alt="pulley joint"></p>
+ * <p>
+ * <img src=
+ * "https://github.com/engine-pi/jbox2d/blob/main/misc/images/joints/pulley_joint.gif"
+ * alt="pulley joint">
+ * </p>
  *
  * @author Daniel Murphy
  */

jbox2d-library/src/main/java/de/pirckheimer_gymnasium/jbox2d/dynamics/joints/RevoluteJoint.java

@@ -53,7 +53,11 @@
  * relative rotation about the shared point. A maximum motor torque is provided
  * so that infinite forces are not generated.
  *
- * <p><img src="https://github.com/engine-pi/jbox2d/blob/main/misc/images/joints/revolute_joint.svg" alt="revolute joint"></p>
+ * <p>
+ * <img src=
+ * "https://github.com/engine-pi/jbox2d/blob/main/misc/images/joints/revolute_joint.svg"
+ * alt="revolute joint">
+ * </p>
  *
  * @author Daniel Murphy
  */

jbox2d-library/src/main/java/de/pirckheimer_gymnasium/jbox2d/dynamics/joints/RevoluteJointDef.java

@@ -21,28 +21,6 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-/*
- * JBox2D - A Java Port of Erin Catto's Box2D
- *
- * JBox2D homepage: http://jbox2d.sourceforge.net/
- * Box2D homepage: http://www.box2d.org
- *
- * This software is provided 'as-is', without any express or implied
- * warranty.  In no event will the authors be held liable for any damages
- * arising from the use of this software.
- *
- * Permission is granted to anyone to use this software for any purpose,
- * including commercial applications, and to alter it and redistribute it
- * freely, subject to the following restrictions:
- *
- * 1. The origin of this software must not be misrepresented; you must not
- * claim that you wrote the original software. If you use this software
- * in a product, an acknowledgment in the product documentation would be
- * appreciated but is not required.
- * 2. Altered source versions must be plainly marked as such, and must not be
- * misrepresented as being the original software.
- * 3. This notice may not be removed or altered from any source distribution.
- */
 package de.pirckheimer_gymnasium.jbox2d.dynamics.joints;
 
 import de.pirckheimer_gymnasium.jbox2d.common.Vec2;

jbox2d-library/src/main/java/de/pirckheimer_gymnasium/jbox2d/dynamics/joints/WheelJoint.java

@@ -50,7 +50,11 @@
  * to restrict the range of motion and a joint motor to drive the rotation or to
  * model rotational friction. This joint is designed for vehicle suspensions.
  *
- * <p><img src="https://github.com/engine-pi/jbox2d/blob/main/misc/images/joints/wheel_joint.svg" alt="wheel joint"></p>
+ * <p>
+ * <img src=
+ * "https://github.com/engine-pi/jbox2d/blob/main/misc/images/joints/wheel_joint.svg"
+ * alt="wheel joint">
+ * </p>
  *
  * @author Daniel Murphy
  */