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

* type ignored #175

Open
tomek-he-him opened this issue Jun 25, 2015 · 2 comments
Open

* type ignored #175

tomek-he-him opened this issue Jun 25, 2015 · 2 comments

Comments

@tomek-he-him
Copy link
Contributor

$ cat <<——— | dox  --raw --debug
/**
 * @param {(String|Number|*)} a
 */
———
[ { tags: 
     [ { type: 'param',
         string: '{(String|Number|*)} a',
         types: [ 'String', 'Number' ],
         /* … */ } ],
     /* … */ } ]

When I pipe @param {*} a in, I get types: [].

@Twipped
Copy link
Collaborator

Twipped commented Jun 25, 2015

I'm fairly certain you'll need to take this one to jsdoctypeparser. Also, isn't the proper nomenclature mixed to denote that it can take anything?

@tomek-he-him
Copy link
Contributor Author

I haven’t seen any real standard for such things, but http://usejsdoc.org/tags-param.html says {*}.

Personally I’m using the convention {(String|*)} to say that I take any type but it’ll be cast to string. But if there is a standard way to describe that, I’m open.

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