Wrong javadoc in Settings.java

Posts regarding potential bugs, enhancement requests, and general feedback on use of dyn4j
andreas
Posts: 8
Joined: Mon Aug 01, 2016 6:04 am

Wrong javadoc in Settings.java

Postby andreas » Mon Jun 19, 2017 4:19 pm

Hi William,
I just found a small mistake in the documetation of the Settings class

Code: Select all

* @throws IllegalArgumentException if positionConstraintSolverIterations is less than 5
*/
public void setPositionConstraintSolverIterations(int positionConstraintSolverIterations) {

resp.

Code: Select all

* @throws IllegalArgumentException if velocityConstraintSolverIterations is less than 5
*/
public void setVelocityConstraintSolverIterations(int velocityConstraintSolverIterations) {

should be

Code: Select all

* @throws IllegalArgumentException if positionConstraintSolverIterations is less than 1
*/
public void setPositionConstraintSolverIterations(int positionConstraintSolverIterations) {

resp.

Code: Select all

* @throws IllegalArgumentException if velocityConstraintSolverIterations is less than 1
*/
public void setVelocityConstraintSolverIterations(int velocityConstraintSolverIterations) {


Greetings
Andreas

William
Site Admin
Posts: 345
Joined: Sat Feb 06, 2010 10:23 pm

Re: Wrong javadoc in Settings.java

Postby William » Thu Jun 22, 2017 6:57 am

Thanks, I'll take care of it.

William

andreas
Posts: 8
Joined: Mon Aug 01, 2016 6:04 am

Re: Wrong javadoc in Settings.java

Postby andreas » Mon Jul 10, 2017 1:39 pm

I got another one in the documetation of the Body class: {@link Mass#getInertia()}

Code: Select all

   /**
    * Applies a linear impulse to this {@link Body} at its center of mass.
    * <p>
    * This method will wake-up the body if its sleeping.
    * <p>
    * This method does not apply the impulse if this body's mass
    * returns zero from the {@link Mass#getInertia()} method.
    * <p>
    * <b>NOTE:</b> Applying an impulse differs from applying a force and/or torque. Forces
    * and torques are stored in accumulators, but impulses are applied to the
    * velocities of the body immediately.
    * @param impulse the impulse to apply
    * @return {@link Body} this body
    * @throws NullPointerException if impulse is null
    * @since 3.1.1
    */
   public Body applyImpulse(Vector2 impulse) {


should be

Code: Select all

   /**
    * Applies a linear impulse to this {@link Body} at its center of mass.
    * <p>
    * This method will wake-up the body if its sleeping.
    * <p>
    * This method does not apply the impulse if this body's mass
    * returns zero from the {@link Mass#getMass()} method.
    * <p>
    * <b>NOTE:</b> Applying an impulse differs from applying a force and/or torque. Forces
    * and torques are stored in accumulators, but impulses are applied to the
    * velocities of the body immediately.
    * @param impulse the impulse to apply
    * @return {@link Body} this body
    * @throws NullPointerException if impulse is null
    * @since 3.1.1
    */
   public Body applyImpulse(Vector2 impulse) {


Return to “Bugs, Enhancements, Feedback”

Who is online

Users browsing this forum: No registered users and 1 guest