some cleaning up and documentation polish

Author: Josh McGhee

src/animation/AnimationParser.js

@@ -147,9 +147,7 @@ Phaser.AnimationParser = {
     /**
     * Parse the JSON data and extract the animation frame data from it.
     *
-<<<<<<< HEAD
-=======
-    * @method Phaser.AnimationParser.JSONData
+    * @method Phaser.AnimationParser.JSONDataPyxel
     * @param {Phaser.Game} game - A reference to the currently running game.
     * @param {object} json - The JSON data from the Texture Atlas. Must be in Pyxel JSON format.
     * @return {Phaser.FrameData} A FrameData object containing the parsed frames.
@@ -205,7 +203,6 @@ Phaser.AnimationParser = {
     /**
     * Parse the JSON data and extract the animation frame data from it.
     *
->>>>>>> 247064f... fixed some typos and explicitly setTrim to false
     * @method Phaser.AnimationParser.JSONDataHash
     * @param {Phaser.Game} game - A reference to the currently running game.
     * @param {object} json - The JSON data from the Texture Atlas. Must be in JSON Hash format.
@@ -296,7 +293,7 @@ Phaser.AnimationParser = {
         for (var i = 0; i < frames.length; i++)
         {
             frame = frames[i].attributes;
-            
+
             name = frame.name.value;
             x = parseInt(frame.x.value, 10);
             y = parseInt(frame.y.value, 10);

src/loader/Cache.js

@@ -6,12 +6,12 @@
 
 /**
 * Phaser has one single cache in which it stores all assets.
-* 
+*
 * The cache is split up into sections, such as images, sounds, video, json, etc. All assets are stored using
 * a unique string-based key as their identifier. Assets stored in different areas of the cache can have the
 * same key, for example 'playerWalking' could be used as the key for both a sprite sheet and an audio file,
 * because they are unique data types.
-* 
+*
 * The cache is automatically populated by the Phaser.Loader. When you use the loader to pull in external assets
 * such as images they are automatically placed into their respective cache. Most common Game Objects, such as
 * Sprites and Videos automatically query the cache to extract the assets they need on instantiation.
@@ -604,13 +604,10 @@ Phaser.Cache.prototype = {
         {
             obj.frameData = Phaser.AnimationParser.XMLData(this.game, atlasData, key);
         }
-<<<<<<< HEAD
-=======
         else if (format === Phaser.Loader.TEXTURE_ATLAS_JSON_PYXEL)
         {
             obj.frameData = Phaser.AnimationParser.JSONDataPyxel(this.game, atlasData, key);
         }
->>>>>>> 247064f... fixed some typos and explicitly setTrim to false
         else
         {
             //  Let's just work it out from the frames array
@@ -993,7 +990,7 @@ Phaser.Cache.prototype = {
 
     /**
     * Get an item from a cache based on the given key and property.
-    * 
+    *
     * This method is mostly used internally by other Cache methods such as `getImage` but is exposed
     * publicly for your own use as well.
     *
@@ -1024,16 +1021,16 @@ Phaser.Cache.prototype = {
                 return this._cacheMap[cache][key][property];
             }
         }
-        
+
         return null;
 
     },
 
     /**
     * Gets a Canvas object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getCanvas
@@ -1048,13 +1045,13 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a Image object from the cache. This returns a DOM Image object, not a Phaser.Image object.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
-    * 
+    *
     * Only the Image cache is searched, which covers images loaded via Loader.image, Sprite Sheets and Texture Atlases.
-    * 
+    *
     * If you need the image used by a bitmap font or similar then please use those respective 'get' methods.
     *
     * @method Phaser.Cache#getImage
@@ -1091,7 +1088,7 @@ Phaser.Cache.prototype = {
 
     /**
     * Get a single texture frame by key.
-    * 
+    *
     * You'd only do this to get the default Frame created for a non-atlas / spritesheet image.
     *
     * @method Phaser.Cache#getTextureFrame
@@ -1106,9 +1103,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a Phaser.Sound object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getSound
@@ -1123,9 +1120,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a raw Sound data object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getSoundData
@@ -1140,9 +1137,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a Text object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getText
@@ -1157,11 +1154,11 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a Physics Data object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
-    * 
+    *
     * You can get either the entire data set, a single object or a single fixture of an object from it.
     *
     * @method Phaser.Cache#getPhysicsData
@@ -1219,9 +1216,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a raw Tilemap data object from the cache. This will be in either CSV or JSON format.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getTilemapData
@@ -1236,9 +1233,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a binary object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getBinary
@@ -1253,9 +1250,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a BitmapData object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getBitmapData
@@ -1270,9 +1267,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a Bitmap Font object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getBitmapFont
@@ -1287,11 +1284,11 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a JSON object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
-    * 
+    *
     * You can either return the object by reference (the default), or return a clone
     * of it by setting the `clone` argument to `true`.
     *
@@ -1324,9 +1321,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets an XML object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getXML
@@ -1341,9 +1338,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a Phaser.Video object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getVideo
@@ -1358,9 +1355,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a fragment shader object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getShader
@@ -1375,9 +1372,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a RenderTexture object from the cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getRenderTexture
@@ -1451,9 +1448,9 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a Phaser.FrameData object from the Image Cache.
-    * 
+    *
     * The object is looked-up based on the key given.
-    * 
+    *
     * Note: If the object cannot be found a `console.warn` message is displayed.
     *
     * @method Phaser.Cache#getFrameData
@@ -1587,7 +1584,7 @@ Phaser.Cache.prototype = {
 
     /**
     * Gets a PIXI.BaseTexture by key from the PIXI.BaseTextureCache.
-    * 
+    *
     * If the texture isn't found in the cache, then it searches the Phaser Image Cache.
     *
     * @method Phaser.Cache#getPixiBaseTexture
@@ -1691,7 +1688,7 @@ Phaser.Cache.prototype = {
 
     /**
     * Removes an image from the cache.
-    * 
+    *
     * You can optionally elect to destroy it as well. This calls BaseTexture.destroy on it.
     *
     * Note that this only removes it from the Phaser and PIXI Caches. If you still have references to the data elsewhere