Skip to content

Commit

Permalink
added missing docs for Matter.World aliases
Browse files Browse the repository at this point in the history
  • Loading branch information
liabru committed Nov 25, 2017
1 parent ece66e6 commit 841bf97
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion src/body/World.js
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,23 @@ var Common = require('../core/Common');
// World is a Composite body
// see src/module/Outro.js for these aliases:

/**
* An alias for Composite.add
* @method add
* @param {world} world
* @param {} object
* @return {composite} The original world with the objects added
*/

/**
* An alias for Composite.remove
* @method remove
* @param {world} world
* @param {} object
* @param {boolean} [deep=false]
* @return {composite} The original world with the objects removed
*/

/**
* An alias for Composite.clear
* @method clear
Expand All @@ -104,7 +121,7 @@ var Common = require('../core/Common');
*/

/**
* An alias for Composite.add
* An alias for Composite.addComposite
* @method addComposite
* @param {world} world
* @param {composite} composite
Expand Down

0 comments on commit 841bf97

Please sign in to comment.