Merge pull request #44 from maxtotterman/f-add-esdoc

Added esdoc

.esdoc.json

@@ -0,0 +1,22 @@
+{
+    "source": "./lib",
+    "destination": "./docs",
+    "plugins": [
+        {
+            "name": "esdoc-coverage-plugin",
+            "option": {
+                "enable": true,
+                "kind": [
+                    "class",
+                    "method",
+                    "member",
+                    "get",
+                    "set",
+                    "constructor",
+                    "function",
+                    "variable"
+                ]
+            }
+        }
+    ]
+}

.gitignore

@@ -13,6 +13,7 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
+docs
 
 # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
 .grunt

CONTRIBUTING.md

@@ -130,6 +130,7 @@ Generally, we follow the style guidelines as suggested by the official language.
 Please run your code through:
 
 - [ESLint](http://eslint.org/) with the standard style guide.
+- [esdoc](https://github.com/sendgrid/nodejs-http-client/blob/master/USAGE.md) to check the documentation coverage of your added code.
 
 <a name="creating-a-pull-request"></a>
 ## Creating a Pull Request

USAGE.md

@@ -15,3 +15,15 @@ To run the example:
 ```bash
 node examples/example
 ```
+
+ # Documentation
+
+ If you would like to auto-generate documentation of the packages, you can do so locally by running:
+
+ `./node_modules/.bin/esdoc`
+
+ Using the .esdoc.json file, esdoc will create documentation in the docs directory. 
+
+ ## Checking docs coverage
+
+ You will find a coverage.json file in the **docs** directory. This will contain information about the documentation coverage for each of the different files in this repo.

package.json

@@ -21,6 +21,8 @@
   "dependencies": {},
   "devDependencies": {
     "chai": "^3.5.0",
+    "esdoc": "^1.0.3",
+    "esdoc-coverage-plugin": "^1.1.0",
     "eslint": "^2.7.0",
     "eslint-config-standard": "^5.1.0",
     "eslint-plugin-standard": "^1.3.2",