Merge branch 'master' of github.com:CreateJS/EaselJS

Author: David Gillen

docs/easeljs_docs-NEXT.zip

@@ -173,7 +173,7 @@ this.createjs = this.createjs||{};
 
 // public methods:
 	/**
-	 * Sets {{#crossLink "Event/defaultPrevented"}}{{/crossLink}} to true if the event is cancelable.
+	 * Sets {{#crossLink "Event/defaultPrevented:property"}}{{/crossLink}} to true if the event is cancelable.
 	 * Mirrors the DOM level 2 event standard. In general, cancelable events that have `preventDefault()` called will
 	 * cancel the default behaviour associated with the event.
 	 * @method preventDefault
@@ -183,7 +183,7 @@ this.createjs = this.createjs||{};
 	};
 
 	/**
-	 * Sets {{#crossLink "Event/propagationStopped"}}{{/crossLink}} to true.
+	 * Sets {{#crossLink "Event/propagationStopped:property"}}{{/crossLink}} to true.
 	 * Mirrors the DOM event standard.
 	 * @method stopPropagation
 	 **/
@@ -192,8 +192,8 @@ this.createjs = this.createjs||{};
 	};
 
 	/**
-	 * Sets {{#crossLink "Event/propagationStopped"}}{{/crossLink}} and
-	 * {{#crossLink "Event/immediatePropagationStopped"}}{{/crossLink}} to true.
+	 * Sets {{#crossLink "Event/propagationStopped:property"}}{{/crossLink}} and
+	 * {{#crossLink "Event/immediatePropagationStopped:property"}}{{/crossLink}} to true.
 	 * Mirrors the DOM event standard.
 	 * @method stopImmediatePropagation
 	 **/

lib/easeljs-NEXT.js

@@ -318,8 +318,9 @@ this.createjs = this.createjs||{};
 	};
 
 	/**
+	 * Use the {{#crossLink "Ticker/interval:property"}}{{/crossLink}} property instead.
 	 * @method setInterval
-	 * @deprecated Use the {{#crossLink "Ticker/interval:property"}}{{/crossLink}} property instead.
+	 * @deprecated
 	 */
 	// Ticker.setInterval is @deprecated. Remove for 1.1+
 	Ticker.setInterval = createjs.deprecate(Ticker._setInterval, "Ticker.setInterval");
@@ -336,8 +337,9 @@ this.createjs = this.createjs||{};
 	};
 
 	/**
+	 * Use the {{#crossLink "Ticker/interval:property"}}{{/crossLink}} property instead.
 	 * @method getInterval
-	 * @deprecated Use the {{#crossLink "Ticker/interval:property"}}{{/crossLink}} property instead.
+	 * @deprecated
 	 */
 	// Ticker.getInterval is @deprecated. Remove for 1.1+
 	Ticker.getInterval = createjs.deprecate(Ticker._getInterval, "Ticker.getInterval");
@@ -354,8 +356,9 @@ this.createjs = this.createjs||{};
 	};
 
 	/**
+	 * Use the {{#crossLink "Ticker/framerate:property"}}{{/crossLink}} property instead.
 	 * @method setFPS
-	 * @deprecated Use the {{#crossLink "Ticker/framerate:property"}}{{/crossLink}} property instead.
+	 * @deprecated
 	 */
 	// Ticker.setFPS is @deprecated. Remove for 1.1+
 	Ticker.setFPS = createjs.deprecate(Ticker._setFPS, "Ticker.setFPS");
@@ -372,8 +375,9 @@ this.createjs = this.createjs||{};
 	};
 
 	/**
+	 * Use the {{#crossLink "Ticker/framerate:property"}}{{/crossLink}} property instead.
 	 * @method getFPS
-	 * @deprecated Use the {{#crossLink "Ticker/framerate:property"}}{{/crossLink}} property instead.
+	 * @deprecated
 	 */
 	// Ticker.getFPS is @deprecated. Remove for 1.1+
 	Ticker.getFPS = createjs.deprecate(Ticker._getFPS, "Ticker.getFPS");
@@ -502,7 +506,7 @@ this.createjs = this.createjs||{};
 	 * @method getEventTime
 	 * @static
 	 * @param runTime {Boolean} [runTime=false] If true, the runTime property will be returned instead of time.
-	 * @returns {number} The time or runTime property from the most recent tick event or -1.
+	 * @return {number} The time or runTime property from the most recent tick event or -1.
 	 */
 	Ticker.getEventTime = function(runTime) {
 		return Ticker._startTime ? (Ticker._lastTime || Ticker._startTime) - (runTime ? Ticker._pausedTime : 0) : -1;

lib/easeljs-NEXT.min.js

@@ -98,9 +98,7 @@ this.createjs = this.createjs||{};
 		this.sourceRect = null;
 
 	// private properties:
-		/**
-		 * Docced in superclass.
-		 */
+		// Docced in superclass
 		this._webGLRenderStyle = createjs.DisplayObject._StageGL_BITMAP;
 	}
 	var p = createjs.extend(Bitmap, createjs.DisplayObject);
@@ -193,9 +191,7 @@ this.createjs = this.createjs||{};
 	 * @method uncache
 	 **/
 
