Skip to content

Commit 03fa942

Browse files
committed
Added makefile target to generate fixtures.
1 parent 9e1750d commit 03fa942

File tree

2 files changed

+63
-0
lines changed

2 files changed

+63
-0
lines changed

Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ lint:
1212
coverage:
1313
$(BIN)/istanbul cover $(BIN)/_mocha test/specs && $(BIN)/codecov
1414

15+
fixtures:
16+
bin/doxdox lib/doxdox.js --output test/fixtures/doxdox.md --package lib/
17+
1518
docs:
1619
bin/doxdox 'lib/**/*.js' -p package.json -l markdown -o DOCUMENTATION.md
1720

test/fixtures/doxdox.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
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).*

0 commit comments

Comments
 (0)