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

Vue document is output twice #267

Open
SangJuBaek opened this issue Oct 11, 2019 · 2 comments
Open

Vue document is output twice #267

SangJuBaek opened this issue Oct 11, 2019 · 2 comments

Comments

@SangJuBaek
Copy link

SangJuBaek commented Oct 11, 2019

myJsdoc.json

{
  "tags": {
    "allowUnknownTags": true,
    "dictionaries": ["jsdoc", "closure"]
  },
  "source": {
    "include": ["./"],
    "includePattern": "\\.(js|vue)$",
    "exclude": ["./dist", "./config", "./coverage", "./js", "./temp", "./test", "./docs"],
    "excludePattern": "/node_modules/"
  },
  "plugins": ["node_modules/jsdoc/plugins/markdown", "node_modules/jsdoc-vuejs", "node_modules/jsdoc/plugins/summarize"],
  "markdown": {
    "tags": ["author", "classdesc", "description", "param", "property", "returns", "see", "throws"],
    "parser": "gfm",
    "hardwrap": true
  },
  "opts": {
    "template": "node_modules/minami",
    "encoding": "utf8",
    "destination": "docs",
    "recurse": true,
    "verbose": true
  },
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": false,
    "default": {
      "outputSourceFiles": false
    }
  }
}

and in my component

/**
 * @name QSButton
 * @vue-data {Boolean} loading - It's about button is loading or not.
 * @vue-computed {Object} icon - About the icon that will go inside button
 */

export default {
  extends: BaseCtrl,
  data () {
    return {
      loading: false
    }
  },
...

When I ran the script in this state, the document was created, but the vue related contents were output twice, and markups also break.

Has anyone experienced the same situation as me?

@Elaniobro
Copy link

I had the same error with another plugin I was using. The error for me is/was in the config. Trying modifying yours to read as:
"include": [],

@DaveTorrey
Copy link
Contributor

like @Elaniobro mentioned, it seems like if your pathing overlaps it will duplicate it. make sure the paths stay separate

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

3 participants