Ray; update documentation and naming

Author: ruby0x1

differ/shapes/Polygon.hx

@@ -5,10 +5,9 @@ import differ.shapes.*;
 import differ.data.*;
 import differ.sat.*;
 
-/** A polygon collision shape */
+/** A polygonal collision shape */
 class Polygon extends Shape {
 
-
         /** The transformed (rotated/scale) vertices cache */
     public var transformedVertices ( get, never ) : Array<Vector>;
         /** The vertices of this shape */

differ/shapes/Ray.hx

@@ -4,6 +4,8 @@ import differ.math.*;
 import differ.shapes.*;
 import differ.data.*;
 
+/** A ray with a start, end, direction 
+    and infinite state for collision queries. */
 class Ray {
 
         /** The start point of the ray. */
@@ -15,12 +17,12 @@ class Ray {
             Updates only when the dir value is accessed. */
     public var dir (get, never):Vector;
         /** Whether or not the ray is infinite. */
-    public var infinite:InfiniteMode;
+    public var infinite:InfiniteState;
 
         /** Create a new ray with the start and end point,
             which determine the direction of the ray, and optionally specifying
-            that this ray is an infinite one. */
-    public function new(_start:Vector, _end:Vector, ?_infinite:InfiniteMode) {
+            that this ray is infinite in some way. */
+    public function new(_start:Vector, _end:Vector, ?_infinite:InfiniteState) {
 
         start = _start;
         end = _end;
@@ -42,8 +44,17 @@ class Ray {
 
 }
 
-enum InfiniteMode {
+    /** A flag for the infinite state of a Ray. */
+enum InfiniteState {
+
+        /** The line is a fixed length 
+            between the start and end points. */
+    not_infinite;
+        /** The line is infinite 
+            from it's starting point. */
     infinite_from_start;
+        /** The line is infinite in both 
+            directions from it's starting point. */
     infinite;
-    not_infinite;
-}
+
+} //InfiniteState