Requirements

Installation

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

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

Usage

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

<template>  <div>Hello world!</div></template><script>/**   * @vue-prop {Number} initialCounter - Initial counter's value   * @vue-prop {Number} [step=1] - Step   * @vue-data {Number} counter - Current counter's value   * @vue-computed {String} message   * @vue-event {Number} increment - Emit counter's value after increment   * @vue-event {Number} decrement - Emit counter's value after decrement*/exportdefault {    props: {      initialCounter: {        type:Number,        required:true,      },      step: {        type:Number,        default:1,      },    },data () {return {        counter:0,      }    },    computed: {message() {return`Current value is${this.counter}`;      }    },    methods: {increment() {this.counter+=1;this.$emit('increment',this.counter);      },decrement() {this.counter-=1;this.$emit('decrement',this.counter);      }    }  }</script>

Supported templates

Testing

Install Dependencies

$ git clone https://github.com/Kocal/jsdoc-vuejs$cd jsdoc-vuejs$ yarn install# For testing the example docs$cd example$ yarn install

Generate documentations

$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

Unit

$ yarntest

E2E

$cd example$ yarn docs:all

$cd ..$ yarn cypress run

License