generate docs

API.md

@@ -0,0 +1,43 @@
+# HelloWorld
+
+Main class, called HelloWorld
+
+**Examples**
+
+```javascript
+var HelloWorld = require('index.js');
+var HW = new HelloWorld();
+```
+
+## wave
+
+Say howdy to the world
+
+**Examples**
+
+```javascript
+var wave = HW.wave();
+console.log(wave); // => 'howdy world!'
+```
+
+Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** a happy-go-lucky string saying hi
+
+## shout
+
+Shout a phrase really loudly by adding an exclamation to the end, asynchronously
+
+**Parameters**
+
+-   `phrase` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** to shout
+-   `different` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** ways to shout
+-   `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** from whence the shout comes, returns a string
+
+**Examples**
+
+```javascript
+var HW = new HelloWorld();
+HW.shout('rawr', {}, function(err, shout) {
+  if (err) throw err;
+  console.log(shout); // => 'rawr!'
+});
+```

Makefile

@@ -1,2 +1,5 @@
 default:
-	npm install --build-from-source
+	npm install --build-from-source
+
+docs:
+	npm run docs

package.json

@@ -5,7 +5,8 @@
   "main": "./lib/index.js",
   "scripts": {
     "test": "tape test/*.test.js",
-    "install": "node-pre-gyp install --fallback-to-build"
+    "install": "node-pre-gyp install --fallback-to-build",
+    "docs": "documentation build src/*.cpp --polyglot -f md -o API.md"
   },
   "author": "Mapbox",
   "license": "ISC",
@@ -14,6 +15,7 @@
     "node-pre-gyp": "^0.6.28"
   },
   "devDependencies": {
+    "documentation": "^4.0.0-beta5",
     "tape": "^4.5.1"
   },
   "binary": {

src/hello_world.cpp

@@ -4,9 +4,10 @@
 #include <iostream>
 
 /**
- * Main method, called HelloWorld
- *
+ * Main class, called HelloWorld
+ * @class HelloWorld
  * @example
+ * var HelloWorld = require('index.js');
  * var HW = new HelloWorld();
  */
 NAN_METHOD(HelloWorld::New)
@@ -39,14 +40,14 @@ Nan::Persistent<v8::Function> &HelloWorld::constructor()
 }
 
 /**
- * Say hello to the world
- *
- * @returns {String} howdy world
+ * Say howdy to the world
+ * 
+ * @name wave
+ * @memberof HelloWorld
+ * @returns {String} a happy-go-lucky string saying hi
  * @example
- * var HW = new HelloWorld();
  * var wave = HW.wave();
- * console.log(wave); // => 'howdy world'
- *
+ * console.log(wave); // => 'howdy world!'
  */
 NAN_METHOD(HelloWorld::wave)
 {
@@ -56,8 +57,10 @@ NAN_METHOD(HelloWorld::wave)
 }
 
 /**
- * Shout a phrase really loudly, by adding an exclamation to the end
+ * Shout a phrase really loudly by adding an exclamation to the end, asynchronously
  *
+ * @name shout
+ * @memberof HelloWorld
  * @param {String} phrase to shout
  * @param {Object} different ways to shout
  * @param {Function} callback - from whence the shout comes, returns a string
@@ -70,7 +73,7 @@ NAN_METHOD(HelloWorld::wave)
  *
  */
 
-// this is the cpp object that will be passed around in our method and callbacks
+// this is the cpp object that will be passed around in 'shout' and callbacks
 // referred to as a "baton"
 class AsyncBaton
 {