6
6
### lib/doxdox.js
7
7
8
8
9
- #### loadParser( config) * private method *
9
+ #### parseInput(input, config)
10
10
11
- Load parser based on user defined choice .
11
+ Parse an input file with parser .
12
12
13
- loadParser( {'parser': 'dox'}).then(parser => {} );
13
+ parseInput('src/main.js', {'parser': 'dox'}).then();
14
14
15
15
16
16
17
17
18
18
##### Parameters
19
19
20
+ - ** input** ` String ` File to parse.
20
21
- ** 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 .
22
23
23
24
24
25
@@ -30,20 +31,21 @@ Load parser based on user defined choice.
30
31
31
32
32
33
33
- #### loadPlugin( config) * private method *
34
+ #### parseInputs(inputs, config)
34
35
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 .
36
37
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'}));
39
39
40
40
41
41
42
42
43
43
##### Parameters
44
44
45
+ - ** inputs** ` Array ` Array of directory globs and/or files.
45
46
- ** 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.
47
49
48
50
49
51
@@ -55,20 +57,23 @@ Load layout plugin based on user defined choice.
55
57
56
58
57
59
58
- #### parseInput(input, config)
59
60
60
- Parse an input file with parser.
61
+ ### lib/loaders.js
61
62
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 => {});
63
69
64
70
65
71
66
72
67
73
##### Parameters
68
74
69
- - ** input** ` String ` File to parse.
70
75
- ** 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 .
72
77
73
78
74
79
@@ -80,21 +85,20 @@ Parse an input file with parser.
80
85
81
86
82
87
83
- #### parseInputs(inputs, config)
88
+ #### loadPlugin( config) * private method *
84
89
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 .
86
91
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 => {});
88
94
89
95
90
96
91
97
92
98
##### Parameters
93
99
94
- - ** inputs** ` Array ` Array of directory globs and/or files.
95
100
- ** 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.
98
102
99
103
100
104
@@ -137,4 +141,3 @@ Finds package.json file from either the directory the script was called from or
137
141
138
142
139
143
* Documentation generated with [ doxdox] ( https://github.com/neogeek/doxdox ) .*
140
-
0 commit comments