Merge pull request #175 from jCodingStuff/Julian

Javadoc advances

Author: jCodingStuff

core/src/com/group/golf/Physics/Collision.java

@@ -259,7 +259,7 @@ public boolean ballInWater() {
 
     /**
      * Get access to the ball instance being handled
-     * @return
+     * @return the instance of ball
      */
     public Ball getBall() {
         return ball;

core/src/com/group/golf/Physics/Physics.java

@@ -60,6 +60,7 @@ public Physics(Physics other) {
 
     /**
      * Hit the ball
+     * @param ball the ball to hit
      * @param xLength the length that the mouse was dragged horizontally
      * @param yLength the length that the mouse was dragged vertically
      */
@@ -268,7 +269,7 @@ public void setWalls(List<Rectangle> walls) {
 
     /**
      * Get access to the Collision instance managed by the physics engine
-     * @return
+     * @return the collision instance
      */
     public Collision getCollision() {
         return collision;

core/src/com/group/golf/genetics/InverseScoreComputer.java

@@ -5,7 +5,7 @@
 
 /**
  * Class InverseScoreComputer computes fitness for simple courses
- * @auther Julian Marrades
+ * @author Julian Marrades
  */
 public class InverseScoreComputer implements ScoreComputer {
 

core/src/com/group/golf/genetics/Mutation.java

@@ -2,7 +2,7 @@
 
 /**
  * An interface for mutation algorithms
- * @auther Julian Marrades
+ * @author Julian Marrades
  */
 public interface Mutation {
 

core/src/com/group/golf/genetics/SimpleCrossOver.java

@@ -5,7 +5,7 @@
 
 /**
  * Simple crossover algorithm
- * @auther Julian Marrades
+ * @author Julian Marrades
  */
 public class SimpleCrossOver implements CrossOver {
 

core/src/com/group/golf/genetics/SwapMutation.java

@@ -4,6 +4,7 @@
 
 /**
  * Mutation that swaps the order of two movements
+ * @author Julian Marrades
  */
 public class SwapMutation implements Mutation {
 

core/src/com/group/golf/listeners/SplineMode1Listener.java

@@ -37,6 +37,7 @@ public class SplineMode1Listener extends ChangeListener {
      * Create a new Mode1Listener
      * @param game the Golf instance
      * @param screen the Screen instance
+     * @param computable the computable array of splines
      * @param txtStartPos the TextField containing the Start Coordinates
      * @param txtGoalPos the TextField containing the Goal Coordinates
      * @param txtRadius the TextField containing the tolerance

core/src/com/group/golf/math/MathLib.java

@@ -144,7 +144,7 @@ public static float distanceSquared(Point3D a, Point3D b) {
      * Get a random float value within a range
      * @param low lower bound of the range
      * @param high upper bound of the range
-     * @return a random float x such that low <= x < high
+     * @return a random float x between low (including) and high (excluding)
      */
     public static float randomFloat(float low, float high) {
         return (float)(Math.random()*(high - low) + low);