Ticket #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: | ||
| Blocking: | Blocked by: |
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
comment:1 Changed 18 months ago by timmywil
- Keywords needsdocs added
- Priority changed from undecided to low
- Status changed from new to open
- Component changed from unfiled to event
Please follow the bug reporting guidlines and use jsFiddle when providing test cases and demonstrations instead of pasting the code in the ticket.
Yes, I suppose we can make that consistent. Thanks!