Bug Tracker

Opened 13 years ago

Closed 10 years ago

#790 closed enhancement (fixed)

Extend the API docs with a format for callback arguments

Reported by: joern Owned by:
Priority: major Milestone:
Component: docs Version:
Keywords: Cc:
Blocked by: Blocking:

Description (last modified by john)

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.

Change History (1)

comment:1 Changed 10 years ago by john

Description: modified (diff)
need: Review
Resolution: fixed
Status: newclosed

Fixed with the new API docs.

Note: See TracTickets for help on using tickets.