Opened 10 years ago

Closed 10 years ago

Last modified 10 years ago

#9984 closed defect (fixed)

Confusing API documentation for dojo.io.iframe

Reported by: floatingworld Owned by: Neil Roberts
Priority: high Milestone: 1.4
Component: Doc parser Version: 1.3.2
Keywords: Cc:
Blocked By: Blocking:

Description

All you can really glean from the current documentation for the dojo.io.iframe methods and classes is approximately "just use send" but the parameters of send and purpose of the package are not evident.

There is, however, documentation at DojoCampus. It might be best to direct users there until docs can be written.

Change History (6)

comment:1 Changed 10 years ago by dante

(In [20329]) refs #9984 - giving root object a summary. leaving bug open, the kwArgs are properly pseudo-doc'd so this might be a parser bug. not mixing standard IoArgs? into a fake declare

comment:2 Changed 10 years ago by dante

Component: DocumentationDoc parser
Owner: set to Neil Roberts

@pottedmeat - this is a parser bug I think. It isn't reducing a declare("ioargs", otherioargs) pseudo-doc. everything seems fine in dojo/io/iframe.js

comment:3 Changed 10 years ago by Neil Roberts

Resolution: fixed
Status: newclosed

(In [20365]) Fixes #9984. Constructor functions weren't getting picked up. Also adding a new doc rule to help stop functions being identified as constructors if they aren't

comment:4 Changed 10 years ago by Neil Roberts

(In [20366]) Refs #9984. Link variables where the summary is used as a description

comment:5 Changed 10 years ago by Neil Roberts

(In [20369]) Refs #9984. Ensure that instance variables show up on the right class

comment:6 Changed 10 years ago by dante

Milestone: tbd1.4
Note: See TracTickets for help on using tickets.