JSDoc support for @fileOverview

Discuss all feature requests you have for a new Servoy versions here. Make sure to be clear about what you want, provide an example and indicate how important the feature is for you

JSDoc support for @fileOverview

Postby troy » Sun Mar 13, 2011 6:55 am

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.
Troy Elliott, Data Mosaic

Image
Everything you need to build great apps with Servoy
U.S. demo server
Blog: Coding Nomad
User avatar
troy
 
Posts: 27
Joined: Fri Oct 24, 2003 8:49 pm
Location: Washington, DC

Re: JSDoc support for @fileOverview

Postby Thomas Parry » Sun Mar 13, 2011 3:21 pm

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.
Tom Parry
Prospect IT
Java/C++/Servoy/Jasper Reports/Simulation/Service Applications
http://www.prospect-saas.biz
Thomas Parry
 
Posts: 498
Joined: Thu Jan 10, 2008 8:48 pm
Location: Ottawa, Canada

Re: JSDoc support for @fileOverview

Postby pbakker » Mon Mar 14, 2011 4:57 pm

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
pbakker
 
Posts: 2822
Joined: Wed Oct 01, 2003 8:12 pm
Location: Amsterdam, the Netherlands

Re: JSDoc support for @fileOverview

Postby troy » Mon Mar 14, 2011 10:53 pm

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.
Troy Elliott, Data Mosaic

Image
Everything you need to build great apps with Servoy
U.S. demo server
Blog: Coding Nomad
User avatar
troy
 
Posts: 27
Joined: Fri Oct 24, 2003 8:49 pm
Location: Washington, DC


Return to Discuss Feature Requests

Who is online

Users browsing this forum: No registered users and 0 guests