From 8e05eba52a2074f3ef04b28dd58f35e8754847a4 Mon Sep 17 00:00:00 2001
From: Bill Keese <bill@dojotoolkit.org>
Date: Tue, 17 Jul 2012 12:37:39 +0000
Subject: [PATCH] Add doc to top level dojox/ files, in general telling people
 to load the individual modules inside the package directories instead, refs
 #13101 !strict.

git-svn-id: http://svn.dojotoolkit.org/src/dojox/trunk@29268 560b804f-0ae3-0310-86f3-f6aa0a117693
---
 analytics.js                    |  7 +++++++
 collections.js                  |  8 +++++++-
 color.js                        |  7 +++++++
 data/util/JsonQuery.js          |  5 ++---
 drawing.js                      |  8 +++++++-
 dtl.js                          |  7 +++++++
 editor/plugins/PasteFromWord.js |  6 +++---
 flash.js                        | 11 +++++++++--
 fx.js                           |  7 +++++++
 gfx3d.js                        | 12 ++++++++++--
 highlight.js                    |  7 +++++++
 html.js                         |  7 +++++++
 image.js                        |  7 +++++++
 jsonPath.js                     | 11 +++++++++--
 main.js                         | 10 ++++++++--
 math.js                         | 12 ++++++++++--
 mobile.js                       |  7 +++++++
 mvc.js                          | 10 ++++++++--
 sketch.js                       |  8 ++++++++
 sql.js                          | 11 +++++++++--
 storage.js                      | 11 +++++++++--
 timing.js                       |  7 +++++++
 uuid.js                         |  8 ++++++++
 validate.js                     |  9 +++++++++
 wire.js                         | 12 +++++++++---
 25 files changed, 188 insertions(+), 27 deletions(-)

diff --git a/analytics.js b/analytics.js
index fbd71e6b47..ac7048e1c6 100644
--- a/analytics.js
+++ b/analytics.js
@@ -1,3 +1,10 @@
 define(["./analytics/_base"], function(analytics) {
+	/*=====
+	 return {
+		 // summary:
+		 //		Deprecated.  Should require dojox/analytics modules directly rather than trying to access them through
+		 //		this module.
+	 };
+	 =====*/
 	return analytics;
 });
diff --git a/collections.js b/collections.js
index c7f14c5639..0797b9965a 100644
--- a/collections.js
+++ b/collections.js
@@ -1,3 +1,9 @@
 define(["./collections/_base"], function(collections){
-	return collections;
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/collections modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/	return collections;
 });
diff --git a/color.js b/color.js
index 12c71e1d6d..a6113ee91e 100644
--- a/color.js
+++ b/color.js
@@ -1,3 +1,10 @@
 define(["./color/_base"], function(dxcolor){
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/color modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
 	return dxcolor;
 });