-	/**
-	 * Docced in superclass.
-	 */
+	// Docced in superclass
 	p.getBounds = function() {
 		var rect = this.DisplayObject_getBounds();
 		if (rect) { return rect; }

src/createjs/events/Event.js

@@ -154,6 +154,7 @@ this.createjs = this.createjs || {};
 
 	/**
 	 * Sprite object pool.
+	 * @property _spritePool
 	 * @type {Array}
 	 * @static
 	 * @private
@@ -162,18 +163,14 @@ this.createjs = this.createjs || {};
 
 
 // public methods:
-	/**
-	 * Docced in superclass.
-	 **/
+	// Docced in superclass
 	p.draw = function(ctx, ignoreCache) {
 		if (this.DisplayObject_draw(ctx, ignoreCache)) { return; }
 		this._updateState();
 		this.Container_draw(ctx, ignoreCache);
 	};
 
-	/**
-	 * Docced in superclass.
-	 **/
+	// Docced in superclass
 	p.getBounds = function() {
 		this._updateText();
 		return this.Container_getBounds();
@@ -219,9 +216,7 @@ this.createjs = this.createjs || {};
 
 
 // private methods:
-	/**
-	 * Docced in superclass.
-	 **/
+	// Docced in superclass
 	p._updateState = function() {
 		this._updateText();
 	};

src/createjs/utils/Ticker.js

@@ -38,12 +38,11 @@ this.createjs = this.createjs||{};
  * A Container is a nestable display list that allows you to work with compound display elements. For  example you could
  * group arm, leg, torso and head {{#crossLink "Bitmap"}}{{/crossLink}} instances together into a Person Container, and
  * transform them as a group, while still being able to move the individual parts relative to each other. Children of
- * containers have their <code>transform</code> and <code>alpha</code> properties concatenated with their parent
- * Container.
+ * containers have their `transform` and `alpha` properties concatenated with their parent Container.
  *
- * For example, a {{#crossLink "Shape"}}{{/crossLink}} with x=100 and alpha=0.5, placed in a Container with <code>x=50</code>
- * and <code>alpha=0.7</code> will be rendered to the canvas at <code>x=150</code> and <code>alpha=0.35</code>.
- * Containers have some overhead, so you generally shouldn't create a Container to hold a single child.
+ * For example, a {{#crossLink "Shape"}}{{/crossLink}} with `x=100` and `alpha=0.5`, placed in a Container with `x=50`
+ * and `alpha=0.7` will be rendered to the canvas at `x=150` and `alpha=0.35`. Containers have some overhead, so you
+ * generally shouldn't create a Container to hold a single child.
  *
  * <h4>Example</h4>
  *
@@ -105,8 +104,9 @@ this.createjs = this.createjs||{};
 	};
 
 	/**
+	 * Use the {{#crossLink "Container/numChildren:property"}}{{/crossLink}} property instead.
 	 * @method getNumChildren
-	 * @deprecated Use the {{#crossLink "Container/numChildren:property"}}{{/crossLink}} property instead.
+	 * @deprecated
 	 */
 	// Container.getNumChildren is @deprecated. Remove for 1.1+
 	p.getNumChildren = createjs.deprecate(p._getNumChildren, "Container.getNumChildren");
@@ -358,7 +358,7 @@ this.createjs = this.createjs||{};
 	 *      container.sortChildren(sortFunction);
 	 *
 	 * @method sortChildren
-	 * @param {Function} sortFunction the function to use to sort the child list. See JavaScript's <code>Array.sort</code>
+	 * @param {Function} sortFunction the function to use to sort the child list. See JavaScript's `Array.sort`
 	 * documentation for details.
 	 **/
 	p.sortChildren = function(sortFunction) {
@@ -467,7 +467,7 @@ this.createjs = this.createjs||{};
 	 * list. This routine ignores any display objects with {{#crossLink "DisplayObject/mouseEnabled:property"}}{{/crossLink}}
 	 * set to `false`. The array will be sorted in order of visual depth, with the top-most display object at index 0.
 	 * This uses shape based hit detection, and can be an expensive operation to run, so it is best to use it carefully.
-	 * For example, if testing for objects under the mouse, test on tick (instead of on {{#crossLink "DisplayObject/mousemove:event"}}{{/crossLink}}),
+	 * For example, if testing for objects under the mouse, test on tick (instead of on {{#crossLink "Stage/stagemousemove:event"}}{{/crossLink}}),
 	 * and only if the mouse's position has changed.
 	 * 
 	 * <ul>
@@ -478,7 +478,7 @@ this.createjs = this.createjs||{};
 	 * 	   	listeners or a {{#crossLink "DisplayObject:cursor:property"}}{{/crossLink}} property. That is, only objects
 	 * 	   	that would normally intercept mouse interaction will be included. This can significantly improve performance
 	 * 	   	in some cases by reducing the number of display objects that need to be tested.</li>
-	 * </li>
+	 * </ul>
 	 * 
 	 * This method accounts for both {{#crossLink "DisplayObject/hitArea:property"}}{{/crossLink}} and {{#crossLink "DisplayObject/mask:property"}}{{/crossLink}}.
 	 * @method getObjectsUnderPoint
@@ -496,7 +496,7 @@ this.createjs = this.createjs||{};
 
 	/**
 	 * Similar to {{#crossLink "Container/getObjectsUnderPoint"}}{{/crossLink}}, but returns only the top-most display
-	 * object. This runs significantly faster than <code>getObjectsUnderPoint()</code>, but is still potentially an expensive
+	 * object. This runs significantly faster than `getObjectsUnderPoint()`, but is still potentially an expensive
 	 * operation. See {{#crossLink "Container/getObjectsUnderPoint"}}{{/crossLink}} for more information.
 	 * @method getObjectUnderPoint
 	 * @param {Number} x The x position in the container to test.
@@ -509,17 +509,13 @@ this.createjs = this.createjs||{};
 		return this._getObjectsUnderPoint(pt.x, pt.y, null, mode>0, mode==1);
 	};
 
-	/**
-	 * Docced in superclass.
-	 */
+	// Docced in superclass
 	p.getBounds = function() {
 		return this._getBounds(null, true);
 	};
 
 
-	/**
-	 * Docced in superclass.
-	 */
+	// Docced in superclass
 	p.getTransformedBounds = function() {
 		return this._getBounds();
 	};