grunt-apidoc

This plugin requires Grunt ~0.4.0

About

Generates a RESTful API Documentation with apidoc.

Generated example documentation at http://apidocjs.com/example/

Add the task to your Gruntfile's grunt.initConfig:

apidoc: {
  myapp: {
    src: "app/",
    dest: "apidoc/"
  }
}

Use only one src and one dest, apidoc search in subdirs for files with apidoc-parameters.

All apidoc options can be used within options-block, see apidoc readme for details.

Example options:

includeFilters With includeFilters you can define which files apidoc should include, default *.js.

debug Show verbose information.

apidoc: {
  mypp: {
    src: "app/",
    dest: "apidoc/",
    options: {
      debug: true,
      includeFilters: [ ".*\\.js$" ]
    }
  }
}