1. module grunt-jsdoc
   1. function grunt-jsdoc (grunt)
   2. object grunt-jsdoc.exec
2. module grunt-jsdoc.exec
   1. function grunt-jsdoc.exec.buildSpawned (grunt, script, sources, params)
   2. function grunt-jsdoc.exec.lookup (grunt)

module grunt-jsdoc

function grunt-jsdoc (grunt)

• description and source-code

  grunt-jsdoc = function (grunt) {
      'use strict';
  
      require('load-grunt-tasks')(grunt);
  
      // Project configuration.
      grunt.initConfig({
  
          clean: {
              options: {
                  force : true
              },
              test: ['doc']
          },
  
          jsdoc: {
              basic: {
                  src: ['tasks/**.js', 'tasks/lib/*.js'],
                  options: {
                      destination: 'doc/basic'
                  }
              },
              alternate: {
                  src: ['tasks'],
                  dest : 'doc/alternate',
                  options: {
                      readme : 'README.md',
                      recurse : true,
                      private : false
                  }
              },
              spacepack: {
                  src: ['tasks/**/*.js'],
                  options: {
                      destination: 'doc/pack age',
                      package: 'package.json'
                  }
              },
              docstrap: {
                  src: ['tasks/**.js', 'tasks/lib/*.js', 'README.md'],
                  options: {
                      destination: 'doc/docstrap',
                      template: 'node_modules/ink-docstrap/template',
                      configure: 'node_modules/ink-docstrap/template/jsdoc.conf.json'
                  }
              },
              nosrc : {
                  options: {
                      configure : 'test/nosrc.json'
                  }
              }
          },
          nodeunit: {
              unit:      ['test/jsdoc-plugin_test.js'],
              basic:     ['test/jsdoc-basic_test.js'],
              alternate: ['test/jsdoc-alternate_test.js'],
              docstrap:  ['test/jsdoc-docstrap_test.js'],
              spacepack: ['test/jsdoc-spacepack_test.js'],
              nosrc: ['test/jsdoc-nosrc_test.js']
          },
  
          eslint: {
              all: {
                  src: ['Gruntfile.js', 'tasks/**/*.js', 'test/**/*.js']
              }
          }
      });
  
      // Load local tasks.
      grunt.loadTasks('tasks');
  
  
      //testing tasks
      grunt.registerTask('test-basic',     'Test basic jsdoc', ['jsdoc:basic', 'nodeunit:basic']);
      grunt.registerTask('test-alternate', 'Test jsdoc with alternate options', ['jsdoc:alternate', 'nodeunit:alternate']);
      grunt.registerTask('test-docstrap',  'Test jsdoc with a template', ['jsdoc:docstrap', 'nodeunit:docstrap']);
      grunt.registerTask('test-spacepack', 'Test jsdoc with a package and spaces in the paths', ['jsdoc:spacepack', 'nodeunit:spacepack
  ']);
      grunt.registerTask('test-nosrc', 'Test jsdoc without src and dest, only a config', ['jsdoc:nosrc', 'nodeunit:nosrc']);
      grunt.registerTask('test',           'Full test suite', ['clean:test', 'nodeunit:unit', 'test-basic', 'test-alternate', 'test
  -docstrap', 'test-spacepack', 'test-nosrc']);
  
      grunt.registerTask('default', 'Default task will lint and test', ['eslint:all', 'test']);
  }

• example usage

  n/a

module grunt-jsdoc.exec

function grunt-jsdoc.exec.buildSpawned (grunt, script, sources, params)

• description and source-code

  buildSpawned = function (grunt, script, sources, params) {
  
      var flag;
      var cmd = script;
      var args =[];
  
  
      // Compute JSDoc options
      for (flag in params) {
          if (params.hasOwnProperty(flag)) {
              if (params[flag] !== false) {
                  args.push('--' + flag);
              }
              if (typeof params[flag] === 'string') {
                  args.push(params[flag]);
              }
          }
      }
  
      if (!Array.isArray(sources)) {
          sources = [sources];
      }
      args = args.concat(sources);
  
      grunt.log.debug('Running : ' + cmd + ' ' + args.join(' '));
  
      return spawn(cmd, args);
  }

• example usage

  ...
          grunt.log.error('unable to create documentation folder : ' + params.destination);
          grunt.fail.warn('Wrong configuration', errorCode.generic);
      }
  }
  
  //execution of the jsdoc command
  grunt.event.emit('generating.jsdoc', jsdoc, sources, params);
  child = exec.buildSpawned(grunt, jsdoc, sources, params);
  
  child.stdout.on('data', grunt.log.debug);
  child.stderr.on('data', function(data) {
      grunt.log.debug(data);
      if (!options.ignoreWarnings) {
          grunt.log.error(data);
      }
  ...

function grunt-jsdoc.exec.lookup (grunt)

• description and source-code

  lookup = function (grunt) {
      var i, binPath, paths;
      var nodePath = process.env.NODE_PATH || '';
  
      //check first the base path into the cwd
      paths = [
          __dirname + '/../../node_modules/.bin/jsdoc',
          __dirname + '/../../node_modules/jsdoc/jsdoc.js',
          __dirname + '/../../../jsdoc/jsdoc.js'
      ];
  
      //fall back on global if not found at the usual location
      nodePath.split(path.delimiter).forEach(function(p) {
          if (!/\/$/.test(p)) {
              p += '/';
          }
          paths.push(p + '/jsdoc/jsdoc.js');
      });
  
      for (i in paths) {
          binPath = path.resolve(paths[i]);
          if (grunt.file.exists(binPath) && grunt.file.isFile(binPath)) {
              return binPath;
          }
      }
  
      return;
  }

• example usage

  ...
  });
  
  if (jsdocPath && grunt.file.exists(jsdocPath) && grunt.file.isFile(jsdocPath)) {
      //use the given jsdoc path if set
      jsdoc = jsdocPath;
  } else {
      //lookup jsdoc
      jsdoc = exec.lookup(grunt);
  }
  
  //check if jsdoc npm module is installed
  if (jsdoc === undefined) {
      grunt.log.error('Unable to locate jsdoc');
      grunt.fail.warn('Wrong installation/environnement', errorCode.generic);
  }
  ...