Skip to content

Commit c263e76

Browse files
neogeekneogeek
committed
Updated documentation.
Updated fixtures.
1 parent 74f86d7 commit c263e76

File tree

2 files changed

+70
-46
lines changed

2 files changed

+70
-46
lines changed

‎DOCUMENTATION.md

Lines changed: 48 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,19 @@ Parse a file with custom parser.
1717

1818
##### Parameters
1919

20-
- **input** `String` File to parse.
21-
- **config** `Object` Configuration object.
22-
- **config.parser** `String` String representing the parser to be used.
20+
| Name | Type | Description | |
21+
| ---- | ---- | ----------- | -------- |
22+
| input | `String` | File to parse. |   |
23+
| config | `Object` | Configuration object. |   |
24+
| config.parser | `String` | String representing the parser to be used. |   |
2325

2426

2527

2628

2729
##### Returns
2830

2931

30-
- `Object` Promise
32+
- `Object` Promise
3133

3234

3335

@@ -42,19 +44,21 @@ Parse array of files, and then render the parsed data through the defined layout
4244

4345
##### Parameters
4446

45-
- **inputs** `Array` Array of directory globs and/or files.
46-
- **config** `Object` Configuration object.
47-
- **config.ignore** `String` Array of paths to ignore.
48-
- **config.parser** `String` String representing the parser to be used.
49-
- **config.layout** `String` String representing the layout plugin to be used.
47+
| Name | Type | Description | |
48+
| ---- | ---- | ----------- | -------- |
49+
| inputs | `Array` | Array of directory globs and/or files. |   |
50+
| config | `Object` | Configuration object. |   |
51+
| config.ignore | `String` | Array of paths to ignore. |   |
52+
| config.parser | `String` | String representing the parser to be used. |   |
53+
| config.layout | `String` | String representing the layout plugin to be used. |   |
5054

5155

5256

5357

5458
##### Returns
5559

5660

57-
- `Object` Promise
61+
- `Object` Promise
5862

5963

6064

@@ -69,19 +73,21 @@ Parse array of directory globs and/or files, and then render the parsed data thr
6973

7074
##### Parameters
7175

72-
- **inputs** `Array` Array of directory globs and/or files.
73-
- **config** `Object` Configuration object.
74-
- **config.ignore** `String` Array of paths to ignore.
75-
- **config.parser** `String` String representing the parser to be used.
76-
- **config.layout** `String` String representing the layout plugin to be used.
76+
| Name | Type | Description | |
77+
| ---- | ---- | ----------- | -------- |
78+
| inputs | `Array` | Array of directory globs and/or files. |   |
79+
| config | `Object` | Configuration object. |   |
80+
| config.ignore | `String` | Array of paths to ignore. |   |
81+
| config.parser | `String` | String representing the parser to be used. |   |
82+
| config.layout | `String` | String representing the layout plugin to be used. |   |
7783

7884

7985

8086

8187
##### Returns
8288

8389

84-
- `Object` Promise
90+
- `Object` Promise
8591

8692

8793

@@ -101,15 +107,17 @@ Find which node_modules directory to load package from.
101107

102108
##### Parameters
103109

104-
- **pkg** `String` Package name as string.
110+
| Name | Type | Description | |
111+
| ---- | ---- | ----------- | -------- |
112+
| pkg | `String` | Package name as string. |   |
105113

106114

107115

108116

109117
##### Returns
110118

111119

112-
- `Object` Promise
120+
- `Object` Promise
113121

114122

115123

@@ -125,16 +133,18 @@ Load parser based on user defined choice.
125133

126134
##### Parameters
127135

128-
- **config** `Object` Configuration object.
129-
- **config.parser** `String` String representing the parser to be loaded.
136+
| Name | Type | Description | |
137+
| ---- | ---- | ----------- | -------- |
138+
| config | `Object` | Configuration object. |   |
139+
| config.parser | `String` | String representing the parser to be loaded. |   |
130140

131141

132142

133143

134144
##### Returns
135145

136146

137-
- `Object` Promise
147+
- `Object` Promise
138148

139149

140150

@@ -151,16 +161,18 @@ Load layout plugin based on user defined choice.
151161

152162
##### Parameters
153163

154-
- **config** `Object` Configuration object.
155-
- **config.layout** `String` String representing the layout plugin to be loaded.
164+
| Name | Type | Description | |
165+
| ---- | ---- | ----------- | -------- |
166+
| config | `Object` | Configuration object. |   |
167+
| config.layout | `String` | String representing the layout plugin to be loaded. |   |
156168

