Bug Tracker

Opened 7 years ago

Closed 7 years ago

Last modified 7 years ago

#11042 closed bug (fixed)

callback functions inconsistently documented

Reported by: philippe.marschall@… 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.

Change History (3)

comment:1 Changed 7 years ago by timmywil

Component: unfiledevent
Keywords: needsdocs added
Priority: undecidedlow
Status: newopen

Yes, I suppose we can make that consistent. Thanks!

comment:2 Changed 7 years ago by addyosmani

Keywords: needsdocs removed
Resolution: fixed
Status: openclosed

I've just made these changes. Closing as fixed. Thanks!

comment:3 Changed 7 years ago by philippe.marschall@…

Thanks for fixing, works great now!

Note: See TracTickets for help on using tickets.