qingwei-li/jsdoc-vue

[➡️ https://github.com/Kocal/jsdoc-vuejs] A jsdoc plugin that parses *.vue files.

jsdoc-vue's Issues

无法生成.vue中的jsdoc

使用本插件发现.vue文件的注释无法生成

配置文件

{
  "tags": {
    "allowUnknownTags": true
  },
  "opts": {
    "destination": "./docs"
  },
  "plugins": [
    "node_modules/jsdoc-vue",
    "plugins/markdown"
  ],
  "source": {
    "includePattern": "\\.(vue|js)$"
  },
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": false,
    "default": {
      "outputSourceFiles": true
    },
    "path": "ink-docstrap",
    "theme": "cerulean",
    "navType": "vertical",
    "linenums": true,
    "dateFormat": "MMMM Do YYYY, h:mm:ss a"
  }
}

gulp.task('jsdoc', function(cb) {
    var config = require('./jsdocConfig.json');
    gulp.src(['README.md','./src/assets/js/*.js', './src/components/Media-list/Media-list.vue'])
        .pipe(plugins.jsdoc3(config, cb));
});