Added documentation.

Author: neogeek

.eslintrc

@@ -3,6 +3,7 @@
     "@neogeek/eslint-config-standards"
   ],
   "rules": {
+    "capitalized-comments": 0,
     "no-shadow": 0,
     "no-useless-escape": 0,
     "sort-keys": 0

.travis.yml

@@ -6,4 +6,5 @@ node_js:
   - "7"
 before_install:
   - if [[ `npm -v` != 3* ]]; then npm i -g npm@3; fi
+  - npm install doxdox -g
 sudo: false

DOCUMENTATION.md

@@ -0,0 +1,123 @@
+# [doxdox-parser-dox](https://github.com/neogeek/doxdox-parser-dox) *1.0.5*
+
+> Dox parser plugin for doxdox.
+
+
+### index.js
+
+
+#### formatStringForName(contents)  *private method*
+
+Format string as name.
+
+
+
+
+##### Parameters
+
+- **contents** `String`   String to format.
+
+
+
+
+##### Examples
+
+```javascript
+formatStringForName('module.exports.parser');
+```
+
+
+##### Returns
+
+
+- `String`   Formatted string.
+
+
+
+#### formatStringForParam(contents)  *private method*
+
+Format string as param.
+
+
+
+
+##### Parameters
+
+- **contents** `String`   String to format.
+
+
+
+
+##### Examples
+
+```javascript
+formatStringForParam('[optional param]');
+```
+
+
+##### Returns
+
+
+- `String`   Formatted string.
+
+
+
+#### formatStringForUID(contents)  *private method*
+
+Format string as UID.
+
+
+
+
+##### Parameters
+
+- **contents** `String`   String to format.
+
+
+
+
+##### Examples
+
+```javascript
+formatStringForUID('example string');
+```
+
+
+##### Returns
+
+
+- `String`   Formatted string.
+
+
+
+#### parser(content, filename) 
+
+dox parser for doxdox.
+
+
+
+
+##### Parameters
+
+- **content** `String`   Contents of file.
+- **filename** `String`   Name of file. Used to generate UIDs.
+
+
+
+
+##### Examples
+
+```javascript
+parser(content, 'index.js').then(methods => console.log(methods));
+```
+
+
+##### Returns
+
+
+- `Promise`   Promise with methods parsed from contents.
+
+
+
+
+*Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*

Makefile

@@ -8,4 +8,7 @@ lint:
 	$(BIN)/eslint index.js
 	$(BIN)/eslint 'test/specs/**/*.js'
 
+docs:
+	doxdox index.js --layout markdown --output DOCUMENTATION.md
+
 .PHONY: test

README.md

@@ -4,6 +4,7 @@
 
 [![Build Status](https://travis-ci.org/neogeek/doxdox-parser-dox.svg?branch=master)](https://travis-ci.org/neogeek/doxdox-parser-dox)
 [![NPM Version](http://img.shields.io/npm/v/doxdox-parser-dox.svg?style=flat)](https://www.npmjs.org/package/doxdox-parser-dox)
+[![Latest Documentation](https://doxdox.org/images/badge-flat.svg)](https://doxdox.org/)
 
 ## Install
 

index.js

@@ -1,19 +1,56 @@
 const dox = require('dox');
 
+/**
+ * Format string as name.
+ *
+ * @example formatStringForName('module.exports.parser');
+ * @param {String} contents String to format.
+ * @return {String} Formatted string.
+ * @private
+ */
+
 const formatStringForName = content =>
     content.toString()
         .replace(/module\.exports\.|\.prototype|\(\)/g, '');
 
+/**
+ * Format string as param.
+ *
+ * @example formatStringForParam('[optional param]');
+ * @param {String} contents String to format.
+ * @return {String} Formatted string.
+ * @private
+ */
+
 const formatStringForParam = content =>
     content.toString()
         .replace(/\[|\]/g, '');
 
+/**
+ * Format string as UID.
+ *
+ * @example formatStringForUID('example string');
+ * @param {String} contents String to format.
+ * @return {String} Formatted string.
+ * @private
+ */
+
 const formatStringForUID = content =>
     content.toString()
         .toLowerCase()
         .replace(/[^\w\.]+/g, '-')
         .replace(/^-|-$/g, '');
 
+/**
+ * dox parser for doxdox.
+ *
+ * @example parser(content, 'index.js').then(methods => console.log(methods));
+ * @param {String} content Contents of file.
+ * @param {String} filename Name of file. Used to generate UIDs.
+ * @return {Promise} Promise with methods parsed from contents.
+ * @public
+ */
+
 const parser = (content, filename) =>
     dox.parseComments(content, {'raw': true}).filter(method => !method.ignore && method.ctx)
         .map(method => ({