Eclipse Community Forums: Web Tools Project (WTP) » js library file

Help

Home

Home » Eclipse Projects » Web Tools Project (WTP) » js library file - what is the format?

Show: Today's Messages :: Show Polls :: Message Navigator

js library file - what is the format? [message #232186]

Fri, 05 June 2009 13:54

Sheshadri Mantha
Messages: 8
Registered: July 2009

Junior Member

hi;
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 ?

kindest regards,
Sheshadri

Report message to a moderator

Re: js library file - what is the format? [message #232235 is a reply to message #232186]

Sun, 07 June 2009 22:44

Nitin Dahyabhai
Messages: 2084
Registered: July 2009

Senior Member

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 WTP, IBM

Report message to a moderator

Previous Topic:	User libraries not copied
Next Topic:	WSDLValidator is internal

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

]

Current Time: Fri Mar 07 17:42:48 EST 2014