0
0
Fork 0
mirror of https://github.com/liabru/matter-js.git synced 2025-01-31 18:14:55 -05:00

Update docs for Runner.run & Runner.start

* Add runner param to Runner.run
* Mark runner param as optional in both methods
This commit is contained in:
Chris Stott 2019-01-09 15:29:01 -08:00 committed by GitHub
parent 773510f985
commit 8b3cbd17b2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -78,6 +78,7 @@ var Common = require('./Common');
/** /**
* Continuously ticks a `Matter.Engine` by calling `Runner.tick` on the `requestAnimationFrame` event. * Continuously ticks a `Matter.Engine` by calling `Runner.tick` on the `requestAnimationFrame` event.
* @method run * @method run
* @param {runner} [runner]
* @param {engine} engine * @param {engine} engine
*/ */
Runner.run = function(runner, engine) { Runner.run = function(runner, engine) {
@ -208,7 +209,7 @@ var Common = require('./Common');
/** /**
* Alias for `Runner.run`. * Alias for `Runner.run`.
* @method start * @method start
* @param {runner} runner * @param {runner} [runner]
* @param {engine} engine * @param {engine} engine
*/ */
Runner.start = function(runner, engine) { Runner.start = function(runner, engine) {