Opened 11 years ago

Closed 11 years ago

Last modified 11 years ago

#8253 closed defect (fixed)

[jsdoc] api mangling order of dojo.byId parameters

Reported by: kiuma Owned by: Neil Roberts
Priority: high Milestone: 1.3
Component: General Version: 1.2.1
Keywords: Cc:
Blocked By: Blocking:

Description

in the api description it's dojo.byId(doc, id): assume it's a node | DomNode? it should be dojo.byId(id, doc): assume it's a node | DomNode?

Change History (5)

comment:1 Changed 11 years ago by dante

Owner: changed from anonymous to Neil Roberts
Summary: dojo.byId wrong api description[jsdoc] api mangling order of dojo.byId parameters

in _base/html.js:

/*=====
dojo.byId = function(id, doc){
	//	summary:
	//		Returns DOM node with matching `id` attribute or `null` 
	//		if not found, similar to "$" function in another library.
	//		If `id` is a DomNode, this function is a no-op.
	//
	//	id: String|DOMNode
	//	 	A string to match an HTML id attribute or a reference to a DOM Node
	//
	//	doc: Document?
	//		Document to work in. Defaults to the current value of
	//		dojo.doc.  Can be used to retrieve
	//		node references from other documents.
=====*/

versus the API page:

http://api.dojotoolkit.org/jsdoc/dojo/HEAD/dojo.byId/

it has doc, id listed as the order or parameters.

comment:2 Changed 11 years ago by Neil Roberts

Resolution: fixed
Status: newclosed

comment:3 Changed 11 years ago by dante

Resolution: fixed
Status: closedreopened

the link above to api page still has the order reversed, and there was no code change recorded in svn.

comment:4 Changed 11 years ago by dante

Resolution: fixed
Status: reopenedclosed

well, must have been a cache issue or something. Still not sure how it was fixed.

comment:5 Changed 11 years ago by Adam Peller

Milestone: tbd1.3

batch move of tickets marked 'tbd' fixed in the 1.3 timeframe

Note: See TracTickets for help on using tickets.