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.
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.
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:
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.