Opened 8 years ago

Closed 7 years ago

#12467 closed defect (fixed)

xhrGet rawBody docs not parsing

Reported by: Adam Peller Owned by: Colin Snover
Priority: high Milestone: 1.8
Component: Doc parser Version: 1.4.0
Keywords: Cc: Tom Trenka
Blocked By: Blocking:

Description

Add to the mysteries of our doc parser:

http://dojotoolkit.org/api/1.6/dojo.xhrGet

rawBody does not parse as a separate property, even though its syntax seems identical to the others. r23740 didn't seem to fix it. The problem has existed since 1.4. 1.3 seems ok.

props like 'load' 'error' and 'handle' didn't make it either, perhaps because of this failure. These are critical properties to make sure we get in the docs.

Change History (4)

comment:1 Changed 8 years ago by Adam Peller

Cc: Tom Trenka added

comment:2 Changed 7 years ago by bill

Owner: changed from Neil Roberts to Colin Snover
Status: newassigned

Even with the new doc parser, and some fixes I made in [29102], there are a bunch of issues with dojo/_base/xhr. I ran:

$ ./parse.sh ../trunk/dojo/_base/xhr.js ../trunk/dojo/main.js

And the issues I see in dojo/main are:

  1. _ioSetArgs(), which takes an __IOArgs kwArgs parameter, loses the description of every attributes besides url.
  2. Although __XhrArgs extends __IOArgs, the inherited properties don't appear. For example, in the documentation for xhrGet(), it only shows the attributes defined directly by __XhrArgs.
  3. The descriptions of the attributes of __XhrArgs are also lost.
Last edited 7 years ago by bill (previous) (diff)

comment:4 Changed 7 years ago by bill

Milestone: tbd1.8
Resolution: fixed
Status: assignedclosed

As it says in the above link, I worked around the doc parser problems. xhrGet()'s rawBody is showing up correctly in http://dojotoolkit.org/api/1.8/dojo/_base/kernel.

Note: See TracTickets for help on using tickets.