Side navigation
#790 closed enhancement (fixed)
Opened January 12, 2007 10:46AM UTC
Closed February 05, 2010 08:20PM UTC
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
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 (0)
Change History (1)
Changed February 05, 2010 08:20PM UTC by comment:1
| 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. → 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. |
|---|---|
| need: | → Review |
| resolution: | → fixed |
| status: | new → closed |
Fixed with the new API docs.