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

Should @type tag be supported by jsdoc package? #32

Closed
iqrow opened this issue Apr 22, 2014 · 3 comments
Closed

Should @type tag be supported by jsdoc package? #32

iqrow opened this issue Apr 22, 2014 · 3 comments

Comments

@iqrow
Copy link
Contributor

iqrow commented Apr 22, 2014

I don't see it listed on the readme and when I try and generate docs I get

Line: 11: @type {{}}...
* Unknown tag: type

After adding it to the tag-defs/index.js it was then of course 'supported' but I'm wondering if and why this particular jsdoc tag isn't supported by default?

Or am I experiencing some bug?

@petebacondarwin
Copy link
Member

Hi @iqrow
This tag just was missed out. It can be added to the jsdoc package tagDefs file if you want to make a Pull Request.

Something like this...

...
  {
    name: 'type',
    canHaveType: true,
    transformFn: function(doc, tag) {
      return tag;
    }
  },
  ...

@iqrow
Copy link
Contributor Author

iqrow commented Apr 23, 2014

Thanks for getting back to me - #33

@petebacondarwin
Copy link
Member

Closed by 904aa00

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

2 participants