diff --git a/data/util/JsonQuery.js b/data/util/JsonQuery.js
index 96a0f4cf80..8b94d0f316 100644
--- a/data/util/JsonQuery.js
+++ b/data/util/JsonQuery.js
@@ -1,8 +1,8 @@
-define("dojox/data/util/JsonQuery", ["dojo", "dojox"], function(dojo, dojox) {
+define(["dojo", "dojox"], function(dojo, dojox) {
 
 // this is a mixin to convert object attribute queries to
 // JSONQuery/JSONPath syntax to be sent to the server.
-dojo.declare("dojox.data.util.JsonQuery", null, {
+return dojo.declare("dojox.data.util.JsonQuery", null, {
 	useFullIdInQueries: false,
 	_toJsonQuery: function(args, jsonQueryPagination){
 		var first = true;
@@ -94,5 +94,4 @@ dojo.declare("dojox.data.util.JsonQuery", null, {
 	
 });
 
-return dojox.data.util.JsonQuery;
 });
diff --git a/drawing.js b/drawing.js
index 1a2631180b..d7159d83b7 100644
--- a/drawing.js
+++ b/drawing.js
@@ -1,3 +1,9 @@
-//dojo.provide("dojox.drawing");dojo.require("dojox.drawing._base");
 define(['./drawing/_base'],function(){
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/drawing modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
 });
diff --git a/dtl.js b/dtl.js
index d58d4cc42f..cdedbadc5e 100644
--- a/dtl.js
+++ b/dtl.js
@@ -1,3 +1,10 @@
 define(["./dtl/_base"], function(dxdtl){
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/dtl modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
 	return dxdtl;
 });
\ No newline at end of file
diff --git a/editor/plugins/PasteFromWord.js b/editor/plugins/PasteFromWord.js
index c6080459a8..508e464607 100755
--- a/editor/plugins/PasteFromWord.js
+++ b/editor/plugins/PasteFromWord.js
@@ -17,7 +17,7 @@ define([
 	"dojo/i18n!dijit/_editor/nls/commands"
 ], function(dojo, dijit, dojox, _Plugin) {
 
-dojo.declare("dojox.editor.plugins.PasteFromWord", _Plugin, {
+var PasteFromWord = dojo.declare("dojox.editor.plugins.PasteFromWord", _Plugin, {
 	// summary:
 	//		This plugin provides PasteFromWord capability to the editor.  When
 	//		clicked, a dialog opens with a spartan RichText instance to paste
@@ -218,12 +218,12 @@ dojo.subscribe(dijit._scopeName + ".Editor.getPlugin",null,function(o){
 	if(o.plugin){ return; }
 	var name = o.args.name.toLowerCase();
 	if(name === "pastefromword"){
-		o.plugin = new dojox.editor.plugins.PasteFromWord({
+		o.plugin = new PasteFromWord({
 			width: ("width" in o.args)?o.args.width:"400px",
 			height: ("height" in o.args)?o.args.width:"300px"
 		});
 	}
 });
 
-return dojox.editor.plugins.PasteFromWord;
+return PasteFromWord;
 });
diff --git a/flash.js b/flash.js
index 84657ae054..0c0b88a722 100644
--- a/flash.js
+++ b/flash.js
@@ -1,2 +1,9 @@
-dojo.provide("dojox.flash");
-dojo.require("dojox.flash._base");
+define(['./flash/_base'],function(){
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/flash modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
+});
diff --git a/fx.js b/fx.js
index c3e38635d2..b026aa5800 100644
--- a/fx.js
+++ b/fx.js
@@ -1,3 +1,10 @@
 define(["./fx/_base"], function(DojoxFx){
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/fx modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
 	return DojoxFx;
 });
diff --git a/gfx3d.js b/gfx3d.js
index a92f8128fb..72dd270312 100644
--- a/gfx3d.js
+++ b/gfx3d.js
@@ -1,6 +1,14 @@
 // AMD-ID "dojox/gfx3d"
 define(["dojo/_base/kernel","dojox","./gfx3d/matrix","./gfx3d/_base","./gfx3d/object"], function(dojo,dojox) {
-dojo.getObject("gfx3d", true, dojox);
+	dojo.getObject("gfx3d", true, dojox);
 
-return dojox.gfx3d;
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/gfx3d modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
+
+	return dojox.gfx3d;
 });
diff --git a/highlight.js b/highlight.js
index 5c30eb2f2b..17de276a9b 100644
--- a/highlight.js
+++ b/highlight.js
@@ -1,3 +1,10 @@
 define(["./highlight/_base"], function(highlight){
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/highlight modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
 	return highlight;
 });
diff --git a/html.js b/html.js
index e9233024cd..d2b5108bbe 100644
--- a/html.js
+++ b/html.js
@@ -1,3 +1,10 @@
 define(["./html/_base"], function (html) {
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/html modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
 	return html;
 });
\ No newline at end of file
diff --git a/image.js b/image.js
index 8741607d1c..2b20d525ad 100644
--- a/image.js
+++ b/image.js
@@ -1,3 +1,10 @@
 define(["./image/_base"], function(image){
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/image modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
 	return image;
 });
\ No newline at end of file
diff --git a/jsonPath.js b/jsonPath.js
index e18b23d9dd..8956807176 100644
--- a/jsonPath.js
+++ b/jsonPath.js
@@ -1,2 +1,9 @@
-dojo.provide("dojox.jsonPath");
-dojo.require("dojox.jsonPath.query");
+define(['./jsonPath/query'],function(){
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/jsonPath modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
+});
diff --git a/main.js b/main.js
index 6095f00dd0..5abb84ce2a 100644
--- a/main.js
+++ b/main.js
@@ -1,8 +1,14 @@
 define(["dojo/_base/kernel"], function(dojo) {
 	// module:
 	//		dojox/main
-	// summary:
-	//		The dojox package main module; dojox package is somewhat unusual in that the main module currently just provides an empty object.
+
+	/*=====
+	return {
+		// summary:
+		//		The dojox package main module; dojox package is somewhat unusual in that the main module currently just provides an empty object.
+		//		Apps should require modules from the dojox packages directly, rather than loading this module.
+	};
+	=====*/
 
 	return dojo.dojox;
 });
\ No newline at end of file
diff --git a/math.js b/math.js
index 1672c8b174..0d01a5e692 100644
--- a/math.js
+++ b/math.js
@@ -1,6 +1,14 @@
 // AMD-ID "dojox/math"
 define(["dojo", "dojox", "dojox/math/_base"], function(dojo, dojox, math) {
-dojo.getObject("math", true, dojox);
+	dojo.getObject("math", true, dojox);
 
-return dojox.math;
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/math modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
+
+	return dojox.math;
 });
diff --git a/mobile.js b/mobile.js
index 63cf91061a..e1fb047b2c 100755
--- a/mobile.js
+++ b/mobile.js
@@ -4,5 +4,12 @@ define([
 	"dojox/mobile/_base"
 ], function(dojox, lang, base){
 	lang.getObject("mobile", true, dojox);
+	/*=====
+	return {
+		// summary:
+		//		Deprecated.  Should require dojox/mobile classes directly rather than trying to access them through
+		//		this module.
+	};
+	=====*/
 	return dojox.mobile;
 });
diff --git a/mvc.js b/mvc.js
index cf48514989..09c83d2585 100755
--- a/mvc.js
+++ b/mvc.js
@@ -1,8 +1,14 @@
 define(["./mvc/_base"], function(dxmvc){
 	// module:
 	//		dojox/mvc
-	// summary:
-	//		Adds elements of MVC support to Dojo.
+
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/mvc modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
 
 	return dxmvc;
 });
diff --git a/sketch.js b/sketch.js
index 0fd903cd4c..1ecb96e3f4 100644
--- a/sketch.js
+++ b/sketch.js
@@ -7,5 +7,13 @@ define([
 	"./sketch/Toolbar"
 ], function(dojo){
 	dojo.getObject("sketch", true, dojox);
+
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/sketch modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
 	return dojox.sketch;
 });
diff --git a/sql.js b/sql.js
index 87da46196f..2febb3a8d7 100644
--- a/sql.js
+++ b/sql.js
@@ -1,2 +1,9 @@
-dojo.provide("dojox.sql");
-dojo.require("dojox.sql._base");
+define(['./sql/_base'],function(){
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/sql modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
+});
diff --git a/storage.js b/storage.js
index 1c2d14932d..09ff1dae38 100644
--- a/storage.js
+++ b/storage.js
@@ -1,2 +1,9 @@
-dojo.provide("dojox.storage");
-dojo.require("dojox.storage._common");
+define(['./storage/_common'],function(){
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/storage modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
+});
diff --git a/timing.js b/timing.js
index b595ef36b1..8fc02de01f 100644
--- a/timing.js
+++ b/timing.js
@@ -1,3 +1,10 @@
 define(["./timing/_base"], function(timing){
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/timing modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
 	return timing;
 });
diff --git a/uuid.js b/uuid.js
index 962bd99824..5038ad4ff2 100644
--- a/uuid.js
+++ b/uuid.js
@@ -1,3 +1,11 @@
 define(['dojox/uuid/_base'], function(uuid){
+
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/uuid modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
 	return uuid;
 });
diff --git a/validate.js b/validate.js
index 2139c5bb6f..c6c78ce9bc 100644
--- a/validate.js
+++ b/validate.js
@@ -1,3 +1,12 @@
 define(["./validate/_base"], function(validate){
+
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/validate modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
+
 	return validate;
 });
diff --git a/wire.js b/wire.js
index 3426381091..0d2a2eea78 100644
--- a/wire.js
+++ b/wire.js
@@ -1,3 +1,9 @@
-dojo.provide("dojox.wire");
-dojo.require("dojox.wire._base");
-
+define(['./wire/_base'],function(){
+	/*=====
+	 return {
+	 // summary:
+	 //		Deprecated.  Should require dojox/wire modules directly rather than trying to access them through
+	 //		this module.
+	 };
+	 =====*/
+});