Add documentation

Author: tillarnold

lib/fixed-2d-array.js

@@ -1,3 +1,8 @@
+/**
+ * width: width of the array
+ * height: height of the array
+ * defaultValue: the default value for the array 
+ */
 var Fixed2DArray = function Fixed2DArray(width,height,defaultValue) {
   this._width = width;
   this._height = height;
@@ -10,6 +15,9 @@ var Fixed2DArray = function Fixed2DArray(width,height,defaultValue) {
   }
 };
 
+/**
+ * Throws an Error if the given coordinates are invalid
+ */
 Fixed2DArray.prototype.validateCoords = function(x,y) {
   if(x<0 || y<0 || x>=this._width || y>=this._height) {
     throw new Error('fixed-2d-array: the coordinates ('+x+'/'+y+') ' +
@@ -18,11 +26,17 @@ Fixed2DArray.prototype.validateCoords = function(x,y) {
   }
 };
 
+/**
+ * Returns the coresponding value for the coordinates
+ */
 Fixed2DArray.prototype.get = function(x,y) {
   this.validateCoords(x,y);
   return this._grid[x][y];
 };
 
+/**
+ * Sets the value for the coresponding coorinates
+ */
 Fixed2DArray.prototype.set = function(x,y,val) {
   this.validateCoords(x,y);
   this._grid[x][y] = val;