Merge pull request #5870 from samme/docs/class-types

Add GroupClassTypeConstructor and ParticleClassConstructor types

Author: photonstorm

src/gameobjects/group/Group.js

@@ -125,7 +125,7 @@ var Group = new Class({
          * The class to create new group members from.
          *
          * @name Phaser.GameObjects.Group#classType
-         * @type {Function}
+         * @type {Phaser.Types.GameObjects.Group.GroupClassTypeConstructor}
          * @since 3.0.0
          * @default Phaser.GameObjects.Sprite
          */

src/gameobjects/group/typedefs/GroupClassTypeConstructor.js

@@ -0,0 +1,10 @@
+/**
+ * @callback Phaser.Types.GameObjects.Group.GroupClassTypeConstructor
+ * @since 3.0.0
+ *
+ * @param {Phaser.Scene} scene - The Scene to which this Game Object belongs.
+ * @param {number} x - The horizontal position of this Game Object in the world.
+ * @param {number} y - The vertical position of this Game Object in the world.
+ * @param {(string|Phaser.Textures.Texture)} texture - The key, or instance of the Texture this Game Object will use to render with, as stored in the Texture Manager.
+ * @param {(string|number)} [frame] - An optional frame from the Texture this Game Object is rendering with.
+ */

src/gameobjects/particles/ParticleEmitter.js

@@ -167,7 +167,7 @@ var ParticleEmitter = new Class({
          * The Particle Class which will be emitted by this Emitter.
          *
          * @name Phaser.GameObjects.Particles.ParticleEmitter#particleClass
-         * @type {Phaser.GameObjects.Particles.Particle}
+         * @type {Phaser.Types.GameObjects.Particles.ParticleClassConstructor}
          * @default Phaser.GameObjects.Particles.Particle
          * @since 3.0.0
          */

src/gameobjects/particles/typedefs/ParticleClassConstructor.js

@@ -0,0 +1,6 @@
+/**
+ * @callback Phaser.Types.GameObjects.Particles.ParticleClassConstructor
+ * @since 3.0.0
+ *
+ * @param {Phaser.GameObjects.Particles.ParticleEmitter} emitter - The Emitter to which this Particle belongs.
+*/

src/gameobjects/particles/typedefs/ParticleEmitterConfig.js

@@ -103,7 +103,7 @@ var PhysicsGroup = new Class({
          * This should be either `Phaser.Physics.Arcade.Image`, `Phaser.Physics.Arcade.Sprite`, or a class extending one of those.
          *
          * @name Phaser.Physics.Arcade.Group#classType
-         * @type {Function}
+         * @type {Phaser.Types.GameObjects.Group.GroupClassTypeConstructor}
          * @default ArcadeSprite
          * @since 3.0.0
          */