Opened 7 years ago

Closed 7 years ago

Last modified 7 years ago

#15594 closed defect (fixed)

API doc for dojo/request module itself

Reported by: bill Owned by: Bryan Forbes
Priority: blocker Milestone: 1.8
Component: IO Version: 1.8.0b1
Keywords: Cc:
Blocked By: Blocking:

Description

In order for dojo/request.js to have reasonable API doc, you'll need to have a pseudo-return listing the functions that request interface provides, something like:

/*=====
return function(url, options){
	// summary:
	//		...
	// url: String
	//		...
	// options: Object?
	//		...
};
=====*/

Change History (7)

comment:1 Changed 7 years ago by bill

Milestone: tbd1.8
Priority: undecidedblocker

We should really have this for 1.8, looks bad if a new module doesn't have API doc on the top page.

comment:2 Changed 7 years ago by Bryan Forbes

In [29448]:

Add API docs for dojo/request. refs #15594 !strict

comment:3 Changed 7 years ago by Bryan Forbes

Resolution: fixed
Status: newclosed

comment:4 Changed 7 years ago by bill

In [29449]:

fix spacing, hyperlinks, spelling, refs #15594

comment:5 Changed 7 years ago by bill

In [29450]:

Fix spacing, hyperlinks, return values, and missing doc for "returnDeferred" parameter. Refs #15594 !strict.

comment:6 Changed 7 years ago by Bryan Forbes

In [29485]:

Update dojo/request documentation. refs #15594 !strict

comment:7 Changed 7 years ago by Bryan Forbes

In [29486]:

Update dojo/request documentation. refs #15594 !strict

Note: See TracTickets for help on using tickets.