My favorites | Sign in
Project Home Downloads Wiki Issues Source
Project Information
Members

Description

This enables IDEs that support JS-Doc (Eclipse PDT, WDT, Zend Studio) display tooltips for jQuery functions.

How to enable

Save the .js file somewhere, and point your IDE to use it as a user library. In Eclipse, open your settings at JavaScript / Include Path / User Libraries, click New, enter the name "jQuery 1.3.1". Select it, click Add. Js ..., point to the file. Then, in your javascript project, open project properties, JavaScript / JavaScript Libraries, click Add Runtime Library, select User Library, choose it, finish.

Conventionality

Alas, JS-Doc syntax does not support overloaded functions: jQuery uses them by renaming arguments. So I had to use a couple of symbols:

1: click () - the first usage
2: click (callback) - the second usage

The sign "$" in the middle of the argument name indicates several options for naming. The sign "$" at the end of the argument - its optionality (optional).

Enjoy!

Powered by Google Project Hosting