Skip to content

Commit 176c2ab

Browse files
committed
Rebuilt documentation.
1 parent 03fa942 commit 176c2ab

File tree

1 file changed

+24
-21
lines changed

1 file changed

+24
-21
lines changed

DOCUMENTATION.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,20 @@
66
### lib/doxdox.js
77

88

9-
#### loadParser(config) *private method*
9+
#### parseInput(input, config)
1010

11-
Load parser based on user defined choice.
11+
Parse an input file with parser.
1212

13-
loadParser({'parser': 'dox'}).then(parser => {});
13+
parseInput('src/main.js', {'parser': 'dox'}).then();
1414

1515

1616

1717

1818
##### Parameters
1919

20+
- **input** `String` File to parse.
2021
- **config** `Object` Configuration object.
21-
- **config.parser** `String` String representing the parser to be loaded.
22+
- **config.parser** `String` String representing the parser to be used.
2223

2324

2425

@@ -30,20 +31,21 @@ Load parser based on user defined choice.
3031

3132

3233

33-
#### loadPlugin(config) *private method*
34+
#### parseInputs(inputs, config)
3435

35-
Load layout plugin based on user defined choice.
36+
Parse array of directory globs and/or inputs, and then render the parsed data through the defined layout plugin.
3637

37-
loadPlugin({'layout': 'markdown'}).then(plugin => {});
38-
loadPlugin({'layout': 'templates/README.md'}).then(plugin => {});
38+
console.log(parseInputs(['src/main.js'], {'parser': 'dox', 'layout': 'markdown'}));
3939

4040

4141

4242

4343
##### Parameters
4444

45+
- **inputs** `Array` Array of directory globs and/or files.
4546
- **config** `Object` Configuration object.
46-
- **config.layout** `String` String representing the layout plugin to be loaded.
47+
- **config.parser** `String` String representing the parser to be used.
48+
- **config.layout** `String` String representing the layout plugin to be used.
4749

4850

4951

@@ -55,20 +57,23 @@ Load layout plugin based on user defined choice.
5557

5658

5759

58-
#### parseInput(input, config)
5960

60-
Parse an input file with parser.
61+
### lib/loaders.js
6162

62-
parseInput('src/main.js', {'parser': 'dox'}).then();
63+
64+
#### loadParser(config) *private method*
65+
66+
Load parser based on user defined choice.
67+
68+
loadParser({'parser': 'dox'}).then(parser => {});
6369

6470

6571

6672

6773
##### Parameters
6874

69-
- **input** `String` File to parse.
7075
- **config** `Object` Configuration object.
71-
- **config.parser** `String` String representing the parser to be used.
76+
- **config.parser** `String` String representing the parser to be loaded.
7277

7378

7479

@@ -80,21 +85,20 @@ Parse an input file with parser.
8085

8186

8287

83-
#### parseInputs(inputs, config)
88+
#### loadPlugin(config) *private method*
8489

85-
Parse array of directory globs and/or inputs, and then render the parsed data through the defined layout plugin.
90+
Load layout plugin based on user defined choice.
8691

87-
console.log(parseInputs(['src/main.js'], {'parser': 'dox', 'layout': 'markdown'}));
92+
loadPlugin({'layout': 'markdown'}).then(plugin => {});
93+
loadPlugin({'layout': 'templates/README.md'}).then(plugin => {});
8894

8995

9096

9197

9298
##### Parameters
9399

94-
- **inputs** `Array` Array of directory globs and/or files.
95100
- **config** `Object` Configuration object.
96-
- **config.parser** `String` String representing the parser to be used.
97-
- **config.layout** `String` String representing the layout plugin to be used.
101+
- **config.layout** `String` String representing the layout plugin to be loaded.
98102

99103

100104

@@ -137,4 +141,3 @@ Finds package.json file from either the directory the script was called from or
137141

138142

139143
*Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*
140-

0 commit comments

Comments
 (0)