Lots of jsdocs fixes ready for the new doc generator.

Author: photonstorm

docgen/src/ClassDesc.php

@@ -38,19 +38,19 @@ public function __construct($block)
             //  This is a problem because the @classdesc block is often multi-line, but repeated in the clear content too.
             //  So all the classes probably need tidying up before this part will work correctly.
 
-            // $this->help = $block->cleanContent();
+            $this->help = $block->cleanContent();
 
         }
 
         public function getArray()
         {
             return array(
                 'name' => $this->name,
-                'parameters' => $this->parameters,
-                'help' => implode('\n', $this->help),
                 'extends' => $this->extends,
                 'static' => $this->isStatic,
-                'constructor' => $this->hasConstructor
+                'constructor' => $this->hasConstructor,
+                'parameters' => $this->parameters,
+                'help' => implode('\n', $this->help)
             );
 
         }

docgen/src/Parameter.php

@@ -26,9 +26,6 @@ public function __construct($line)
 
         public function parsePhaser($output)
         {
-            $this->types = explode('|', $output[2]);
-            $this->help = $output[5];
-
             $name = $output[3];
 
             // $this->debug = $name . " -- ";
@@ -53,6 +50,29 @@ public function parsePhaser($output)
 
             $this->name = $name;
 
+            //  Remove optional braces
+            if (substr($output[2], 0, 1) === "(")
+            {
+                $output[2] = substr($output[2], 1, -1);
+            }
+
+            $this->types = explode('|', $output[2]);
+
+            //  @param {number[]|string[]} frames - An array of numbers or strings indicating which frames to play in which order.
+            //  @param {(number[]|...number)} points - An array of 2d vectors that form the convex or concave polygon.
+            //      Either [[0,0], [0,1],...] or a flat array of numbers that will be interpreted as [x,y, x,y, ...],
+            //      or the arguments passed can be flat x,y values e.g. `setPolygon(options, x,y, x,y, x,y, ...)` where `x` and `y` are numbers.
+
+            foreach ($this->types as $key => $type)
+            {
+                if (substr($type, -2) === "[]")
+                {
+                    $this->types[$key] = "Array " . substr($type, 0, -2);
+                }
+            }
+
+            $this->help = $output[5];
+
         }
 
         public function parsePixi($output)

src/animation/Animation.js

@@ -14,7 +14,7 @@
 * @param {Phaser.Sprite} parent - A reference to the owner of this Animation.
 * @param {string} name - The unique name for this animation, used in playback commands.
 * @param {Phaser.FrameData} frameData - The FrameData object that contains all frames used by this Animation.
-* @param {(Array.<number>|Array.<string>)} frames - An array of numbers or strings indicating which frames to play in which order.
+* @param {number[]|string[]} frames - An array of numbers or strings indicating which frames to play in which order.
 * @param {number} delay - The time between each frame of the animation, given in ms.
 * @param {boolean} loop - Should this animation loop when it reaches the end or play through once.
 */

src/core/Filter.js

@@ -8,7 +8,6 @@
 * This is a base Filter template to use for any Phaser filter development.
 *
 * @class Phaser.Filter
-* @classdesc Phaser - Filter
 * @constructor
 * @param {Phaser.Game} game - A reference to the currently running game.
 * @param {Object} uniforms - Uniform mappings object

src/core/Game.js

