ZEST / base.gruntrunner / Module: tasks/document

tasks/document

require("tasks/document")(grunt, gruntModuleDirectory)

this function registers a grunt task to generate jsdoc from sources and uploading them to gh-pages branch in github. The below tasks are created

  • gh-pages for pushing generated documentation to github gh-pages
  • jsdoc:lib to generate jsdoc documentation
  • document which is an alias to jsdoc:lib
Parameters:
Name Type Description
grunt *

the grunt object
gruntModuleDirectory string

the directory where the grunt modules are located
Source:

this module registers a grunt task to generate jsdoc from sources and uploading them to gh-pages branch in github.

Source:

Requires