Improve documentation

Author: tillarnold

lib/fixed-2d-array.js

@@ -1,7 +1,10 @@
 /**
- * width: width of the array
- * height: height of the array
- * defaultValue: the default value for the array 
+ * An array with a fixed height and width.
+ *
+ * @param width {number} width of the array
+ * @param height {number} height of the array
+ * @param defaultValue the initial value for the array elements
+ * @class
  */
 var Fixed2DArray = function Fixed2DArray(width,height,defaultValue) {
   this._width = width;
@@ -16,7 +19,10 @@ var Fixed2DArray = function Fixed2DArray(width,height,defaultValue) {
 };
 
 /**
- * Throws an Error if the given coordinate is invalid
+ * Throws an Error if the given coordinate is invalid.
+ *
+ * @param x {number} x coordinate
+ * @param y {number} y coordinate
  */
 Fixed2DArray.prototype.validateCoords = function(x,y) {
   if(x<0 || y<0 || x>=this._width || y>=this._height) {
@@ -27,15 +33,22 @@ Fixed2DArray.prototype.validateCoords = function(x,y) {
 };
 
 /**
- * Returns the coresponding value for the coordinate
+ * Returns the value for the coordinate.
+ * 
+ * @param x {number} x coordinate
+ * @param y {number} y coordinate
  */
 Fixed2DArray.prototype.get = function(x,y) {
   this.validateCoords(x,y);
   return this._grid[x][y];
 };
 
 /**
- * Sets the value for the coresponding coorinate
+ * Sets the value for the coordinate.
+ *
+ * @param x {number} x coordinate
+ * @param y {number} y coordinate
+ * @param val new value
  */
 Fixed2DArray.prototype.set = function(x,y,val) {
   this.validateCoords(x,y);
@@ -46,15 +59,20 @@ Fixed2DArray.prototype.set = function(x,y,val) {
  * Returns all neighbours of the given coordinate.
  *
  * For example: 
+ * <pre>
  * [ ][ ][ ][ ][ ]
  * [ ][*][*][*][ ]
  * [ ][*][X][*][ ]
  * [ ][*][*][*][ ]
  * [ ][ ][ ][ ][ ]
+ * </pre>
+ *
+ * The given coordinate is marked with an `X`.
+ * The function will return an array containing
+ * the values for the fields maked with an `*`.
  *
- * the given coordinate is marked with an `X`
- * the function will return an array containing
- * the values for the fields maked with an `*` 
+ * @param x {number} x coordinate
+ * @param y {number} y coordinate
  */
 Fixed2DArray.prototype.getNeighbours = function(x,y){
   this.validateCoords(x,y);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fixed-2d-array",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "description": "A fixed size 2D array in javascript",
   "main": "index.js",
   "scripts": {