Matterjs Gravity Component Doc

rgk · web-flow · commit 185b19787e9e · 2018-09-25T07:14:32.000-04:00
diff --git a/src/physics/matter-js/components/Gravity.js b/src/physics/matter-js/components/Gravity.js
@@ -5,20 +5,20 @@
  */
 
 /**
- * [description]
+ * A component to manipulate gravity for Matter.js bodies.
  *
  * @name Phaser.Physics.Matter.Components.Gravity
  * @since 3.0.0
  */
 var Gravity = {
 
     /**
-     * [description]
+     * Ignore gravity.
      *
      * @method Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity
      * @since 3.0.0
      *
-     * @param {boolean} value - [description]
+     * @param {boolean} value - Flag toignore gravity.
      *
      * @return {Phaser.GameObjects.GameObject} This Game Object.
      */

Original file line number	Diff line number	Diff line change
`@@ -5,20 +5,20 @@`
`5`	`5`	`*/`
`6`	`6`
`7`	`7`	`/**`
`8`		`- * [description]`
	`8`	`+ * A component to manipulate gravity for Matter.js bodies.`
`9`	`9`	`*`
`10`	`10`	`* @name Phaser.Physics.Matter.Components.Gravity`
`11`	`11`	`* @since 3.0.0`
`12`	`12`	`*/`
`13`	`13`	`var Gravity = {`
`14`	`14`
`15`	`15`	`/**`
`16`		`- * [description]`
	`16`	`+ * Ignore gravity.`
`17`	`17`	`*`
`18`	`18`	`* @method Phaser.Physics.Matter.Components.Gravity#setIgnoreGravity`
`19`	`19`	`* @since 3.0.0`
`20`	`20`	`*`
`21`		`- * @param {boolean} value - [description]`
	`21`	`+ * @param {boolean} value - Flag toignore gravity.`
`22`	`22`	`*`
`23`	`23`	`* @return {Phaser.GameObjects.GameObject} This Game Object.`
`24`	`24`	`*/`