Merge pull request #232 from Rantanen/docs

Document World bounds and Grid bucket size.
liabru · Apr 5, 2016 · 79fa57e · 79fa57e
2 parents b6f6a03 + 5054c97
commit 79fa57e
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/src/body/World.js b/src/body/World.js
@@ -85,6 +85,14 @@ var Common = require('../core/Common');
      * @default 0.001
      */
 
+    /**
+     * A `Bounds` object that defines the world bounds for collision detection.
+     *
+     * @property bounds
+     * @type bounds
+     * @default { min: { x: -Infinity, y: -Infinity }, max: { x: Infinity, y: Infinity } }
+     */
+
     // World is a Composite body
     // see src/module/Outro.js for these aliases:
 

diff --git a/src/collision/Grid.js b/src/collision/Grid.js
@@ -34,6 +34,22 @@ var Common = require('../core/Common');
         return Common.extend(defaults, options);
     };
 
+    /**
+     * The width of a single grid bucket.
+     *
+     * @property bucketWidth
+     * @type number
+     * @default 48
+     */
+
+    /**
+     * The height of a single grid bucket.
+     *
+     * @property bucketHeight
+     * @type number
+     * @default 48
+     */
+
     /**
      * Updates the grid.
      * @method update