This Question is Answered

2 "helpful" answers available (2 pts)
2 Replies Last post: Aug 3, 2013 10:58 PM by Cornelis Brouwers  
Cornelis Brouwers Newbie 7 posts since
Feb 8, 2013
Currently Being Moderated

Jul 28, 2013 10:55 AM

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.

Konstantin Ulitin JetBrains 79 posts since
Jan 19, 2012
Currently Being Moderated
Aug 2, 2013 2:56 PM in response to: Cornelis Brouwers
Re: Status of the javascript doc parser and what standard is used?

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.

More Like This

  • Retrieving data ...