API docs improvements

[joern]

• 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

[anonymous]

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

[joern]

Standarize documentation for hash options. See tabs plugin:

@option Type name Description

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

[joern]

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

[joern]

FX module: Done.