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.

Sign up for GitHub

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

Jump to bottom

@desc tag not work #140

Closed

hughxusu opened this issue Nov 23, 2018 · 3 comments

hughxusu commented Nov 23, 2018 •

edited

<script>
/**
 * @desc components detail XXXXX
 * @vue-data {Page} page - XXX
 * @vue-data {Layer} layer - XXX
 */
export default {
  name: 'Panel',
  data() {
    return {
      page: null,
      layer: null
    };
  }
};
</script>

content in @desc not output in docs, how to handle it? Thanks~~~

Owner

Kocal commented Nov 23, 2018

That's because of this line: https://github.com/Kocal/jsdoc-vuejs/blob/master/index.js#L61

Change the line to e.doclet.description = (e.doclet.description || '') + str; make @desc works.

I'm working on a patch.

Kocal mentioned this issue

fix: don't overwrite doclet description if already present (@desc tag) #141

Merged

Author

hughxusu commented Nov 23, 2018

it work, thank you~~~

Kocal closed this as completed in #141

Kocal added a commit that referenced this issue


          fix: don't overwrite doclet description if already present (@desc t…

8c6226e

…ag) (#141)

Fix #140

Owner

Kocal commented Nov 23, 2018

Released in v2.3.2

halaszbalazs mentioned this issue

@description tag does not works in v3.0.9 #394

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment