From 328be70544c18d8968eec2a9901c575c436d2c50 Mon Sep 17 00:00:00 2001
From: Bill Keese <bill@dojotoolkit.org>
Date: Sat, 21 Jul 2012 07:59:46 +0000
Subject: [PATCH] dijit, dojo, util: fix more dojodoc misformatting, refs
 #13101 !strict

git-svn-id: http://svn.dojotoolkit.org/src/dojo/trunk@29358 560b804f-0ae3-0310-86f3-f6aa0a117693
---
 _base/lang.js                              |  4 ++--
 _base/loader.js                            | 26 +++++++++++-----------
 _base/xhr.js                               |  7 +++---
 back.js                                    | 15 +++++++------
 data/ItemFileReadStore.js                  |  2 +-
 data/ObjectStore.js                        | 16 ++++++-------
 data/api/Read.js                           |  4 ++--
 io/script.js                               | 14 +++++++-----
 query.js                                   |  3 +--
 request/watch.js                           |  5 +++--
 rpc/JsonpService.js                        |  2 +-
 selector/acme.js                           |  3 +--
 store/Memory.js                            | 20 ++++++++---------
 store/api/Store.js                         |  4 +---
 tests/_base/loader/requirejs/depoverlap.js |  3 +--
 15 files changed, 64 insertions(+), 64 deletions(-)

