Skip to content
This repository was archived by the owner on May 3, 2024. It is now read-only.

Commit 2f292a0

Browse files
committed
Updated documentation.
Updated build process to reference local parser.
1 parent 37f99d9 commit 2f292a0

File tree

2 files changed

+19
-10
lines changed

2 files changed

+19
-10
lines changed

DOCUMENTATION.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ Format string as name.
1515

1616
##### Parameters
1717

18-
- **contents** `String` String to format.
18+
| Name | Type | Description | |
19+
| ---- | ---- | ----------- | -------- |
20+
| contents | `String` | String to format. |   |
1921

2022

2123

@@ -30,7 +32,7 @@ formatStringForName('module.exports.parser');
3032
##### Returns
3133

3234

33-
- `String` Formatted string.
35+
- `String` Formatted string.
3436

3537

3638

@@ -43,7 +45,9 @@ Format string as param.
4345

4446
##### Parameters
4547

46-
- **contents** `String` String to format.
48+
| Name | Type | Description | |
49+
| ---- | ---- | ----------- | -------- |
50+
| contents | `String` | String to format. |   |
4751

4852

4953

@@ -58,7 +62,7 @@ formatStringForParam('[optional param]');
5862
##### Returns
5963

6064

61-
- `String` Formatted string.
65+
- `String` Formatted string.
6266

6367

6468

@@ -71,7 +75,9 @@ Format string as UID.
7175

7276
##### Parameters
7377

74-
- **contents** `String` String to format.
78+
| Name | Type | Description | |
79+
| ---- | ---- | ----------- | -------- |
80+
| contents | `String` | String to format. |   |
7581

7682

7783

@@ -86,7 +92,7 @@ formatStringForUID('example string');
8692
##### Returns
8793

8894

89-
- `String` Formatted string.
95+
- `String` Formatted string.
9096

9197

9298

@@ -99,8 +105,10 @@ Dox parser for doxdox.
99105

100106
##### Parameters
101107

102-
- **content** `String` Contents of file.
103-
- **filename** `String` Name of file. Used to generate UIDs.
108+
| Name | Type | Description | |
109+
| ---- | ---- | ----------- | -------- |
110+
| content | `String` | Contents of file. |   |
111+
| filename | `String` | Name of file. Used to generate UIDs. |   |
104112

105113

106114

@@ -115,7 +123,7 @@ parser(content, 'index.js').then(methods => console.log(methods));
115123
##### Returns
116124

117125

118-
- `Promise` Promise with methods parsed from contents.
126+
- `Promise` Promise with methods parsed from contents.
119127

120128

121129

Makefile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@ BIN=node_modules/.bin
33
test:
44
make lint
55
$(BIN)/mocha 'test/specs/**/*.js'
6+
doxdox index.js --layout markdown --parser index.js | diff DOCUMENTATION.md -
67

78
lint:
89
$(BIN)/eslint index.js
910
$(BIN)/eslint 'test/specs/**/*.js'
1011

1112
docs:
12-
doxdox index.js --layout markdown --output DOCUMENTATION.md
13+
doxdox index.js --layout markdown --parser index.js --output DOCUMENTATION.md
1314

1415
.PHONY: test

0 commit comments

Comments
 (0)