Opened 16 years ago
Closed 15 years ago
#353 closed enhancement (invalid)
API docs improvements
Reported by: | joern | Owned by: | joern |
---|---|---|---|
Priority: | major | Milestone: | 1.1.3 |
Component: | docs | Version: | 1.1a |
Keywords: | Cc: | ||
Blocked by: | Blocking: |
Description (last modified by )
- Make sure all ampersands are encoded when generating the XML file
- Merge method descriptions where the only difference are optional parameters, but the behavior is the same, ie. fadeIn(speed) and fadeIn(speed, callback)
- Mark in the above cases parameters as optional via @param Type name (optional)
- Parse that marker when generating the xml and create an attribute optional="optional" for that parameter
- Specify the exact possible types when possible, ie. instead of Object specify Number|String for the speed value of animations
Change History (6)
comment:1 Changed 16 years ago by
comment:2 Changed 16 years ago by
Standarize documentation for hash options. See tabs plugin:
@option Type name Description
This is quite nice. Would be even better if it gets parsed.
comment:3 Changed 16 years ago by
Remove return docs when there is nothing returned, eg. for $.get/$.ajax
comment:4 Changed 16 years ago by
Description: | modified (diff) |
---|---|
Milestone: | → 1.1 |
Owner: | changed from john to joern |
Priority: | critical → major |
Version: | → 1.1 |
comment:6 Changed 15 years ago by
Description: | modified (diff) |
---|---|
need: | → Review |
Resolution: | → invalid |
Status: | new → closed |
Note: See
TracTickets for help on using
tickets.
Try again with line breaks:
Make sure all ampersands are encoded when generating the XML file
Merge method descriptions where the only difference are optional parameters, but the behaviour is the same, ie. fadeIn(speed) and fadeIn(speed, callback)
Mark in the above cases paramters as optional via @param Type name (optional)
Parse that marker when generating the xml and create an attribute optional="optional" for that parameter
Specify the exact possible types when possible, ie. instead of Object specify Number|String for the speed value of animations