Skip to content

Commit

Permalink
Merge pull request #67 from toolness/remove-sprite-constructor-docs
Browse files Browse the repository at this point in the history
Don't publicly document Sprite constructor
  • Loading branch information
toolness committed Mar 30, 2016
2 parents 552eee9 + 0bd39c3 commit a8bfb22
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions lib/p5.play.js
Original file line number Diff line number Diff line change
Expand Up @@ -716,16 +716,22 @@ deltaTime = ((now - then) / 1000)/INTERVAL_60; // seconds since last frame
* A Sprite can have a collider that defines the active area to detect
* collisions or overlappings with other sprites and mouse interactions.
*
* To create a Sprite, use
* {{#crossLink "p5.play/createSprite:method"}}{{/crossLink}}.
*
* @class Sprite
* @constructor
* @param {Number} x Initial x coordinate
* @param {Number} y Initial y coordinate
* @param {Number} width Width of the placeholder rectangle and of the
* collider until an image or new collider are set
* @param {Number} height Height of the placeholder rectangle and of the
* collider until an image or new collider are set
*/

// For details on why these docs aren't in a YUIDoc comment block, see:
//
// https://github.com/molleindustria/p5.play/pull/67
//
// @param {Number} x Initial x coordinate
// @param {Number} y Initial y coordinate
// @param {Number} width Width of the placeholder rectangle and of the
// collider until an image or new collider are set
// @param {Number} height Height of the placeholder rectangle and of the
// collider until an image or new collider are set
function Sprite(pInst, _x, _y, _w, _h) {
var pInstBind = createPInstBinder(pInst);

Expand Down

0 comments on commit a8bfb22

Please sign in to comment.