Add lint example

tmcw · tmcw · commit f926b3da2326 · 2016-11-11T11:24:05.000-05:00
diff --git a/docs/NODE_API.md b/docs/NODE_API.md
@@ -108,6 +108,22 @@ of lint information intended for human-readable output.
 -   `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** to be called when the documentation generation
     is complete, with (err, result) arguments
 
+**Examples**
+
+```javascript
+documentation.lint('file.js', {}, function (err, lintOutput) {
+  if (err) {
+    throw err;
+  }
+  if (lintOutput) {
+    console.log(lintOutput);
+    process.exit(1);
+  } else {
+    process.exit(0);
+  }
+});
+```
+
 Returns **[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)** calls callback
 
 # formats
diff --git a/index.js b/index.js
@@ -225,6 +225,18 @@ function buildSync(indexes, options) {
  * is complete, with (err, result) arguments
  * @returns {undefined} calls callback
  * @public
+ * @example
+ * documentation.lint('file.js', {}, function (err, lintOutput) {
+ *   if (err) {
+ *     throw err;
+ *   }
+ *   if (lintOutput) {
+ *     console.log(lintOutput);
+ *     process.exit(1);
+ *   } else {
+ *     process.exit(0);
+ *   }
+ * });
  */
 function lint(indexes, options, callback) {
   options = options || {};
