Fix indentation errors (part 3): our API doc shouldn't have any inden…

…tation (beyond the initial two tabs) except for code blocks or nested lists. Refs #13101 !strict

git-svn-id: http://svn.dojotoolkit.org/src/dojox/trunk@29116 560b804f-0ae3-0310-86f3-f6aa0a117693

NodeList/delegate.js

@@ -37,7 +37,7 @@ lang.extend(NodeList, {
 		// fn:
 		//		Callback function passed the event object, and where this == the node that matches the selector.
 		//		That means that for example, after setting up a handler via
-		//			 dojo.query("body").delegate("fieldset", "onclick", ...)
+		// |		 dojo.query("body").delegate("fieldset", "onclick", ...)
 		//		clicking on a fieldset or *any nodes inside of a fieldset* will be reported
 		//		as a click on the fieldset itself.
 		// example:

gauges/BarGauge.js

@@ -63,8 +63,8 @@ return declare("dojox.gauges.BarGauge", Gauge, {
 		// summary:
 		//		This is a helper function used to determine the position that represents
 		//		a given value on the bar graph
-		// value:	Number
-		//			A value to be converted to a position for this bar graph.
+		// value: Number
+		//		A value to be converted to a position for this bar graph.
 
 		return this.dataX + Math.floor((value - this.min)/(this.max - this.min)*this.dataWidth);
 	},
@@ -73,8 +73,8 @@ return declare("dojox.gauges.BarGauge", Gauge, {
 		// summary:
 		//		This is a helper function used to determine the value represented by
 		//		a position on the bar graph
-		// pos:		Number
-		//			A position to be converted to a value.
+		// pos:	Number
+		//		A position to be converted to a value.
 		return (pos - this.dataX)*(this.max - this.min)/this.dataWidth + this.min;
 	},
 
@@ -130,8 +130,8 @@ return declare("dojox.gauges.BarGauge", Gauge, {
 	getRangeUnderMouse: function(/*Object*/e){
 		// summary:
 		//		Determines which range the mouse is currently over
-		// e:	Object
-		//			The event object as received by the mouse handling functions below.
+		// e: Object
+		//		The event object as received by the mouse handling functions below.
 		var range = null;
 		var pos = domGeometry.getContentBox(this.gaugeContent);
 		var x = e.clientX - pos.x;

gauges/_Gauge.js

@@ -64,7 +64,7 @@ return declare("dojox.gauges._Gauge",[Widget],{
 	//		- interval: The interval the ticks should be added on
 	//		- color: The color of the mark and text
 	//		- font: an object with any/all of the following parameters:
-	//			{family: "Helvetica", style: "italic", variant: 'small-caps', weight: 'bold', size: "18pt"}
+	// |	{family: "Helvetica", style: "italic", variant: 'small-caps', weight: 'bold', size: "18pt"}
 	majorTicks: null,
 
 	// minorTicks: Object
@@ -380,10 +380,9 @@ return declare("dojox.gauges._Gauge",[Widget],{
 		//		as the original background argument.
 		// background: Object
 		//		An object in one of the two forms:
-		//			{'color': 'color-name'}
-		//				OR
-		//			(for a gradient:)
-		//			{'type': 'linear', 'colors': [{offset: 0, color:'#C0C0C0'}, {offset: 1, color: '#E0E0E0'}] }
+		// |		{'color': 'color-name'}
+		//		OR (for a gradient:)
+		// |		{'type': 'linear', 'colors': [{offset: 0, color:'#C0C0C0'}, {offset: 1, color: '#E0E0E0'}] }
 		//		If background is null or undefined, this will set the fill to this._backgroundDefault
 		if(!background){ background = this._backgroundDefault; }
 		this.background = background.color || background;

geo/charting/widget/Map.js

@@ -147,7 +147,7 @@ define([
 			//		Resize the widget.
 			// description:
 			//		Resize the domNode and the widget to the dimensions of a box of the following form:
-			//			`{ l: 50, t: 200, w: 300: h: 150 }`
+			//		`{ l: 50, t: 200, w: 300: h: 150 }`
 			// b: Object|Number?
 			//		An hash with optional "l", "t", "w", and "h" properties for "left", "right", "width", and "height"
 			//		respectively; or a number representing the new width.

geo/openlayers/widget/Map.js

@@ -119,7 +119,7 @@ define([
 			//		Resize the widget.
 			// description:
 			//		Resize the domNode and the widget to the dimensions of a box of the following form:
-			//			`{ l: 50, t: 200, w: 300: h: 150 }`
+			//		`{ l: 50, t: 200, w: 300: h: 150 }`
 			// b: Object|Number?
 			//		If passed, denotes the new size of the widget.
 			//		Can be either nothing (widget adapts to the div),

gesture/swipe.js

@@ -12,24 +12,21 @@ define([
 		// summary:
 		//		This module provides swipe gestures including:
 		//
-		//		1. dojox.gesture.swipe
+		//		####dojox.gesture.swipe
 		//
-		//			A series of 'swipe' will be fired during touchmove, this will mostly
-		//			be used to keep sliding the Dom target based on the swiped distance(dx, dy).
+		//		A series of 'swipe' will be fired during touchmove, this will mostly
+		//		be used to keep sliding the Dom target based on the swiped distance(dx, dy).
 		//
-		//		2. dojox.gesture.swipe.end
+		//		####dojox.gesture.swipe.end
 		//	
-		//			Fired when a swipe is ended so that an bounce animation may be applied
-		//			to the dom target sliding to the final position.
+		//		Fired when a swipe is ended so that an bounce animation may be applied
+		//		to the dom target sliding to the final position.
 		//
 		//		Following information will be included in the fired swipe events:
 		//
 		//		1. type: 'swipe'|'swipe.end'
-		//
 		//		2. time: an integer indicating the delta time(in milliseconds)
-		//
 		//		3. dx: delta distance on X axis, dx less than 0 - moving left, dx larger than 0 - moving right
-		//
 		//		4. dy: delta distance on Y axis, dy less than 0 - moving up, dY larger than 0 - moving down
 		//
 		//		Note - dx and dy can also be used together for a hybrid swipe(both vertically and horizontally)

gfx/_gfxBidiSupport.js

@@ -197,10 +197,12 @@ define(["./_base", "dojo/_base/lang","dojo/_base/sniff", "dojo/dom", "dojo/_base
 			// description:
 			//		Finds the right transformation that should be applied on the text, according to renderer.
 			//		Was tested in:
+			//
 			//		Renderers:
-			//			canvas (FF, Chrome, Safari), vml (IE), svg (FF, Chrome, Safari, Opera), silverlight (IE8), svgWeb(FF, Chrome, Safari, Opera, IE).
+			//		canvas (FF, Chrome, Safari), vml (IE), svg (FF, Chrome, Safari, Opera), silverlight (IE8), svgWeb(FF, Chrome, Safari, Opera, IE).
+			//
 			//		Browsers:
-			//			IE [6,7,8], FF [3.6], Chrome (latest for February 2011), Safari [5.0.3], Opera [11.01].
+			//		IE [6,7,8], FF [3.6], Chrome (latest for February 2011), Safari [5.0.3], Opera [11.01].
 
 			if(textDir && text && text.length > 1){
 				var sourceDir = "ltr", targetDir = textDir;

gfx3d/object.js

@@ -69,7 +69,7 @@ declare("dojox.gfx3d.Object", null, {
 		this.fillStyle = null;
 
 		// shape: dojox.gfx.Shape
-		//			an underlying 2D shape
+		//		an underlying 2D shape
 		this.shape = null;
 	},
 

gfx3d/scheduler.js

@@ -43,7 +43,7 @@ var BST = declare("dojox.gfx3d.scheduler.BinarySearchTree", null, {
 		//		for any arbitrary vertex p, if(p - a) dotProduct n = 0, p is inside the plane,
 		//		> 0, p is in the plus space, vice versa for minus space.
 		//		n is the normal vector that is perpendicular the plate, defined as:
-		//			n = ( b - a) crossProduct ( c - a )
+		// |		n = ( b - a) crossProduct ( c - a )
 		//		
 		//		in this implementation, n is declared as normal, ,a is declared as orient.
 		// obj: dojox.gfx3d.Object

grid/LazyTreeGrid.js

@@ -353,11 +353,14 @@ var LazyTreeGrid = declare("dojox.grid.LazyTreeGrid", TreeGrid, {
 	defaultState: null,
 	// colSpans: Object
 	//		a json object that defines column span of each level rows
+	//
 	//		attributes:
-	//			0/1/..: which level need to colspan
-	//			start: start column index of colspan
-	//			end: end column index of colspan
-	//			primary: index of column which content will be displayed (default is value of start).
+	//
+	//		- 0/1/..: which level need to colspan
+	//		- start: start column index of colspan
+	//		- end: end column index of colspan
+	//		- primary: index of column which content will be displayed (default is value of start).
+	//
 	//		example:
 	//		|	colSpans = {
 	//		|	0:	[

grid/enhanced/_FocusManager.js

@@ -20,58 +20,70 @@ var _FocusArea = declare("dojox.grid.enhanced._FocusArea", null, {
 		// name: string
 		//		Name of this area.
 		name: "",
+
+		onFocus: function(event, step){
+			// summary:
+			//		Called when this area logically gets focus.
+			// event: Event object
+			//		May be unavailable, should check before use.
+			// step: Integer
+			//		The distance in the tab sequence from last focused area to this area.
+			// returns:
+			//		whether this area is successfully focused. If not, the next area will get focus.
+
+ 			return true;
+		},
 		
-		// onFocus: function(event, step)
-		//		Called when this area logically gets focus.
-		//		event: Event object
-		//				May be unavailable, should check before use.
-		//		step: Integer
-		//				The distance in the tab sequence from last focused area to this area.
-		//		returns:
-		//				whether this area is successfully focused. If not, the next area will get focus.
-		onFocus: function(event, step){return true;},
-		
-		// onBlur: function(event, step)
-		//		Called when this area logically loses focus.
-		//		event: Event object
-		//				May be unavailable, should check before use.
-		//		step: Integer
-		//				The distance in the tab sequence from this area to the area to focus.
-		//		returns:
-		//				If Boolean, means whether this area has successfully blurred. If not, the next area to focus is still this one.
-		//				If String, means the next area to focus is given by this returned name.
-		onBlur: function(event, step){return true;},
+		onBlur: function(event, step){
+			// summary:
+			//		Called when this area logically loses focus.
+			// event: Event object
+			//		May be unavailable, should check before use.
+			// step: Integer
+			//		The distance in the tab sequence from this area to the area to focus.
+			// returns:
+			//		If Boolean, means whether this area has successfully blurred. If not, the next area to focus is still this one.
+			//		If String, means the next area to focus is given by this returned name.
+
+			return true;
+		},
 		
-		// onMove: function(rowStep, colStep, event)
-		//		Called when focus is moving around within this area.
-		//		rowStep: Integer
-		//		colStep: Integer
-		//		event: Event object
-		//				May be unavailable, should check before use.
-		onMove: function(rowStep, colStep, event){},
+		onMove: function(rowStep, colStep, event){
+			// summary:
+			//		Called when focus is moving around within this area.
+			// rowStep: Integer
+			// colStep: Integer
+			// event: Event object
+			//		May be unavailable, should check before use.
+		},
 		
-		// onKey: function(event, isBubble)
-		//		Called when some key is pressed when focus is logically in this area.
-		//		event: Event object
-		//		isBubble: Boolean
-		//				Whether is in bubble stage (true) or catch stage (false).
-		//		returns:
-		//				If you do NOT want the event to propagate any further along the area stack, return exactly false.
-		//				So if you return nothing (undefined), this event is still propagating.
-		onKey: function(event, isBubble){return true},
+		onKey: function(event, isBubble){
+			// summary:
+			//		Called when some key is pressed when focus is logically in this area.
+			// event: Event object
+			// isBubble: Boolean
+			//		Whether is in bubble stage (true) or catch stage (false).
+			// returns:
+			//		If you do NOT want the event to propagate any further along the area stack, return exactly false.
+			//		So if you return nothing (undefined), this event is still propagating.
+			return true;
+		},
 		
-		// getRegions: function()
-		//		Define the small regions (dom nodes) in this area.
-		//		returns: Array of dom nodes.
-		getRegions: function(){},
+		getRegions: function(){
+			// summary:
+			//		Define the small regions (dom nodes) in this area.
+			//		returns: Array of dom nodes.
+		},
 		
-		// onRegionFocus: function(event)
-		//		Connected to the onfocus event of the defined regions (if any)
-		onRegionFocus: function(event){},
+		onRegionFocus: function(event){
+			// summary:
+			//		Connected to the onfocus event of the defined regions (if any)
+		},
 		
-		// onRegionBlur: function(event)
-		//		Connected to the onblur event of the defined regions (if any)
-		onRegionBlur: function(event){},
+		onRegionBlur: function(event){
+			// summary:
+			//		Connected to the onblur event of the defined regions (if any)
+		},
 =====*/
 	constructor: function(area, focusManager){
 		this._fm = focusManager;

grid/enhanced/plugins/CellMerge.js

@@ -12,9 +12,8 @@ var CellMerge = declare("dojox.grid.enhanced.plugins.CellMerge", _Plugin, {
 	//		This plugin provides functions to merge(un-merge) adjacent cells within one row.
 	//		Acceptable plugin parameters:
 	//
-	//		- mergedCells: Array
+	//		- mergedCells: Array: An array of objects with structure:
 	//
-	//			An array of objects with structure:
 	// |		{
 	// |			row: function(Integer)|Integer
 	// |				If it's a function, it's a predicate to decide which rows are to be merged.
@@ -97,13 +96,13 @@ var CellMerge = declare("dojox.grid.enhanced.plugins.CellMerge", _Plugin, {
 		// returns: Array
 		//		An array of records for merged-cells.
 		//		The record has the following structure:
-		//		{
-		//			"row": 1, //the row index
-		//			"start": 2, //the start column index
-		//			"end": 4, //the end column index
-		//			"major": 3, //the major column index
-		//			"handle": someHandle, //The handler that covers this merge cell record.
-		//		}
+		// |	{
+		// |		"row": 1, //the row index
+		// |		"start": 2, //the start column index
+		// |		"end": 4, //the end column index
+		// |		"major": 3, //the major column index
+		// |		"handle": someHandle, //The handler that covers this merge cell record.
+		// |	}
 		var res = [];
 		for(var i in this._merged){
 			res = res.concat(this._merged[i]);

grid/enhanced/plugins/DnD.js

@@ -242,13 +242,15 @@ var DnD = declare("dojox.grid.enhanced.plugins.DnD", _Plugin, {
 	// summary:
 	//		Provide drag and drop for grid columns/rows/cells within grid and out of grid.
 	//		The store of grid must implement dojo.data.api.Write.
+	//
 	//		DnD selected columns:
-	//			Support moving within grid, moving/copying out of grid to a non-grid DnD target.
+	//		Support moving within grid, moving/copying out of grid to a non-grid DnD target.
+	//
 	//		DnD selected rows:
-	//			Support moving within grid, moving/copying out of grid to any DnD target.
-	//		DnD selected cells (in rectangle shape only):
-	//			Support moving/copying within grid, moving/copying out of grid to any DnD target.
+	//		Support moving within grid, moving/copying out of grid to any DnD target.
 	//
+	//		DnD selected cells (in rectangle shape only):
+	//		Support moving/copying within grid, moving/copying out of grid to any DnD target.
 
 	// name: String,
 	//		plugin name;

grid/enhanced/plugins/Exporter.js

@@ -17,8 +17,8 @@ var Exporter = declare("dojox.grid.enhanced.plugins.Exporter", _Plugin, {
 	//		Acceptable plugin parameters:
 	//
 	//		1. exportFormatter: function(data, cell, rowIndex, item)
-	//				Provide a way to customize how data should look in exported string.
-	//				Note that usually the formatter of grid cell should not be used here (it can return HTML or even widget).
+	//			Provide a way to customize how data should look in exported string.
+	//			Note that usually the formatter of grid cell should not be used here (it can return HTML or even widget).
 	// example:
 	//	|	function onExported(exported_text){
 	//	|		//custom code here...
@@ -66,17 +66,17 @@ var Exporter = declare("dojox.grid.enhanced.plugins.Exporter", _Plugin, {
 		//		then pass the exported text to a given function(onExported).
 		// tags:
 		//		public
-		// type: string
+		// type: String
 		//		A registered export format name
-		// args: object?
+		// args: Object?
 		//		includes:
-		//		{
-		//			fetchArgs: object?
-		//				Any arguments for store.fetch
-		//			writerArgs: object?
-		//				Arguments for the given format writer
-		//		}
-		// onExported: function(string)
+		// |	{
+		// |		fetchArgs: object?
+		// |			Any arguments for store.fetch
+		// |		writerArgs: object?
+		// |			Arguments for the given format writer
+		// |	}
+		// onExported: Function(string)
 		//		Call back function when export result is ready
 		if(lang.isFunction(args)){
 			onExported = args;