Updated documentation.

Author: neogeek

DOCUMENTATION.md

@@ -10,7 +10,7 @@
 
 Parse an input file with parser.
 
-    parseInput('src/main.js', {'parser': 'dox'}).then();
+    parseInput('src/main.js', {'parser': 'dox'}).then(files => {});
 
 
 
@@ -33,9 +33,9 @@ Parse an input file with parser.
 
 #### parseInputs(inputs, config) 
 
-Parse array of directory globs and/or inputs, and then render the parsed data through the defined layout plugin.
+Parse array of directory globs and/or files, and then render the parsed data through the defined layout plugin.
 
-    console.log(parseInputs(['src/main.js'], {'parser': 'dox', 'layout': 'markdown'}));
+    parseInputs(['src/main.js'], {'parser': 'dox', 'layout': 'markdown'}).then(content => {});
 
 
 
@@ -90,7 +90,7 @@ Load parser based on user defined choice.
 Load layout plugin based on user defined choice.
 
     loadPlugin({'layout': 'markdown'}).then(plugin => {});
-    loadPlugin({'layout': 'templates/README.md'}).then(plugin => {});
+    loadPlugin({'layout': 'templates/README.hbs'}).then(plugin => {});
 
 
 

lib/doxdox.js

@@ -17,7 +17,7 @@ const REPLACE_FILENAME_REGEXP = new RegExp(`${process.cwd()}/|./`);
 /**
  * Parse an input file with parser.
  *
- *     parseInput('src/main.js', {'parser': 'dox'}).then();
+ *     parseInput('src/main.js', {'parser': 'dox'}).then(files => {});
  *
  * @param {String} input File to parse.
  * @param {Object} config Configuration object.
@@ -49,9 +49,9 @@ const parseInput = (input, config) =>
     }));
 
 /**
- * Parse array of directory globs and/or inputs, and then render the parsed data through the defined layout plugin.
+ * Parse array of directory globs and/or files, and then render the parsed data through the defined layout plugin.
  *
- *     console.log(parseInputs(['src/main.js'], {'parser': 'dox', 'layout': 'markdown'}));
+ *     parseInputs(['src/main.js'], {'parser': 'dox', 'layout': 'markdown'}).then(content => {});
  *
  * @param {Array} inputs Array of directory globs and/or files.
  * @param {Object} config Configuration object.

lib/loaders.js

@@ -39,7 +39,7 @@ const loadParser = config => new Promise((resolve, reject) => {
  * Load layout plugin based on user defined choice.
  *
  *     loadPlugin({'layout': 'markdown'}).then(plugin => {});
- *     loadPlugin({'layout': 'templates/README.md'}).then(plugin => {});
+ *     loadPlugin({'layout': 'templates/README.hbs'}).then(plugin => {});
  *
  * @param {Object} config Configuration object.
  * @param {String} config.layout String representing the layout plugin to be loaded.

test/fixtures/doxdox.md

@@ -9,7 +9,7 @@
 
 Parse an input file with parser.
 
-    parseInput('src/main.js', {'parser': 'dox'}).then();
+    parseInput('src/main.js', {'parser': 'dox'}).then(files => {});
 
 
 
@@ -32,9 +32,9 @@ Parse an input file with parser.
 
 #### parseInputs(inputs, config) 
 
-Parse array of directory globs and/or inputs, and then render the parsed data through the defined layout plugin.
+Parse array of directory globs and/or files, and then render the parsed data through the defined layout plugin.
 
-    console.log(parseInputs(['src/main.js'], {'parser': 'dox', 'layout': 'markdown'}));
+    parseInputs(['src/main.js'], {'parser': 'dox', 'layout': 'markdown'}).then(content => {});