Status of the javascript doc parser and what standard is used?

Hi all,

Does anyone knows what the status of the javascript doc parser is? Is it completed or almost?

And what standard does it use? JSDoc3 from http://usejsdoc.org/ (https://github.com/jsdoc3/jsdoc) or does it use Google Closure Compiler 'standard' https://developers.google.com/closure/compiler/docs/js-for-compiler.

Or is it just a mix of tags from different standards that is supported (incomplete)?

If no standard is used, is there a list somewhere what tags are supported and from which standards?

I've written all new 'stubs' for HTML*/DOM*/EcmaScript5.*/WeBGL* according to the official documents and standards of W3C and ECMA.
Actually it are more then just stubs, most have short description, some long description, and it's infact working code, at least it can be ;)

While working on the 'stubs' I've noticed that not all tags are supported or acting weird, so that's why I'm interested in what doc tags are supported.

If JSDoc3 is supported then I can run all through the API document generator to check if the 'stubs' are allright.

Thank you in advance for any info on this subject,

Cornelis.

2 comments

Hi Cornelis,

We are trying to support mix of tags from different standarts, so users won't be forced to rewrite their documentation code to work well with WebStorm. Google Closure is supported the most completely, including type syntax. JSDoc3 is not supported for now. Please watch WEB-3574 and http://blog.jetbrains.com/webide/2012/08/closure-syntax/.

Konstantin.

0

Hi Konstantin,

Thank you for your answer and your time.

I've made a quick cross reference list which includes JSDoc3, JSDoc and Google Closure Compiler tags. It's indeed a mix as you told.
Maybe it's interesting to look at the list, I've uploaded the list at http://tekiusi.tk/pages/ . It's a piece of a page that I use local so not all links are working.

Now I'm about to check and test every tag to see what is working and what not.

Thanks again for your help and the links..

Cornelis.

0

Please sign in to leave a comment.