JSDoc: Namespace: Internal

Internal wicked functions

Source:

<static> cloneWiki(cb)

Clones the wiki project of the project in the current directory

Name	Type	Description
`cb`	function	called back with directory to which wiki was cloned

Source:

<static> run(bin, args, cwd, cb) → {Object}

Spawns the given bin with the given args from the cwd or current working directory.

Name	Type	Argument	Description
`bin`	String		full path to the binary to run
`args`	Array.<String>		the args to pass to the binary
`cwd`	String	<optional>	full path to the directory to run bin from, defaults to current directory
`cb`	function		called back with err and/or program exit code

Source:

the spawned binary which exposes stdout and stderr streams

<static> runJsdoc(projectroot, wikiroot, jsdocargs, cb)

Runs the jsdoc binary from the projectroot.

they shouldn't contain --destination option since destination is always inside wiki dir
if no --configure option is given, the default ./config/jsdocrc.json config is passed to jsdoc

Name	Type	Description
`projectroot`	String	root of project whose jsdoc comments are converted to html
`wikiroot`	String	in which the out folder with html files is created
`jsdocargs`	Array.<String>	extra args for jsdoc supplied via `-- --arg one --arg two ...`
`cb`	function	called back when jsdocs were generated

Source: