Настройка основного файла Gulp для запуска JSDoc

Question

Я изо всех сил пытаюсь понять, чего не хватает в моем текущем файле gulpfile, чтобы сделать JSDoc счастливым.

Код, приведенный ниже, не вызывает ошибок, но, глядя на страницу индекса создаваемой документации, ясно, что мои документы не были отформатированы.

Что мне здесь не хватает?

Во-первых, вот функция, которую я хочу документировать.

/** 
* Returns the sum of a and b 
* @param {Number} a 
* @param {Number} b 
* @return {Number} Sum of a and b 
*/ 
var sum = function(a, b){ 
    return a + b; 
}; 

Далее, вот мой gulpfile.js

var gulp = require('gulp'); 
var jsdoc = require('gulp-jsdoc'); 

gulp.task('js-doc', function(){ 
    return gulp.src([ 'app.js' ]) 
    .pipe(jsdoc.parser({}, 'test')) 
    .pipe(jsdoc.generator('./docs')); 
}); 

После того, как я бегу gulp js-doc, он создает Docs/каталог и строит из документации. Тем не менее, посещение страницы index.html в браузере показывает, что никакой документации не было создано. Когда я смотрю на app.js.html, другой файл, созданный JSDoc, я вижу свой блок кода, но ничего на нем не анализируется и не превращается в фактическую документацию. См. Снимок экрана ниже.

Я думаю, что не хватает какой-то фундаментальное понимание JSDoc или Глоток.

Answer 1

Фигурного это:

npm install --save jsdoc gulp-shell

Затем внутри ваш gulpfile.js вставка в следующем требует и задача:

var gulp = require('gulp'); 
var shell = require('gulp-shell'); 

gulp.task('js-doc', shell.task(['./node_modules/jsdoc/jsdoc .'])); 

Теперь при запуске gulp js-doc из командной строки, будет генерировать документацию.