Opened 10 years ago

Closed 10 years ago

Last modified 10 years ago

#9189 closed defect (fixed)

dojo.place summary doc indicates wrong return type

Reported by: Ben Lowery Owned by: Ben Lowery
Priority: high Milestone: 1.4
Component: Documentation Version: 1.3.0
Keywords: Cc:
Blocked By: Blocking:

Description

summary says one thing, return says another. return appears to be correct.

	dojo.place = function(node, refNode, position){
		//	summary:
		//		Attempt to insert node into the DOM, choosing from various positioning options.
		//		Returns true if successful, false otherwise.
		//
		//	node: String|DomNode
		//		id or node reference, or HTML fragment starting with "<" to place relative to refNode
		//
		//	refNode: String|DomNode
		//		id or node reference to use as basis for placement
		//
		//	position: String|Number?
		//		string noting the position of node relative to refNode or a
		//		number indicating the location in the childNodes collection of refNode. 
		//		Accepted string values are:
		//	|	* before
		//	|	* after
		//	|	* replace
		//	|	* only
		//	|	* first
		//	|	* last
		//		"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,
		//		"only" replaces all children.  position defaults to "last" if not specified
		//
		//	returns: DomNode
		//		Returned value is the first argument resolved to a DOM node.

Change History (3)

comment:1 Changed 10 years ago by Ben Lowery

Summary: dojo.place summary doc indicate wrong return typedojo.place summary doc indicates wrong return type

comment:2 Changed 10 years ago by Ben Lowery

Resolution: fixed
Status: newclosed

(In [17402]) Fixed up a doc bug. fixes #9189. !strict

comment:3 Changed 10 years ago by James Burke

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