commentaar isValidOrientation()

2018-03-11 21:15:25 +01:00
parent 598abe6e63
commit 6288d46945
1 changed files with 4 additions and 1 deletions
--- a/OGP1718-Worms/src/worms/model/Worm.java
+++ b/OGP1718-Worms/src/worms/model/Worm.java
@@ -219,9 +219,12 @@ public class Worm {
    }

    /**
+     *check whether the given orientation is a valid orientation for the worm
     *
     * @param newOrientation
-     * @return
+     * 		  the orientation to check
+     * @return True if and only if the orientation is bigger then and smaller then 2pi
+     * 		   |result == ( newOrientation >= 0 && newOrientation < 2 * PI )
     */
    public static boolean isValidOrientation(double newOrientation) {
        return newOrientation >= 0 && newOrientation < 2 * PI;