Skip to content
A grunt wrapper for the node.js implementation of Apex Doc.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
tasks
.gitignore
.jshintrc
.travis.yml
Gruntfile.js
LICENSE-MIT
README.md
package.json

README.md

grunt-apex-doc Build Status

A grunt wrapper for the node.js implementation of Apex Doc.

Please see the apex-doc-node README for details on configuration options.

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-apex-doc --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-apex-doc');

The "apexdoc" task

Overview

In your project's Gruntfile, add a section named apexdoc to the data object passed into grunt.initConfig().

grunt.initConfig({
  apexdoc: {
    config: {
      // Specify config options here to override the config.json file from
      // apex-doc-node
    }
  },
});

Contributing

Contributions will be welcome once this projects gets off the ground a bit more.

Release History

(Nothing yet)

You can’t perform that action at this time.