Page 1 of 1

JSDoc support for @fileOverview

PostPosted: Sun Mar 13, 2011 6:55 am
by troy
What do others think about adding support for the @fileOverview tag as outlined here?

Generally I think that the existing JSDoc support in 5/6 is adequate. But sometimes it would be nice to insert an overview of what a form and it's methods are doing.

Re: JSDoc support for @fileOverview

PostPosted: Sun Mar 13, 2011 3:21 pm
by Thomas Parry
Excellent suggestion. Sounds similar to the package overview in Java. Pity there is not one for modules?
I would also like to have @see so that one could use @see to reference the @fileOverview when doc a method or function.

Re: JSDoc support for @fileOverview

PostPosted: Mon Mar 14, 2011 4:57 pm
by pbakker
In Servoy 6 you can already put a comment at the top of a JS file, separate from the declaration of vars and functions and their JSDoc (See the release notes on the wiki).

You could type the @fileOverview tag in there yourself.

Paul

Re: JSDoc support for @fileOverview

PostPosted: Mon Mar 14, 2011 10:53 pm
by troy
pbakker wrote:In Servoy 6 you can already put a comment at the top of a JS file, separate from the declaration of vars and functions and their JSDoc (See the release notes on the wiki).


Thanks. I must've missed that.