• function


Generates documenation using specified generators.


  1. options {Object}

    Options that configure the files processed, how they are procssed, and how the output is generated.

    • generators {moduleName | Array<moduleName>}

      Generators specifies a generator module or array of modules used to create an output for documentation. The default generator is "html" which maps to documentjs's internal html generator.

      You can specify other modules which will be passed a promise containing the docMap and the options and be expected to return a promise that resolves when they are complete.

    • watch {Boolean}

      If true, regenerates all generators when a file matched by options.glob is changed.



A promise that resolves when the documentation has been successfully created.