Doc only commit. Simplify kwargs definitions and workaround doc parse…

…r bugs when kwargs is declared as a function, refs #13101 !strict.

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

charting/Chart.js

@@ -7,10 +7,9 @@ define(["../main", "dojo/_base/lang", "dojo/_base/array","dojo/_base/declare", "
 	 		 Element, SimpleTheme, Series, common, shape,
 	 		 g, func, funcFold, funcReversed){
 	/*=====
-	var __ChartCtorArgs = function(margins, stroke, fill, delayInMs){
+	var __ChartCtorArgs = {
 		// summary:
 		//		The keyword arguments that can be passed in a Chart constructor.
-		//
 		// margins: Object?
 		//		Optional margins for the chart, in the form of { l, t, r, b}.
 		// stroke: dojox.gfx.Stroke?
@@ -19,37 +18,28 @@ define(["../main", "dojo/_base/lang", "dojo/_base/array","dojo/_base/declare", "
 		//		An optional fill for the chart.
 		// delayInMs: Number
 		//		Delay in ms for delayedRender(). Default: 200.
-		this.margins = margins;
-		this.stroke = stroke;
-		this.fill = fill;
-		this.delayInMs = delayInMs;
-	}
-	 =====*/
+	};
+	=====*/
 
 	/*=====
-	var __SeriesCtorArgs = function(plot){
+	var __SeriesCtorArgs = {
 		// summary:
 		//		An optional arguments object that can be used in the Series constructor.
 		// plot: String?
 		//		The plot (by name) that this series belongs to.
-		this.plot = plot;
 	};
 	=====*/
 
 	/*=====
-	var __BaseAxisCtorArgs = function(vertical, min, max, from, to){
+	var __BaseAxisCtorArgs = {
 		// summary:
 		//		Optional arguments used in the definition of an invisible axis.
-		//
 		// vertical: Boolean?
 		//		A flag that says whether an axis is vertical (i.e. y axis) or horizontal. Default is false (horizontal).
 		// min: Number?
 		//		The smallest value on an axis. Default is 0.
 		// max: Number?
 		//		The largest value on an axis. Default is 1.
-		this.vertical = vertical;
-		this.min = min;
-		this.max = max;
 	};
 	=====*/
 

charting/Series.js

@@ -1,12 +1,11 @@
 define(["dojo/_base/lang", "dojo/_base/declare", "./Element"], 
 	function(lang, declare, Element){ 
 	/*=====
-	var __SeriesCtorArgs = function(plot){
+	var __SeriesCtorArgs = {
 		// summary:
 		//		An optional arguments object that can be used in the Series constructor.
 		// plot: String?
 		//		The plot (by name) that this series belongs to.
-		this.plot = plot;
 	};
 	=====*/
 	return declare("dojox.charting.Series", Element, {

charting/Theme.js

@@ -10,7 +10,7 @@ define(["dojo/_base/lang", "dojo/_base/declare", "dojo/_base/Color", "./SimpleTh
 	});
 
 	/*=====
-	var __DefineColorArgs = function(num, colors, hue, saturation, low, high, base, generator){
+	var __DefineColorArgs = {
 		// summary:
 		//		The arguments object that can be passed to define colors for a theme.
 		// num: Number?
@@ -28,15 +28,7 @@ define(["dojo/_base/lang", "dojo/_base/declare", "dojo/_base/Color", "./SimpleTh
 		// base: String|dojo/_base/Color?
 		//		A base color to use if we are defining colors using dojox.color.Palette
 		// generator: String?
-		//		The generator function name from dojox.color.Palette.
-		this.num = num;
-		this.colors = colors;
-		this.hue = hue;
-		this.saturation = saturation;
-		this.low = low;
-		this.high = high;
-		this.base = base;
-		this.generator = generator;
+		//		The generator function name from dojox/color/Palette.
 	};
 	=====*/
 	lang.mixin(Theme, {

charting/axis2d/Base.js

@@ -1,19 +1,15 @@
 define(["dojo/_base/declare", "../Element"],
 	function(declare, Element){
 	/*=====
-	var __BaseAxisCtorArgs = function(vertical, min, max, from, to){
+	var __BaseAxisCtorArgs = {
 		// summary:
 		//		Optional arguments used in the definition of an invisible axis.
-		//
 		// vertical: Boolean?
 		//		A flag that says whether an axis is vertical (i.e. y axis) or horizontal. Default is false (horizontal).
 		// min: Number?
 		//		The smallest value on an axis. Default is 0.
 		// max: Number?
 		//		The largest value on an axis. Default is 1.
-		this.vertical = vertical;
-		this.min = min;
-		this.max = max;
 	};
 	=====*/
 	return declare("dojox.charting.axis2d.Base", Element, {

charting/axis2d/Default.js

@@ -5,17 +5,9 @@ define(["dojo/_base/lang", "dojo/_base/array", "dojo/_base/sniff", "dojo/_base/d
 			lin, acommon, g, du, df){
 
 	/*=====
-	var __AxisCtorArgs = function(
-			vertical, fixUpper, fixLower, natural, leftBottom,
-			includeZero, fixed, majorLabels, minorTicks, minorLabels, microTicks, htmlLabels,
-			min, max, from, to, majorTickStep, minorTickStep, microTickStep,
-			labels, labelFunc, maxLabelSize,
-			stroke, majorTick, minorTick, microTick, tick,
-			font, fontColor, titleGap, titleFont, titleFontColor, titleOrientation, enableCache, dropLabels, labelSizeChange){
-	
+	var __AxisCtorArgs = {
 		// summary:
 		//		Optional arguments used in the definition of an axis.
-		//
 		// vertical: Boolean?
 		//		A flag that says whether an axis is vertical (i.e. y axis) or horizontal. Default is false (horizontal).
 		// fixUpper: String?
@@ -101,39 +93,6 @@ define(["dojo/_base/lang", "dojo/_base/array", "dojo/_base/sniff", "dojo/_base/d
 		// labelSizeChange: Boolean?
 		//		Indicates to the axis whether the axis labels are changing their size on zoom. If false this allows to
 		//		optimize the axis by avoiding recomputing labels maximum size on zoom actions. Default is false.
-	
-		this.vertical = vertical;
-		this.fixUpper = fixUpper;
-		this.fixLower = fixLower;
-		this.natural = natural;
-		this.leftBottom = leftBottom;
-		this.includeZero = includeZero;
-		this.fixed = fixed;
-		this.majorLabels = majorLabels;
-		this.minorTicks = minorTicks;
-		this.minorLabels = minorLabels;
-		this.microTicks = microTicks;
-		this.htmlLabels = htmlLabels;
-		this.min = min;
-		this.max = max;
-		this.from = from;
-		this.to = to;
-		this.majorTickStep = majorTickStep;
-		this.minorTickStep = minorTickStep;
-		this.microTickStep = microTickStep;
-		this.labels = labels;
-		this.labelFunc = labelFunc;
-		this.maxLabelSize = maxLabelSize;
-		this.stroke = stroke;
-		this.majorTick = majorTick;
-		this.minorTick = minorTick;
-		this.microTick = microTick;
-		this.tick = tick;
-		this.font = font;
-		this.fontColor = fontColor;
-		this.enableCache = enableCache;
-		this.dropLabels = dropLabels;
-		this.labelSizeChange = labelSizeChange;
 	};
 	=====*/
 
@@ -142,37 +101,37 @@ define(["dojo/_base/lang", "dojo/_base/array", "dojo/_base/sniff", "dojo/_base/d
 	return declare("dojox.charting.axis2d.Default", Invisible, {
 		// summary:
 		//		The default axis object used in dojox.charting.  See dojox.charting.Chart.addAxis for details.
-		//
+
 		// defaultParams: Object
 		//		The default parameters used to define any axis.
 		// optionalParams: Object
 		//		Any optional parameters needed to define an axis.
 
-		/*
-		 // TODO: the documentation tools need these to be pre-defined in order to pick them up
-		 //	correctly, but the code here is partially predicated on whether or not the properties
-		 //	actually exist.  For now, we will leave these undocumented but in the code for later. -- TRT
+		/*=====
+		// TODO: the documentation tools need these to be pre-defined in order to pick them up
+		//	correctly, but the code here is partially predicated on whether or not the properties
+		//	actually exist.  For now, we will leave these undocumented but in the code for later. -- TRT
 
-		 // opt: Object
-		 //		The actual options used to define this axis, created at initialization.
-		 // scaler: Object
-		 //		The calculated helper object to tell charts how to draw an axis and any data.
-		 // ticks: Object
-		 //		The calculated tick object that helps a chart draw the scaling on an axis.
-		 // dirty: Boolean
-		 //		The state of the axis (whether it needs to be redrawn or not)
-		 // scale: Number
-		 //		The current scale of the axis.
-		 // offset: Number
-		 //		The current offset of the axis.
+		// opt: Object
+		//		The actual options used to define this axis, created at initialization.
+		// scaler: Object
+		//		The calculated helper object to tell charts how to draw an axis and any data.
+		// ticks: Object
+		//		The calculated tick object that helps a chart draw the scaling on an axis.
+		// dirty: Boolean
+		//		The state of the axis (whether it needs to be redrawn or not)
+		// scale: Number
+		//		The current scale of the axis.
+		// offset: Number
+		//		The current offset of the axis.
 
-		 opt: null,
-		 scaler: null,
-		 ticks: null,
-		 dirty: true,
-		 scale: 1,
-		 offset: 0,
-		 */
+		opt: null,
+		scaler: null,
+		ticks: null,
+		dirty: true,
+		scale: 1,
+		offset: 0,
+		=====*/
 		defaultParams: {
 			vertical:	false,		// true for vertical axis
 			fixUpper:	"none",	// align the upper on ticks: "major", "minor", "micro", "none"

charting/axis2d/Invisible.js

@@ -3,14 +3,9 @@ define(["dojo/_base/lang", "dojo/_base/declare", "./Base", "../scaler/linear",
 	function(lang, declare, Base, lin, g, du){
 
 /*=====
-	var __InvisibleAxisCtorArgs = function(
-			vertical, fixUpper, fixLower, natural, leftBottom,
-			includeZero, fixed, majorLabels, minorTicks, minorLabels, microTicks,
-			min, max, from, to, majorTickStep, minorTickStep, microTickStep){
-
+	var __InvisibleAxisCtorArgs = {
 		// summary:
 		//		Optional arguments used in the definition of an invisible axis.
-		//
 		// vertical: Boolean?
 		//		A flag that says whether an axis is vertical (i.e. y axis) or horizontal. Default is false (horizontal).
 		// fixUpper: String?
@@ -41,21 +36,6 @@ define(["dojo/_base/lang", "dojo/_base/declare", "./Base", "../scaler/linear",
 		//		the data range.
 		// microTickStep: Number?
 		//		The amount to skip before a micro tick is drawn. When not set the micro ticks step is computed from
-
-		this.vertical = vertical;
-		this.fixUpper = fixUpper;
-		this.fixLower = fixLower;
-		this.natural = natural;
-		this.leftBottom = leftBottom;
-		this.includeZero = includeZero;
-		this.fixed = fixed;
-		this.min = min;
-		this.max = max;
-		this.from = from;
-		this.to = to;
-		this.majorTickStep = majorTickStep;
-		this.minorTickStep = minorTickStep;
-		this.microTickStep = microTickStep;
 	};
 =====*/
 

charting/plot2d/Base.js

@@ -3,7 +3,7 @@ define(["dojo/_base/declare",
 	    "./common"],
 	function(declare, Element, arr,  common){
 /*=====
-dojox.charting.plot2d.__PlotCtorArgs = function(){
+dojox.charting.plot2d.__PlotCtorArgs = {
 	// summary:
 	//		The base keyword arguments object for plot constructors.
 	//		Note that the parameters for this may change based on the

color/Palette.js

@@ -144,14 +144,13 @@ define(["dojo/_base/lang", "dojo/_base/array", "./_base"],
 	}
 
 /*=====
-var __transformArgs = function(use, dr, dg, db, da, dc, dm, dy, dk, dh, ds, dv, dl){
+var __transformArgs = {
 	// summary:
 	//		The keywords argument to be passed to the dojox.color.Palette.transform function.  Note that
 	//		while all arguments are optional, *some* arguments must be passed.  The basic concept is that
 	//		you pass a delta value for a specific aspect of a color model (or multiple aspects of the same
 	//		color model); for instance, if you wish to transform a palette based on the HSV color model,
 	//		you would pass one of "dh", "ds", or "dv" as a value.
-	//
 	// use: String?
 	//		Specify the color model to use for the transformation.  Can be "rgb", "rgba", "hsv", "hsl", "cmy", "cmyk".
 	// dr: Number?
@@ -178,56 +177,34 @@ var __transformArgs = function(use, dr, dg, db, da, dc, dm, dy, dk, dh, ds, dv,
 	//		The delta to be applied to the luminosity aspect of the HSL color model.
 	// dv: Number?
 	//		The delta to be applied to the value aspect of the HSV color model.
-	this.use = use;
-	this.dr = dr;
-	this.dg = dg;
-	this.db = db;
-	this.da = da;
-	this.dc = dc;
-	this.dm = dm;
-	this.dy = dy;
-	this.dk = dk;
-	this.dh = dh;
-	this.ds = ds;
-	this.dl = dl;
-	this.dv = dv;
-}
-var __generatorArgs = function(base){
+};
+var __generatorArgs = {
 	// summary:
 	//		The keyword arguments object used to create a palette based on a base color.
-	//
 	// base: dojo/_base/Color
 	//		The base color to be used to generate the palette.
-	this.base = base;
-}
-var __analogousArgs = function(base, high, low){
+};
+var __analogousArgs = {
 	// summary:
 	//		The keyword arguments object that is used to create a 5 color palette based on the
 	//		analogous rules as implemented at http://kuler.adobe.com, using the HSV color model.
-	//
 	// base: dojo/_base/Color
 	//		The base color to be used to generate the palette.
 	// high: Number?
 	//		The difference between the hue of the base color and the highest hue.  In degrees, default is 60.
 	// low: Number?
 	//		The difference between the hue of the base color and the lowest hue.  In degrees, default is 18.
-	this.base = base;
-	this.high = high;
-	this.low = low;
-}
-var __splitComplementaryArgs = function(base, da){
+};
+var __splitComplementaryArgs = {
 	// summary:
 	//		The keyword arguments object used to create a palette based on the split complementary rules
 	//		as implemented at http://kuler.adobe.com.
-	//
 	// base: dojo/_base/Color
 	//		The base color to be used to generate the palette.
 	// da: Number?
 	//		The delta angle to be used to determine where the split for the complementary rules happen.
 	//		In degrees, the default is 30.
-	this.base = base;
-	this.da = da;
-}
+};
 =====*/
 
 	//	object methods ---------------------------------------------------------------

date/relative.js

@@ -3,16 +3,13 @@ define(["..", "dojo/_base/lang", "dojo/date/locale", "dojo/i18n"], function(dojo
 var drelative = lang.getObject("date.relative", true, dojox);
 
 /*=====
-var __FormatOptions = function(){
+var __FormatOptions = {
 	// locale: String
 	//		override the locale used to determine formatting rules
 	// relativeDate: Date
 	//		Date to calculate relation to (defaults to new Date())
 	// weekCheck: boolean
 	//		Whether or not to display the day of week (defaults true)
-	this.locale = locale;
-	this.relativeDate = relativeDate;
-	this.weekCheck = weekCheck;
 };
 =====*/