Side navigation
#11042 closed bug (fixed)
Opened December 16, 2011 12:20PM UTC
Closed December 26, 2011 08:42PM UTC
Last modified January 18, 2012 02:52PM UTC
callback functions inconsistently documented
Reported by: | philippe.marschall@gmail.com | Owned by: | |
---|---|---|---|
Priority: | low | Milestone: | None |
Component: | event | Version: | 1.7.1 |
Keywords: | Cc: | ||
Blocked by: | Blocking: |
Description
Most callback handlers in the Raw XML API Dump http://api.jquery.com/api/ are documented as handler(eventObject)
. However some are only documented as handler
that should probably be documented as handler(eventObject)
. This seems to be the case for the following functions: off, on, undelegate, delegate, live, one.
Correctly documented function arguments allow tools like http://marketplace.eclipse.org/content/jsdt-jquery to correctly identify function arguments as events and present proposals accordingly.
Functions with handlers documented as handler(eventObject)
: toggle, focusout, focusin, keydown, scroll, resize, keyup, keypress, submit, select, change, blur, focus, mousemove, mouseleave, mouseenter, mouseout, mouseover, dblclick, click, mouseup, mousedown, error, unload, load, unbind, bind.
Attachments (0)
Change History (3)
Changed December 16, 2011 02:32PM UTC by comment:1
component: | unfiled → event |
---|---|
keywords: | → needsdocs |
priority: | undecided → low |
status: | new → open |
Changed December 26, 2011 08:42PM UTC by comment:2
keywords: | needsdocs |
---|---|
resolution: | → fixed |
status: | open → closed |
I've just made these changes. Closing as fixed. Thanks!
Changed January 18, 2012 02:52PM UTC by comment:3
Thanks for fixing, works great now!
Yes, I suppose we can make that consistent. Thanks!