Public.API

Table of Contents generated with DocToc

• Namespace: Public
  • Public
    • Methods
      • wicked(args, jsdocargs, cb)

Namespace: Public

Public

Public wicked API

Source:

• index.js , lineno 25

Methods

<static> wicked(args, jsdocargs, cb)

Generates jsdoc wiki pages for project of current working directory and updates github wiki with them.

Note

It is assumed that this is run from the root of the project whose wiki should be generated. Additionally the currently checked out branch will be used when generating blob urls to link source examples.

However the github remote and branch can also be set via environment vars as explained in the documentation of jsdoc-githubify which is used by wicked under the hood.

Parameters:

Name	Type	Description
args	Object	consumed by wicked Properties Name Type Argument Description noclean Boolean <optional> (false) if true, the temp directory into which wiki is checked out will not be removed when done nocommit(false) Boolean <optional> if true, the updated wiki will not be committed automatically loglevel String <optional> (info) level at which to log: silly|verbose|info|warn|error|silent
jsdocargs	Array.<String>	consumed by jsdoc
cb	function	called back when wicked finished generating the wiki page

Source:

• index.js , lineno 29

Generated with wicked.