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

Auto parse @vue-prop #97

Open
Hideman85 opened this issue Jul 30, 2018 · 4 comments
Open

Auto parse @vue-prop #97

Hideman85 opened this issue Jul 30, 2018 · 4 comments

Comments

@Hideman85
Copy link

By default @vue-prop don't set default value and set require to true

/**
 * ...
 * @vue-prop {Number} step - Set increment/decrement step
 */
  props: {
    ...
    step: {
      type: Number,
      default: 1
    },
Name Type Default value Required ? Description
step Number - Yes Set increment/decrement step

Make auto parsing for require, default value and type ...

/**
 * ...
 * @vue-prop step - Set increment/decrement step
 */
  props: {
    ...
    step: {
      type: Number,
      default: 1
    },
Name Type Default value Required ? Description
step Number - No Set increment/decrement step
@Kocal
Copy link
Owner

Kocal commented Jul 30, 2018

Please read #59, you will understand why I removed this feature. 😕

But if you are able to find a clean and working solution to do that (with some tests 👀), I would be happy to review your PR! 🙂

@ozum
Copy link

ozum commented Nov 30, 2018

Hi,

Looking issues on #59, if I understand correctly, problems were related to parsing vue components. Have you seen jsdoc-vuedoc? It uses vuedoc/parser and vuedoc/md.

I want to share here, maybe it could help you for next major version.

@Kocal
Copy link
Owner

Kocal commented Nov 30, 2018

That's interesting, thanks for the sharing. 👍

@ozum
Copy link

ozum commented Nov 30, 2018

Also I found another one: vue-docgen-api

This is also used by big projects such as vue-styleguidist.

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