Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

jsdoc conf.json destination being ignored #13

Closed
RecuencoJones opened this issue Mar 4, 2016 · 1 comment
Closed

jsdoc conf.json destination being ignored #13

RecuencoJones opened this issue Mar 4, 2016 · 1 comment

Comments

@RecuencoJones
Copy link

I have the following jsdoc.conf.json file:

{
  "opts": {
    "destination": "doc"
  },
  "tags": {
    "allowUnknownTags": true
  },
  "plugins": ["plugins/markdown"],
  "markdown": {
    "parser": "gfm",
    "hardwrap": true
  }
}

and gulp task:

var gulp = require('gulp'),
  jsdoc = require('gulp-jsdoc3'),
  config = require('../config/jsdoc.conf.json');

gulp.task('jsdoc', function() {
  return gulp.src('app/**/*.js')
    .pipe(jsdoc(config));
});

gulp.task('doc:js', ['jsdoc']);
gulp.task('doc', ['doc:js']);

After the task is done running, jsdoc files are placed under docs/ folder, which looks like the default one.

Am I doing anything wrong?

@RecuencoJones
Copy link
Author

Nevermind, it was all due to not including the callback function and using return...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant