File tree Expand file tree Collapse file tree 2 files changed +63
-0
lines changed Expand file tree Collapse file tree 2 files changed +63
-0
lines changed Original file line number Diff line number Diff line change 12
12
coverage :
13
13
$(BIN ) /istanbul cover $(BIN ) /_mocha test/specs && $(BIN ) /codecov
14
14
15
+ fixtures :
16
+ bin/doxdox lib/doxdox.js --output test/fixtures/doxdox.md --package lib/
17
+
15
18
docs :
16
19
bin/doxdox ' lib/**/*.js' -p package.json -l markdown -o DOCUMENTATION.md
17
20
Original file line number Diff line number Diff line change
1
+ # Untitled Project
2
+
3
+
4
+
5
+ ### lib/doxdox.js
6
+
7
+
8
+ #### parseInput(input, config)
9
+
10
+ Parse an input file with parser.
11
+
12
+ parseInput('src/main.js', {'parser': 'dox'}).then();
13
+
14
+
15
+
16
+
17
+ ##### Parameters
18
+
19
+ - ** input** ` String ` File to parse.
20
+ - ** config** ` Object ` Configuration object.
21
+ - ** config.parser** ` String ` String representing the parser to be used.
22
+
23
+
24
+
25
+
26
+ ##### Returns
27
+
28
+
29
+ - ` Object ` Promise
30
+
31
+
32
+
33
+ #### parseInputs(inputs, config)
34
+
35
+ Parse array of directory globs and/or inputs, and then render the parsed data through the defined layout plugin.
36
+
37
+ console.log(parseInputs(['src/main.js'], {'parser': 'dox', 'layout': 'markdown'}));
38
+
39
+
40
+
41
+
42
+ ##### Parameters
43
+
44
+ - ** inputs** ` Array ` Array of directory globs and/or files.
45
+ - ** config** ` Object ` Configuration object.
46
+ - ** config.parser** ` String ` String representing the parser to be used.
47
+ - ** config.layout** ` String ` String representing the layout plugin to be used.
48
+
49
+
50
+
51
+
52
+ ##### Returns
53
+
54
+
55
+ - ` Object ` Promise
56
+
57
+
58
+
59
+
60
+ * Documentation generated with [ doxdox] ( https://github.com/neogeek/doxdox ) .*
You can’t perform that action at this time.
0 commit comments