yadop
Yadop (Yet Another Doc Parser) is a JSDoc parser that uses Espree and Doctrine to process your sources.
Installation
You can install Yadop using npm:
$ npm install yadop --save-dev
Usage
Require yadop inside of your JavaScript:
var yadop = ;
JSDoc
In order to process the jsdoc you can execute the following:
yadopjsdoc;
NGDoc
In order to process the ngdoc you can execute the following:
var comments = yadopngdoc; var results = yadopngdoc;
Configuration
Both the yadop.jsdoc.processor and the yadop.ngdoc.processor are called with a configuration object. This object contains the following attributes:
cwd
Type: string
Default: current working directory
Mandatory: false
The current working directory.
pattern
Type: string
Default: **/*.js
Mandatory: false
The file pattern.
ignore
Type: string
Default: []
Mandatory: false
The ignore patterns.
Example
cwd: 'directory/containing/sources' // the source directory pattern: '*/*.js' // the pattern
Available functions
yadop.jsdoc.processor
Type: Function
Param: Configuration
The configuration object as seen above.
Returns: doctrineComment[]
Processes jsdoc for each file in the specified cwd.
yadop.ngdoc.processor
Type: Function
Param: Configuration
Returns: doctrineComment[]
Processes jsdoc for each file in the specified cwd but only containing the ngdoc tags.
yadop.ngdoc.mapper
Type: Function
Param: doctrineComment[]
Returns: yadopModule[]
Processes a doctrineComment[] and returns a yadopmodule[].
Example