Opened 10 years ago
Closed 8 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 10 years ago by
Cc: | Tom Trenka added |
---|
comment:2 Changed 9 years ago by
Owner: | changed from Neil Roberts to Colin Snover |
---|---|
Status: | new → assigned |
comment:3 Changed 9 years ago by
Likely caused by https://github.com/csnover/js-doc-parse/issues/63
comment:4 Changed 8 years ago by
Milestone: | tbd → 1.8 |
---|---|
Resolution: | → fixed |
Status: | assigned → closed |
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.
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:
And the issues I see in dojo/main are:
__IOArgs
kwArgs parameter, loses the description of every attributes besides url.__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
.__XhrArgs
are also lost.