diff --git a/_base/lang.js b/_base/lang.js
index e54e5f5afa..a0cf73dbb5 100644
--- a/_base/lang.js
+++ b/_base/lang.js
@@ -534,8 +534,8 @@ define(["./kernel", "../has", "../sniff"], function(dojo, has){
 			//		String to be used as a template.
 			// map: Object|Function
 			//		If an object, it is used as a dictionary to look up substitutions.
-			//		If a function, it is called for every substitution with following
-			//		parameters: a whole match, a name, an offset, and the whole template
+			//		If a function, it is called for every substitution with following parameters:
+			//		a whole match, a name, an offset, and the whole template
 			//		string (see https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String/replace
 			//		for more details).
 			// pattern: RegEx?
diff --git a/_base/loader.js b/_base/loader.js
index ac4971e419..0b4cc665fc 100644
--- a/_base/loader.js
+++ b/_base/loader.js
@@ -517,17 +517,17 @@ define(["./kernel", "../has", "require", "module", "./json", "./lang", "./array"
 	has.add("config-publishRequireResult", 1, 0, 0);
 
 	dojo.require = function(moduleName, omitModuleCheck) {
-		//	summary:
+		// summary:
 		//		loads a Javascript module from the appropriate URI
 		//
-		//	moduleName: String
+		// moduleName: String
 		//		module name to load, using periods for separators,
 		//		 e.g. "dojo.date.locale".  Module paths are de-referenced by dojo's
 		//		internal mapping of locations to names and are disambiguated by
 		//		longest prefix. See `dojo.registerModulePath()` for details on
 		//		registering new modules.
 		//
-		//	omitModuleCheck: Boolean?
+		// omitModuleCheck: Boolean?
 		//		if `true`, omitModuleCheck skips the step of ensuring that the
 		//		loaded file actually defines the symbol it is referenced by.
 		//		For example if it called as `dojo.require("a.b.c")` and the
@@ -535,7 +535,7 @@ define(["./kernel", "../has", "require", "module", "./json", "./lang", "./array"
 		//		and exception will be throws whereas no exception is raised
 		//		when called as `dojo.require("a.b.c", true)`
 		//
-		//	description:
+		// description:
 		//		Modules are loaded via dojo.require by using one of two loaders: the normal loader
 		//		and the xdomain loader. The xdomain loader is used when dojo was built with a
 		//		custom build that specified loader=xdomain and the module lives on a modulePath
@@ -585,7 +585,7 @@ define(["./kernel", "../has", "require", "module", "./json", "./lang", "./array"
 		//		the current namespace.	It is presumed that the caller will
 		//		take care of that.
 		//
-		//	example:
+		// example:
 		//		To use dojo.require in conjunction with dojo.ready:
 		//
 		//		|	dojo.require("foo");
@@ -594,7 +594,7 @@ define(["./kernel", "../has", "require", "module", "./json", "./lang", "./array"
 		//		|		//you can now safely do something with foo and bar
 		//		|	});
 		//
-		//	example:
+		// example:
 		//		For example, to import all symbols into a local block, you might write:
 		//
 		//		|	with (dojo.require("A.B")) {
@@ -606,7 +606,7 @@ define(["./kernel", "../has", "require", "module", "./json", "./lang", "./array"
 		//		|	var B = dojo.require("A.B");
 		//		|	...
 		//
-		//	returns:
+		// returns:
 		//		the required namespace object
 		function doRequire(mid, omitModuleCheck){
 			var module = getModule(slashName(mid), require.module);
@@ -678,14 +678,14 @@ define(["./kernel", "../has", "require", "module", "./json", "./lang", "./array"
 	};
 
 	dojo.registerModulePath = function(/*String*/moduleName, /*String*/prefix){
-		//	summary:
+		// summary:
 		//		Maps a module name to a path
-		//	description:
+		// description:
 		//		An unregistered module is given the default path of ../[module],
 		//		relative to Dojo root. For example, module acme is mapped to
 		//		../acme.  If you want to use a different module name, use
 		//		dojo.registerModulePath.
-		//	example:
+		// example:
 		//		If your dojo.js is located at this location in the web root:
 		//	|	/myapp/js/dojo/dojo/dojo.js
 		//		and your modules are located at:
@@ -712,10 +712,10 @@ define(["./kernel", "../has", "require", "module", "./json", "./lang", "./array"
 	};
 
 	dojo.platformRequire = function(/*Object*/modMap){
-		//	summary:
+		// summary:
 		//		require one or more modules based on which host environment
 		//		Dojo is currently operating in
-		//	description:
+		// description:
 		//		This method takes a "map" of arrays which one can use to
 		//		optionally load dojo modules. The map is indexed by the
 		//		possible dojo.name_ values, with two additional values:
@@ -724,7 +724,7 @@ define(["./kernel", "../has", "require", "module", "./json", "./lang", "./array"
 		//		dojo.name_, set by your host environment. The items in the
 		//		"common" array will *always* be loaded, regardless of which
 		//		list is chosen.
-		//	example:
+		// example:
 		//		|	dojo.platformRequire({
 		//		|		browser: [
 		//		|			"foo.sample", // simple module
diff --git a/_base/xhr.js b/_base/xhr.js
index d983366685..522ad219fd 100644
--- a/_base/xhr.js
+++ b/_base/xhr.js
@@ -453,7 +453,7 @@ define([
 	dojo._ioCancelAll = watch.cancelAll;
 	/*=====
 	dojo._ioCancelAll = function(){
-		//summary:
+		// summary:
 		//		Cancels all pending IO requests, regardless of IO type
 		//		(xhr, script, iframe).
 	};
@@ -512,8 +512,9 @@ define([
 	var _defaultContentType = "application/x-www-form-urlencoded";
 
 	dojo._ioAddQueryToUrl = function(/*dojo.__IoCallbackArgs*/ioArgs){
-		//summary: Adds query params discovered by the io deferred construction to the URL.
-		//Only use this for operations which are fundamentally GET-type operations.
+		// summary:
+		//		Adds query params discovered by the io deferred construction to the URL.
+		//		Only use this for operations which are fundamentally GET-type operations.
 		if(ioArgs.query.length){
 			ioArgs.url += (ioArgs.url.indexOf("?") == -1 ? "?" : "&") + ioArgs.query;
 			ioArgs.query = null;
diff --git a/back.js b/back.js
index d930395844..75a2e8de3c 100644
--- a/back.js
+++ b/back.js
@@ -62,7 +62,8 @@ define(["./_base/config", "./_base/lang", "./sniff", "./dom", "./dom-construct",
 	back.goBack = handleBackButton;
 
 	function handleForwardButton(){
-		//summary: private method. Do not call this directly.
+		// summary:
+		//		private method. Do not call this directly.
 		var last = forwardStack.pop();
 		if(!last){ return; }
 		if(last.kwArgs["forward"]){
@@ -141,10 +142,10 @@ define(["./_base/config", "./_base/lang", "./sniff", "./dom", "./dom-construct",
 	}
 
 	back.init = function(){
-		//summary:
+		// summary:
 		//		Initializes the undo stack. This must be called from a <script>
 		//		block that lives inside the `<body>` tag to prevent bugs on IE.
-		// description:
+		//
 		//		Only call this method before the page's DOM is finished loading. Otherwise
 		//		it will not work. Be careful with xdomain loading or djConfig.debugAtAllCosts scenarios,
 		//		in order for this method to work, dojo/back will need to be part of a build layer.
@@ -162,13 +163,13 @@ define(["./_base/config", "./_base/lang", "./sniff", "./dom", "./dom-construct",
 	};
 
 	back.setInitialState = function(/*Object*/args){
-		//summary:
+		// summary:
 		//		Sets the state object and back callback for the very first page
 		//		that is loaded.
-		//description:
+		//
 		//		It is recommended that you call this method as part of an event
 		//		listener that is registered via dojo/ready.
-		//args: Object
+		// args: Object
 		//		See the addToHistory() function for the list of valid args properties.
 		initialState = createState(initialHref, args, initialHash);
 	};
@@ -365,7 +366,7 @@ define(["./_base/config", "./_base/lang", "./sniff", "./dom", "./dom-construct",
 	};
 
 	back._iframeLoaded = function(evt, ifrLoc){
-		//summary:
+		// summary:
 		//		private method. Do not call this directly.
 		var query = getUrlQuery(ifrLoc.href);
 		if(query == null){
diff --git a/data/ItemFileReadStore.js b/data/ItemFileReadStore.js
index e5425d523d..6c166769a6 100644
--- a/data/ItemFileReadStore.js
+++ b/data/ItemFileReadStore.js
@@ -488,7 +488,7 @@ var ItemFileReadStore = declare("dojo.data.ItemFileReadStore", [Evented],{
 		//		Function to parse the loaded data into item format and build the internal items array.
 		// dataObject:
 		//		The JS data object containing the raw data to convery into item format.
-		// 	returns: array
+		// returns: Array
 		//		Array of items in store item format.
 
 		// First, we define a couple little utility functions...
diff --git a/data/ObjectStore.js b/data/ObjectStore.js
index 460f81c991..3de2854506 100644
--- a/data/ObjectStore.js
+++ b/data/ObjectStore.js
@@ -123,7 +123,7 @@ return declare("dojo.data.ObjectStore", [Evented],{
 			//		that an item is loaded is situations when the item may or may not be loaded yet.
 			//		If you access a value directly through property access, you can use this to load
 			//		a lazy value as well (doesn't need to be an item).
-			//	args: Object
+			// args: Object
 			//		See dojo.data.api.Read.fetch
 			// example:
 			//	|	store.loadItem({
@@ -150,7 +150,7 @@ return declare("dojo.data.ObjectStore", [Evented],{
 			return item;
 		},
 		close: function(request){
-			//	summary:
+			// summary:
 			// 		See dojo.data.api.Read.close()
 			return request && request.abort && request.abort();
 		},
@@ -367,10 +367,10 @@ return declare("dojo.data.ObjectStore", [Evented],{
 			//		contains a reference to the object itself as well as a
 			//		cloned and trimmed version of old object for use with
 			//		revert.
-			//	object: Object
+			// object: Object
 			//		Indicates that the given object is changing and should be marked as 
 			// 		dirty for the next save
-			// _deleting: [private]
+			// _deleting: [private] Boolean
 			
 			object.__isDirty = true;
 			//if an object is already in the list of dirty objects, don't add it again
@@ -522,20 +522,20 @@ return declare("dojo.data.ObjectStore", [Evented],{
 		// Notification Support
 
 		onSet: function(){
-			//	summary:
+			// summary:
 			// 		See dojo.data.api.Notification.onSet()			
 		},
 		onNew: function(){
-			//	summary:
+			// summary:
 			// 		See dojo.data.api.Notification.onNew()
 		},
 		onDelete:	function(){
-			//	summary:
+			// summary:
 			// 		See dojo.data.api.Notification.onDelete()			
 		},
 		// an extra to get result sets
 		onFetch: function(results){
-			//	summary:
+			// summary:
 			// 		Called when a fetch occurs			
 		}
 
diff --git a/data/api/Read.js b/data/api/Read.js
index 58afa40156..8b034ec3aa 100644
--- a/data/api/Read.js
+++ b/data/api/Read.js
@@ -139,7 +139,7 @@ return declare("dojo.data.api.Read", null, {
 		throw new Error('Unimplemented API: dojo.data.api.Read.isItemLoaded');
 	},
 
-	loadItem: function(/* object */ keywordArgs){
+	loadItem: function(/* Object */ keywordArgs){
 		// summary:
 		//		Given an item, this method loads the item so that a subsequent call
 		//		to store.isItemLoaded(item) will return true.  If a call to
@@ -147,7 +147,7 @@ return declare("dojo.data.api.Read", null, {
 		//		then loadItem() need not do any work at all and will not even invoke
 		//		the callback handlers.  So, before invoking this method, check that
 		//		the item has not already been loaded.
-		// 	keywordArgs:
+		// keywordArgs:
 		//		An anonymous object that defines the item to load and callbacks to invoke when the
 		//		load has completed.  The format of the object is as follows:
 		// |	{
diff --git a/io/script.js b/io/script.js
index 14da0e817d..00238edc91 100644
--- a/io/script.js
+++ b/io/script.js
@@ -84,7 +84,7 @@ define([
 		remove: _script._remove,
 
 		_makeScriptDeferred: function(/*Object*/ args, /*Function?*/ cancel){
-			//summary:
+			// summary:
 			//		sets up a Deferred object for an IO request.
 			var dfd = xhr._ioSetArgs(args, cancel || this._deferredCancel, this._deferredOk, this._deferredError);
 
@@ -148,7 +148,8 @@ define([
 		_counter: 1,
 
 		_addDeadScript: function(/*Object*/ ioArgs){
-			//summary: sets up an entry in the deadScripts array.
+			// summary:
+			//		sets up an entry in the deadScripts array.
 			script._deadScripts.push({id: ioArgs.id, frameDoc: ioArgs.frameDoc});
 			//Being extra paranoid about leaks:
 			ioArgs.frameDoc = null;
@@ -195,7 +196,8 @@ define([
 		},
 
 		_resHandle: function(/*Deferred*/ dfd){
-			//summary: inflight function to handle a completed response.
+			// summary:
+			//		inflight function to handle a completed response.
 			if(script._ioCheck(dfd)){
 				dfd.callback(dfd);
 			}else{
@@ -206,7 +208,7 @@ define([
 		},
 
 		_canAttach: function(/*===== ioArgs =====*/ ){
-			//summary:
+			// summary:
 			//		A method that can be overridden by other modules
 			//		to control when the script attachment occurs.
 			// ioArgs: Object
@@ -214,7 +216,7 @@ define([
 		},
 
 		_jsonpCallback: function(/*JSON Object*/ json){
-			//summary:
+			// summary:
 			//		generic handler for jsonp callback. A pointer to this function
 			//		is used for all jsonp callbacks.  NOTE: the "this" in this
 			//		function will be the Deferred object that represents the script
@@ -237,7 +239,7 @@ define([
 		//		if it loads.
 	};
 	script.remove = function(id, frameDocument){
-		//summary:
+		// summary:
 		//		removes the script element with the given id, from the given frameDocument.
 		//		If no frameDocument is passed, the current document is used.
 	};
diff --git a/query.js b/query.js
index 56c741ea39..3fb1d7dfa3 100644
--- a/query.js
+++ b/query.js
@@ -150,8 +150,7 @@ define(["./_base/kernel", "./has", "./dom", "./on", "./_base/array", "./_base/la
 		//		|	// even getting the coordinates of all the items
 		//		|	var coords = dojo.query(".thinger").coords();
 		// example:
-		//		DOM manipulation functions from the dojo.* namespace area also
-		//		available:
+		//		DOM manipulation functions from the dojo.* namespace area also available:
 		//		|	// remove all of the elements in the list from their
 		//		|	// parents (akin to "deleting" them from the document)
 		//		|	dojo.query(".thinger").orphan();
diff --git a/request/watch.js b/request/watch.js
index 4208bf4eaa..9c1b600f89 100644
--- a/request/watch.js
+++ b/request/watch.js
@@ -12,7 +12,7 @@ define([
 		_inFlight = [];
 
 	function watchInFlight(){
-		//summary:
+		// summary:
 		//		internal method that checks each inflight XMLHttpRequest to see
 		//		if it has completed or if the timeout situation applies.
 
@@ -86,7 +86,8 @@ define([
 	}
 
 	watch.cancelAll = function cancelAll(){
-		//summary: Cancels all pending IO requests, regardless of IO type
+		// summary:
+		//		Cancels all pending IO requests, regardless of IO type
 		try{
 			array.forEach(_inFlight, function(dfd){
 				try{
diff --git a/rpc/JsonpService.js b/rpc/JsonpService.js
index 13ee8d965a..4576efd042 100644
--- a/rpc/JsonpService.js
+++ b/rpc/JsonpService.js
@@ -28,7 +28,7 @@ return declare("dojo.rpc.JsonpService", RpcService, {
 	strictArgChecks: false,
 
 	bind: function(method, parameters, deferredRequestHandler, url){
-		//summary:
+		// summary:
 		//		JSONP bind method. Takes remote method, parameters,
 		//		deferred, and a url, calls createRequest to make a JSON-RPC
 		//		envelope and passes that off with bind.
diff --git a/selector/acme.js b/selector/acme.js
index f91ef01e0e..14a6892b0f 100644
--- a/selector/acme.js
+++ b/selector/acme.js
@@ -247,8 +247,7 @@ define([
 				//	but not:
 				//		thinger > div.howdy[type=thinger]
 				//	the indidual components of the previous query would be
-				//	split into 3 parts that would be represented a structure
-				//	like:
+				//	split into 3 parts that would be represented a structure like:
 				//		[
 				//			{
 				//				query: "thinger",
diff --git a/store/Memory.js b/store/Memory.js
index 8705927557..8d57a2825b 100644
--- a/store/Memory.js
+++ b/store/Memory.js
@@ -48,19 +48,19 @@ return declare("dojo.store.Memory", base, {
 		return this.data[this.index[id]];
 	},
 	getIdentity: function(object){
-		// 	summary:
+		// summary:
 		//		Returns an object's identity
-		// 	object: Object
+		// object: Object
 		//		The object to get the identity from
 		// returns: Number
 		return object[this.idProperty];
 	},
 	put: function(object, options){
-		// 	summary:
+		// summary:
 		//		Stores an object
-		// 	object: Object
+		// object: Object
 		//		The object to store.
-		// 	options: Store.PutDirectives??
+		// options: Store.PutDirectives??
 		//		Additional metadata for storing the data.  Includes an "id"
 		//		property if a specific id is to be used.
 		// returns: Number
@@ -82,11 +82,11 @@ return declare("dojo.store.Memory", base, {
 		return id;
 	},
 	add: function(object, options){
-		// 	summary:
+		// summary:
 		//		Creates an object, throws an error if the object already exists
-		// 	object: Object
+		// object: Object
 		//		The object to store.
-		// 	options: Store.PutDirectives??
+		// options: Store.PutDirectives??
 		//		Additional metadata for storing the data.  Includes an "id"
 		//		property if a specific id is to be used.
 		// returns: Number
@@ -95,9 +95,9 @@ return declare("dojo.store.Memory", base, {
 		return this.put(object, options);
 	},
 	remove: function(id){
-		// 	summary:
+		// summary:
 		//		Deletes an object by its identity
-		// 	id: Number
+		// id: Number
 		//		The identity to use to delete the object
 		// returns: Boolean
 		//		Returns true if an object was removed, falsy (undefined) if no object matched the id
diff --git a/store/api/Store.js b/store/api/Store.js
index 3312882b31..d7c43b1cb6 100644
--- a/store/api/Store.js
+++ b/store/api/Store.js
@@ -237,9 +237,7 @@ Store.QueryResults = declare(null, {
 		//		This is an optional method, and is usually provided by dojo.store.Observable.
 		// listener: Function
 		//		The listener function is called when objects in the query results are modified
-		//		to affect the query result. The listener function is called with the following
-		//
-		//		arguments:
+		//		to affect the query result. The listener function is called with the following arguments:
 		//		| listener(object, removedFrom, insertedInto);
 		//
 		//		- The object parameter indicates the object that was create, modified, or deleted.
diff --git a/tests/_base/loader/requirejs/depoverlap.js b/tests/_base/loader/requirejs/depoverlap.js
index b3ca2524c1..a84ad9f465 100644
--- a/tests/_base/loader/requirejs/depoverlap.js
+++ b/tests/_base/loader/requirejs/depoverlap.js
@@ -4,8 +4,7 @@ function(require, uno, doh){
         "depoverlap",
         [
             function depoverlap(t){
-                //First confirm there is only one script tag for each
-                //module:
+                //First confirm there is only one script tag for each module:
                 var scripts = document.getElementsByTagName("script"),
                     i, counts = {}, modName, props, something;
                 for (var i = scripts.length - 1; i > -1; i--){