|
| Re: js library file - what is the format? [message #232235 is a reply to message #232186] |
Mon, 08 June 2009 02:44  |
|
Sheshadri Mantha wrote:
> our project defines javascript classes in c/c++ (a la SpiderMonkey); and
> i'd like to define stubs for these classes that specify the classnames,
> methods and properties... so that code highlighting and syntax checking
> would be accurate.
>
> questions:
> 1) is there a specific format to a js library file - one that has not
> have documentation for each class/method/property
> 2) any sample js library file available ? if so - where can i get
it?
> (even the firebug js file is ok... just want to look at something
that
> works with JSDT and emulate that syntax).
> 3) where can i learn about jsdoc syntax ?
The format is plain JavaScript; just leave your method contents
empty. Documentation is still encouraged since it improves accuracy
of return types and argument types. All of the provided libraries
are in this format, as they're emulating what a compliant runtime
would provide. Tags are documented at the JSDoc Wiki,
http://code.google.com/p/jsdoc-toolkit/w/list .
--
---
Nitin Dahyabhai
Eclipse WTP Source Editing
IBM Rational
Nitin Dahyabhai
Eclipse Web Tools Platform
|
|
|
Powered by
FUDForum. Page generated in 0.01753 seconds
Search
Help
Register
Login
Home
