From 70cf7a696343b2c3c3edaa61d885987083fc56fa Mon Sep 17 00:00:00 2001 From: kangax Date: Thu, 9 May 2013 12:11:42 -0400 Subject: [PATCH] Tweak docs --- .gitignore | 3 ++- src/canvas.class.js | 8 ++++---- src/object_interactivity.mixin.js | 8 ++++---- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index 28f1ba75..b1f31aab 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ node_modules -.DS_Store \ No newline at end of file +.DS_Store +before_commit diff --git a/src/canvas.class.js b/src/canvas.class.js index 39473f8e..5aa7145e 100644 --- a/src/canvas.class.js +++ b/src/canvas.class.js @@ -188,10 +188,10 @@ }, /** - * Applies one implementation of 'point inside polygon' algorithm - * @param e { Event } event object - * @param target { fabric.Object } object to test against - * @return {Boolean} true if point contains within area of given object + * Checks if point is contained within an area of given object + * @param {Event} e Event object + * @param {fabric.Object} target Object to test against + * @return {Boolean} true if point is contained within an area of given object */ containsPoint: function (e, target) { var pointer = this.getPointer(e), diff --git a/src/object_interactivity.mixin.js b/src/object_interactivity.mixin.js index 65d3a76d..7acb5896 100644 --- a/src/object_interactivity.mixin.js +++ b/src/object_interactivity.mixin.js @@ -8,8 +8,8 @@ /** * Determines which one of the four corners has been clicked * @private - * @param e {Event} event object - * @param offset {Object} canvas offset + * @param {Event} e Event object + * @param {Object} offset Canvas offset * @return {String|Boolean} corner code (tl, tr, bl, br, etc.), or false if nothing is found */ _findTargetCorner: function(e, offset) { @@ -107,9 +107,9 @@ }, /** - * Method that returns an object with the image lines in it given the coordinates of the corners + * Method that returns an object with the object edges in it, given the coordinates of the corners * @private - * @param oCoords {Object} coordinates of the image corners + * @param {Object} oCoords Coordinates of the image corners */ _getImageLines: function(oCoords) { return {