apidoc.js 930 B

12345678910111213141516171819202122232425262728293031
  1. module.exports = function(grunt) {
  2. // modules
  3. var apidoc = require('apidoc');
  4. // task
  5. grunt.registerMultiTask('apidoc', 'Create REST-API-Documentation with apidoc', function() {
  6. var config = this.data;
  7. var options = config.options || {};
  8. grunt.log.subhead('grunt-apidoc');
  9. // options
  10. options.src = config.src || config.i || options.i;
  11. options.dest = config.dest || config.o || options.o;
  12. options.template = config.template || config.t || options.t;
  13. // execute
  14. var result = apidoc.createDoc(options);
  15. if (result === false) {
  16. grunt.log.error('grunt-apidoc error: Execution terminated (set \'options: { debug: true }\' in Gruntfile.js for details.');
  17. return false;
  18. }
  19. else {
  20. grunt.log.ok('grunt-apidoc finished.');
  21. return true;
  22. }
  23. });
  24. };