@@ -5,22 +5,20 @@
 */
 
 /**
-* Game constructor
-*
-* Instantiate a new <code>Phaser.Game</code> object.
-* @class Phaser.Game
-* @classdesc This is where the magic happens. The Game object is the heart of your game,
+* This is where the magic happens. The Game object is the heart of your game,
 * providing quick access to common functions and handling the boot process.
 * "Hell, there are no rules here - we're trying to accomplish something."
 *                                                       Thomas A. Edison
+*
+* @class Phaser.Game
 * @constructor
 * @param {number|string} [width=800] - The width of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage width of the parent container, or the browser window if no parent is given.
 * @param {number|string} [height=600] - The height of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage height of the parent container, or the browser window if no parent is given.
 * @param {number} [renderer=Phaser.AUTO] - Which renderer to use: Phaser.AUTO will auto-detect, Phaser.WEBGL, Phaser.CANVAS or Phaser.HEADLESS (no rendering at all).
 * @param {string|HTMLElement} [parent=''] - The DOM element into which this games canvas will be injected. Either a DOM ID (string) or the element itself.
 * @param {object} [state=null] - The default state object. A object consisting of Phaser.State functions (preload, create, update, render) or null.
 * @param {boolean} [transparent=false] - Use a transparent canvas background or not.
-* @param  {boolean} [antialias=true] - Draw all image textures anti-aliased or not. The default is for smooth textures, but disable if your game features pixel art.
+* @param {boolean} [antialias=true] - Draw all image textures anti-aliased or not. The default is for smooth textures, but disable if your game features pixel art.
 * @param {object} [physicsConfig=null] - A physics configuration object to pass to the Physics world on creation.
 */
 Phaser.Game = function (width, height, renderer, parent, state, transparent, antialias, physicsConfig) {

src/core/Group.js

@@ -5,9 +5,10 @@
 */
 
 /**
-* Phaser Group constructor.
+* A Group is a container for display objects that allows for fast pooling and object recycling.
+* Groups can be nested within other Groups and have their own local transforms.
+* 
 * @class Phaser.Group
-* @classdesc A Group is a container for display objects that allows for fast pooling and object recycling. Groups can be nested within other Groups and have their own local transforms.
 * @constructor
 * @param {Phaser.Game} game - A reference to the currently running game.
 * @param {Phaser.Group|Phaser.Sprite|null} parent - The parent Group, DisplayObject or DisplayObjectContainer that this Group will be added to. If `undefined` it will use game.world. If null it won't be added to anything.

src/core/Plugin.js

@@ -8,7 +8,6 @@
 * This is a base Plugin template to use for any Phaser plugin development.
 *
 * @class Phaser.Plugin
-* @classdesc Phaser - Plugin
 * @constructor
 * @param {Phaser.Game} game - A reference to the currently running game.
 * @param {Any} parent - The object that owns this plugin, usually Phaser.PluginManager.

src/core/PluginManager.js

@@ -10,7 +10,6 @@
 * The Plugin Manager is responsible for the loading, running and unloading of Phaser Plugins.
 *
 * @class Phaser.PluginManager
-* @classdesc Phaser - PluginManager
 * @constructor
 * @param {Phaser.Game} game - A reference to the currently running game.
 */

src/core/Signal.js

@@ -1,13 +1,14 @@
 /**
+* @author       Miller Medeiros http://millermedeiros.github.com/js-signals/
 * @author       Richard Davey <rich@photonstorm.com>
 * @copyright    2014 Photon Storm Ltd.
 * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
 */
 
 /**
+* A Signal is used for object communication via a custom broadcaster instead of Events.
+* 
 * @class Phaser.Signal
-* @classdesc A Signal is used for object communication via a custom broadcaster instead of Events.
-* @author Miller Medeiros http://millermedeiros.github.com/js-signals/
 * @constructor
 */
 Phaser.Signal = function () {

src/core/SignalBinding.js

@@ -1,16 +1,16 @@
 /**
+* @author       Miller Medeiros http://millermedeiros.github.com/js-signals/
 * @author       Richard Davey <rich@photonstorm.com>
 * @copyright    2014 Photon Storm Ltd.
 * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
 */
 
 /**
-* @class Phaser.SignalBinding
-* @classdesc Object that represents a binding between a Signal and a listener function.
+* Object that represents a binding between a Signal and a listener function.
 * This is an internal constructor and shouldn't be created directly.
 * Inspired by Joa Ebert AS3 SignalBinding and Robert Penner's Slot classes.
-*
-* @author Miller Medeiros http://millermedeiros.github.com/js-signals/
+* 
+* @class Phaser.SignalBinding
 * @constructor
 * @param {Phaser.Signal} signal - Reference to Signal object that listener is currently bound to.
 * @param {function} listener - Handler function bound to the signal.