JSDoc for VueJS
===============


A JSDoc plugin for listing props, data, computed data, and methods from .vue files.

:warning: This branch is for Vue 3. If you still use Vue 2, please see 3.x branch.

---

Requirements

- Node 10+
- Vue 3

Installation

``bash
$ npm install --save-dev jsdoc jsdoc-vuejs
`

You also need to install @vue/compiler-sfc that match your Vue version:

`bash
$ npm install --save-dev @vue/compiler-sfc
`

Usage

Your should update your JSDoc configuration to enable JSDoc-VueJS:

`json
{
"plugins": [
"node_modules/jsdoc-vuejs"
],
"source": {
"includePattern": "\\.(vue|js)$"
}
}
`

Update your .vue files with one of the following tags:

- @vue-prop
- @vue-data
- @vue-computed
- @vue-event

All of those tags work the same way than @param tag.

`vue



`

Supported templates

The rendering engine has been rewritten in v2, it can supports every JSDoc templates that exists.

Actually, it supports 4 templates:
- Default
- Docstrap
- Minami
- Tui

If you use a template that is not supported, it will use the default one as a fallback.

Feel free to open an issue/pull request if your template is not supported!

Default


Docstrap


Minami


Tui


Testing

$3

`bash
$ git clone https://github.com/Kocal/jsdoc-vuejs
$ cd jsdoc-vuejs
$ yarn install

For testing the example docs


$ cd example
$ yarn install
`

#### Generate documentations

`bash
$ cd example

Generate docs for every renderer

$ yarn docs:all

or one by one

$ yarn docs # default jsdoc template
$ yarn docs:docstrap
$ yarn docs:minami
$ yarn docs:tui
`

$3

`bash
$ yarn test
`

$3

Before running integration tests with Cypress,
you should generate documentation with all renderers:

`bash
$ cd example
$ yarn docs:all
`

And then run Cypress:

`bash
$ cd ..
$ yarn cypress run
``

License

MIT.