You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I wanted to use famous/core/Context as a return type, but jsdoctypeparser complains. Would be nice to be able to do this to indicate the precise class that's being returned, and plus to help people recognize the classes in the same way they do when they require/import them in their code. f.e.
varSurface=require('famous/core/Surface');
would correspond with
/*
* @type {famous/core/Surface}
*/
blah/Context could be different than foo/Context in a given library. Any ideas?
The text was updated successfully, but these errors were encountered:
So, after digging into this a bit, I have mixed feelings about the solution.
Technically JSDoc types do not support slashes, so jsdoctypeparser is valid to reject it. I have managed to figure out how to get jsdoctypeparser to properly throw the error (instead of sending it to the console), so I can technically trap it and just return the raw input value instead of a proper parse.
I'm just not sure if I should. It would basically be dox absorbing the syntax error in the jsdoc. It could be very confusing to someone under certain circumstances.
I could go either way, so I'm inclined to leave this open to discussion.
I'm having this issue: jsdoctypeparser/jsdoctypeparser#6
I wanted to use
famous/core/Context
as a return type, but jsdoctypeparser complains. Would be nice to be able to do this to indicate the precise class that's being returned, and plus to help people recognize the classes in the same way they do when they require/import them in their code. f.e.would correspond with
blah/Context
could be different thanfoo/Context
in a given library. Any ideas?The text was updated successfully, but these errors were encountered: