jQuery: The Write Less, Do More JavaScript Library

Ticket #790 (new enhancement)

Opened 2 years ago

Last modified 9 months ago

Extend the API docs with a format for callback arguments

Reported by: joern Assigned to: anonymous
Type: enhancement Priority: major
Milestone: Component: docs
Version: Keywords:
Cc: Needs:

Description

Nearly every plugin and a lot of core methods use callbacks. The current documentation system (inline comments, parser etc.) don't provide a way to document the arguments for those callbacks, forcing the documenter to describe them in plain text format, which is not efficent and difficult to read.

A good (or rather bad) example are the various callbacks for Interface's drag plugin. While the several options are described (eg. Function onDrag ...), the arguments have to be described in plain text and are therefore often missing.

Enhancing the system would help both developers and users, as both writing and reading would be easier.

Attachments

Note: See TracTickets for help on using tickets.