Back to Top

doxdox-parser-dox master

Dox parser plugin for doxdox.

formatStringForName(contents) private declaration

Format string as name.

Parameters

Name Type Description
contents String

String to format.

Examples

formatStringForName('module.exports.parser');

Returns

String

Formatted string.

formatStringForParam(contents) private declaration

Format string as param.

Parameters

Name Type Description
contents String

String to format.

Examples

formatStringForParam('[optional param]');

Returns

String

Formatted string.

formatStringForUID(contents) private declaration

Format string as UID.

Parameters

Name Type Description
contents String

String to format.

Examples

formatStringForUID('example string');

Returns

String

Formatted string.

parser(content, filename)

Dox parser for doxdox.

Parameters

Name Type Description
content String

Contents of file.

filename String

Name of file. Used to generate UIDs.

Examples

parser(content, 'index.js').then(methods => console.log(methods));

Returns

Promise

Promise with methods parsed from contents.