157169

158170

159171

160172
##### Returns
161173

162174

163-
- `Object` Promise
175+
- `Object` Promise
164176

165177

166178

@@ -181,15 +193,17 @@ Finds package.json file from either the directory the script was called from or
181193

182194
##### Parameters
183195

184-
- **input** `String` *Optional* Directory or file.
196+
| Name | Type | Description | |
197+
| ---- | ---- | ----------- | -------- |
198+
| input | `String` | Directory or file. | *Optional* |
185199

186200

187201

188202

189203
##### Returns
190204

191205

192-
- `String` Path to package.json file.
206+
- `String` Path to package.json file.
193207

194208

195209

@@ -204,15 +218,17 @@ Format an array of directories and/or files to be ignored by globby by adding a
204218

205219
##### Parameters
206220

207-
- **paths** `Array` Array of directories and/or files.
221+
| Name | Type | Description | |
222+
| ---- | ---- | ----------- | -------- |
223+
| paths | `Array` | Array of directories and/or files. |   |
208224

209225

210226

211227

212228
##### Returns
213229

214230

215-
- `Array` Modified array of directories and/or files.
231+
- `Array` Modified array of directories and/or files.
216232

217233

218234

@@ -227,15 +243,17 @@ Sets default configuration values.
227243

228244
##### Parameters
229245

230-
- **config** `Object` Custom configuration object.
246+
| Name | Type | Description | |
247+
| ---- | ---- | ----------- | -------- |
248+
| config | `Object` | Custom configuration object. |   |
231249

232250

233251

234252

235253
##### Returns
236254

237255

238-
- `Object` Modified configuration object.
256+
- `Object` Modified configuration object.
239257

240258

241259

‎test/fixtures/doxdox.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,19 @@ Parse a file with custom parser.
1616

1717
##### Parameters
1818

19-
- **input** `String` File to parse.
20-
- **config** `Object` Configuration object.
21-
- **config.parser** `String` String representing the parser to be used.
19+
| Name | Type | Description | |
20+
| ---- | ---- | ----------- | -------- |
21+
| input | `String` | File to parse. |   |
22+
| config | `Object` | Configuration object. |   |
23+
| config.parser | `String` | String representing the parser to be used. |   |
2224

2325

2426

2527

2628
##### Returns
2729

2830

29-
- `Object` Promise
31+
- `Object` Promise
3032

3133

3234

@@ -41,19 +43,21 @@ Parse array of files, and then render the parsed data through the defined layout
4143

4244
##### Parameters
4345

44-
- **inputs** `Array` Array of directory globs and/or files.
45-
- **config** `Object` Configuration object.
46-
- **config.ignore** `String` Array of paths to ignore.
47-
- **config.parser** `String` String representing the parser to be used.
48-
- **config.layout** `String` String representing the layout plugin to be used.
46+
| Name | Type | Description | |
47+
| ---- | ---- | ----------- | -------- |
48+
| inputs | `Array` | Array of directory globs and/or files. |   |
49+
| config | `Object` | Configuration object. |   |
50+
| config.ignore | `String` | Array of paths to ignore. |   |
51+
| config.parser | `String` | String representing the parser to be used. |   |
52+
| config.layout | `String` | String representing the layout plugin to be used. |   |
4953

5054

5155

5256

5357
##### Returns
5458

5559

56-
- `Object` Promise
60+
- `Object` Promise
5761

5862

5963

@@ -68,19 +72,21 @@ Parse array of directory globs and/or files, and then render the parsed data thr
6872

6973
##### Parameters
7074

71-
- **inputs** `Array` Array of directory globs and/or files.
72-
- **config** `Object` Configuration object.
73-
- **config.ignore** `String` Array of paths to ignore.
74-
- **config.parser** `String` String representing the parser to be used.
75-
- **config.layout** `String` String representing the layout plugin to be used.
75+
| Name | Type | Description | |
76+
| ---- | ---- | ----------- | -------- |
77+
| inputs | `Array` | Array of directory globs and/or files. |   |
78+
| config | `Object` | Configuration object. |   |
79+
| config.ignore | `String` | Array of paths to ignore. |   |
80+
| config.parser | `String` | String representing the parser to be used. |   |
81+
| config.layout | `String` | String representing the layout plugin to be used. |   |
7682

7783

7884

7985

8086
##### Returns
8187

8288

83-
- `Object` Promise
89+
- `Object` Promise
8490

8591

8692

0 commit comments

Comments
 (0)