From 9f4def5b40e46c19c2b7a341e3f10d871dda254c Mon Sep 17 00:00:00 2001 From: NathanSweet Date: Sat, 12 Oct 2013 11:38:24 +0200 Subject: [PATCH] Javadocs --- spine-as3/spine-as3/src/spine/SkeletonBounds.as | 14 +++++++------- .../com/esotericsoftware/spine/SkeletonBounds.java | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/spine-as3/spine-as3/src/spine/SkeletonBounds.as b/spine-as3/spine-as3/src/spine/SkeletonBounds.as index 49307bdb5..5828d773c 100644 --- a/spine-as3/spine-as3/src/spine/SkeletonBounds.as +++ b/spine-as3/spine-as3/src/spine/SkeletonBounds.as @@ -94,12 +94,12 @@ public class SkeletonBounds { } - /// Returns true if the axis aligned bounding box contains the point. + /** Returns true if the axis aligned bounding box contains the point. */ public function aabbContainsPoint (x:Number, y:Number) : Boolean { return x >= minX && x <= maxX && y >= minY && y <= maxY; } - /// Returns true if the axis aligned bounding box intersects the line segment. + /** Returns true if the axis aligned bounding box intersects the line segment. */ public function aabbIntersectsSegment (x1:Number, y1:Number, x2:Number, y2:Number) : Boolean { if ((x1 <= minX && x2 <= minX) || (y1 <= minY && y2 <= minY) || (x1 >= maxX && x2 >= maxX) || (y1 >= maxY && y2 >= maxY)) return false; @@ -115,21 +115,21 @@ public class SkeletonBounds { return false; } - /// Returns true if the axis aligned bounding box intersects the axis aligned bounding box of the specified bounds. + /** Returns true if the axis aligned bounding box intersects the axis aligned bounding box of the specified bounds. */ public function aabbIntersectsSkeleton (bounds:SkeletonBounds) : Boolean { return minX < bounds.maxX && maxX > bounds.minX && minY < bounds.maxY && maxY > bounds.minY; } - /// Returns the first bounding box attachment that contains the point, or null. When doing many checks, it is usually more - /// efficient to only call this method if {@link #aabbContainsPoint(float, float)} returns true. + /** Returns the first bounding box attachment that contains the point, or null. When doing many checks, it is usually more + * efficient to only call this method if {@link #aabbContainsPoint(float, float)} returns true. */ public function containsPoint (x:Number, y:Number) : BoundingBoxAttachment { for (var i:int = 0, n:int = polygons.length; i < n; i++) if (polygons[i].containsPoint(x, y)) return boundingBoxes[i]; return null; } - /// Returns the first bounding box attachment that contains the line segment, or null. When doing many checks, it is usually - /// more efficient to only call this method if {@link #aabbIntersectsSegment(float, float, float, float)} returns true. + /** Returns the first bounding box attachment that contains the line segment, or null. When doing many checks, it is usually + * more efficient to only call this method if {@link #aabbIntersectsSegment(float, float, float, float)} returns true. */ public function intersectsSegment (x1:Number, y1:Number, x2:Number, y2:Number) : BoundingBoxAttachment { for (var i:int = 0, n:int = polygons.length; i < n; i++) if (polygons[i].intersectsSegment(x1, y1, x2, y2)) return boundingBoxes[i]; diff --git a/spine-libgdx/src/com/esotericsoftware/spine/SkeletonBounds.java b/spine-libgdx/src/com/esotericsoftware/spine/SkeletonBounds.java index dfab8a9d9..9293cee6f 100644 --- a/spine-libgdx/src/com/esotericsoftware/spine/SkeletonBounds.java +++ b/spine-libgdx/src/com/esotericsoftware/spine/SkeletonBounds.java @@ -136,7 +136,7 @@ public class SkeletonBounds { return null; } - /** Returns true if the bounding box attachment contains the point. */ + /** Returns true if the polygon contains the point. */ public boolean containsPoint (FloatArray polygon, float x, float y) { float[] vertices = polygon.items; int nn = polygon.size; @@ -164,7 +164,7 @@ public class SkeletonBounds { return null; } - /** Returns true if the bounding box attachment contains the line segment. */ + /** Returns true if the polygon contains the line segment. */ public boolean intersectsSegment (FloatArray polygon, float x1, float y1, float x2, float y2) { float[] vertices = polygon.items; int nn = polygon.size;