Dox parser plugin for doxdox.
Format string as name.
Name | Type | Description | |
---|---|---|---|
contents |
String
|
String to format. |
formatStringForName('module.exports.parser');
String
Formatted string.
Format string as param.
Name | Type | Description | |
---|---|---|---|
contents |
String
|
String to format. |
formatStringForParam('[optional param]');
String
Formatted string.
Format string as UID.
Name | Type | Description | |
---|---|---|---|
contents |
String
|
String to format. |
formatStringForUID('example string');
String
Formatted string.
Dox parser for doxdox.
Name | Type | Description | |
---|---|---|---|
content |
String
|
Contents of file. |
|
filename |
String
|
Name of file. Used to generate UIDs. |
parser(content, 'index.js').then(methods => console.log(methods));
Promise
Promise with methods parsed from contents.