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

@@ -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;
 });

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;
 });

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;
 });

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;
 });

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.
+	 };
+	 =====*/
 });

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;
 });

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;
 });

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.
+	 };
+	 =====*/
+});

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;
 });

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;
 });

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;
 });

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;
 });

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;
 });

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.
+	 };
+	 =====*/
+});

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;
 });

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;
 });

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;
 });

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;
 });

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;
 });

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.
+	 };
+	 =====*/
+});

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.
+	 };
+	 =====*/
+});

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;
 });

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;
 });

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;
 });

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.
+	 };
+	 =====*/
+});