dojo.xhr docs need some love

[Adam Peller]

some of the ioargs aren't even parsing. "the error function will be called in an error case" -- it might help to describe what an error case is.

[Adam Peller]

The description that looks like a function is obviously throwing off the parser. Can the doc syntax be such that there is no ambiguity here, or is this a doc parser bug? Also, how would one properly define the function args of the function callbacks here?

[dylan]

(In [14288]) refs #6793, add information about what an error case is for the error handler for xhr

[dylan]

I've added info. about the error case.

The parsing part of this bug appears to be fixed (though not yet live on api.dojotoolkit.org).

Neil, are the args defined property for the error function?

[James Burke]

(In [14291]) Refs #6793: Expanded error callback documentation to reflect recent changes to try/catch behavior.

[Adam Peller]

(In [14446]) Add docs for dojo.xhr args. Only problem left is that IOArgs load, error, and handle property docs aren't showing up -- is function signature confusing jsdoc? Refs #6793

[Adam Peller]

we should probably see this running in api.dtk.org before we close. Also, I think we still need more detail, like information on the callback args (see TODOC)

[Adam Peller]

(In [14462]) Try to improve wording (please review) and add some TODOCs. Refs #6793

[Adam Peller]

(In [14463]) oops, put back response arg docs. But can't response be an Error object or structured data? Don't we need to be more descriptive? Is there any point to using the function(...){} syntax, since it's not parsed and only makes this less clear? Refs #6793

[dylan]

Resolved to my satisfaction thanks to Neil's recent work ( see ​http://api-staging.dojotoolkit.org/dojo.xhr ).