Skip to main content

Bug Tracker

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: Owned by:
Priority: low Milestone: None
Component: event Version: 1.7.1
Keywords: Cc:
Blocked by: Blocking:

Most callback handlers in the Raw XML API Dump 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 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 timmywil comment:1

component: unfiledevent
keywords: → needsdocs
priority: undecidedlow
status: newopen

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

Changed December 26, 2011 08:42PM UTC by addyosmani comment:2

keywords: needsdocs
resolution: → fixed
status: openclosed

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!