Skip to main content

Bug Tracker

Side navigation

#353 closed enhancement (invalid)

Opened November 03, 2006 09:42AM UTC

Closed January 24, 2008 06:17PM UTC

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
  • 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
Attachments (0)
Change History (6)

Changed November 03, 2006 09:44AM UTC by anonymous comment:1

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

Changed November 03, 2006 11:24AM UTC by joern comment:2

Standarize documentation for hash options. See tabs plugin:

@option Type name Description

This is quite nice. Would be even better if it gets parsed.

Changed November 04, 2006 03:18PM UTC by joern comment:3

Remove return docs when there is nothing returned, eg. for $.get/$.ajax

Changed November 17, 2006 08:16PM UTC by john comment:4

description: * 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 * 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
milestone: → 1.1
owner: johnjoern
priority: criticalmajor
version: → 1.1

Changed January 02, 2007 02:35PM UTC by joern comment:5

FX module: Done.

Changed January 24, 2008 06:17PM UTC by joern comment:6

description: * 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 * 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
need: → Review
resolution: → invalid
status: newclosed