Class: Scanner

jsdoc/src/scanner~Scanner()

new Scanner()

Source:

Methods

scan(searchPaths, depthopt)

Recursively searches the given searchPaths for js files.
Parameters:
Name Type Attributes Default Description
searchPaths Array.<string>
depth number <optional>
1
Source:
Fires:
  • event:sourceFileFound

jsdoc/src/scanner~Scanner()

new Scanner()

Source:

Extends

  • module:events.EventEmitter

Methods

scan(searchPaths, depthopt)

Recursively searches the given searchPaths for js files.
Parameters:
Name Type Attributes Default Description
searchPaths Array.<string>
depth number <optional>
1
Source:
Fires:
  • event:sourceFileFound

jsdoc/src/scanner~Scanner()

new Scanner()

Source:

Extends

  • module:events.EventEmitter

Methods

scan(searchPaths, depthopt)

Recursively searches the given searchPaths for js files.
Parameters:
Name Type Attributes Default Description
searchPaths Array.<string>
depth number <optional>
1
Source:
Fires:
  • event:sourceFileFound