Skip to content

Commit a2738fc

Browse files
committed
Tweaking union types (mainly removing spaces) so the doc parser understands them, refs #13101 !strict
1 parent fe7a257 commit a2738fc

30 files changed

+65
-61
lines changed

charting/DataSeries.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ define(["dojo/_base/lang", "dojo/_base/declare", "dojo/_base/array", "dojo/_base
99
// A dojo.data store object.
1010
// kwArgs: Object
1111
// A store-specific keyword parameters used for fetching items.
12-
// See dojo.data.api.Read.fetch().
12+
// See dojo/data/api/Read.fetch().
1313
// value: Function|Object|String
1414
// Function, which takes a store, and an object handle, and
1515
// produces an output possibly inspecting the store's item. Or
@@ -108,7 +108,7 @@ define(["dojo/_base/lang", "dojo/_base/declare", "dojo/_base/array", "dojo/_base
108108
onFetchError: function(errorData, request){
109109
// summary:
110110
// As stub to process fetch errors. Provide so user can attach to
111-
// it with dojo.connect(). See dojo.data.api.Read fetch() for
111+
// it with dojo.connect(). See dojo/data/api/Read fetch() for
112112
// details: onError property.
113113
this._inFlight = false;
114114
},

drawing/plugins/_Plugin.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ return oo.declare(
3030
connect: function(){
3131
this._cons.push(dojo.connect.apply(dojo, arguments));
3232
},
33-
disconnect: function(/*handle | Array*/handles){
33+
disconnect: function(/*Handle|Array*/ handles){
3434
// summary:
3535
// Removes connections based on passed
3636
// handles arguments

drawing/plugins/tools/Pan.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ var Pan = oo.declare(
7979
},evt), this.interval);
8080
},
8181

82-
onSetPan: function(/*Boolean | Event*/ bool){
82+
onSetPan: function(/*Boolean|Event*/ bool){
8383
if(bool === true || bool === false){
8484
this.selected = !bool;
8585
}

drawing/stencil/_Base.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -478,7 +478,7 @@ var Base = oo.declare(
478478
}), ms);
479479
},
480480

481-
attr: function(/*String | Object*/key, /* ? String | Number */value){
481+
attr: function(/*String|Object*/ key, /*String|Number?*/value){
482482
// summary:
483483
// Changes properties in the style or disabled styles,
484484
// depending on whether the object is enabled.
@@ -1133,7 +1133,7 @@ var Base = oo.declare(
11331133
return c;
11341134
},
11351135

1136-
disconnect: function(/*handle | Array*/handles){
1136+
disconnect: function(/*Handle|Array*/handles){
11371137
// summary:
11381138
// Removes connections based on passed
11391139
// handles arguments

drawing/ui/Toolbar.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -94,16 +94,16 @@ return dojo.declare("dojox.drawing.ui.Toolbar", [], {
9494
// The distance between the tool buttons and plug buttons
9595
toolPlugGap:20,
9696

97-
// strSelected | selected: String
97+
// strSelected: String
9898
// The button that should be selected at startup.
9999
strSelected:"",
100100

101-
// strTools | tools: String
101+
// strTools: String
102102
// A comma delineated list of the Stencil-tools to include in the Toolbar.
103103
// If "all" is used, all registered tools are included.
104104
strTools:"",
105105

106-
// strPlugs | plugs: String
106+
// strPlugs: String
107107
// A comma delineated list of the plugins to include in the Toolbar.
108108
// If "all" is used, all registered plugins are included.
109109
strPlugs:"",
@@ -267,7 +267,7 @@ return dojo.declare("dojox.drawing.ui.Toolbar", [], {
267267
// Plugin click event. May be connected to.
268268
},
269269

270-
_mixprops: function(/*Array*/props, /*Object | Node*/objNode){
270+
_mixprops: function(/*Array*/ props, /*Object|Node*/ objNode){
271271
// summary:
272272
// Internally used for mixing in props from an object or
273273
// from a dom node.

drawing/ui/dom/Pan.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ var Pan = oo.declare(
5959
}
6060
},
6161

62-
onSetPan: function(/*Boolean | Event*/ bool){
62+
onSetPan: function(/*Boolean|Event*/ bool){
6363
if(bool === true || bool === false){
6464
this.selected = !bool;
6565
}

geo/openlayers/Geometry.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ define([
1414
// an array of {x, y} objects
1515
// - A collection geometry of type dojox.geo.openlayers.Collection. Coordinates are an array of geometries.
1616

17-
// coordinates: {x, y} | Array
18-
// The coordinates of the geometry.
17+
// coordinates: Object|Array
18+
// The coordinates of the geometry, Object like {x, y} or Array.
1919
coordinates : null,
2020

2121
// shape: [private] dojox/gfx/shape.Shape

geo/openlayers/_base.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ define(["dojo/_base/lang"], function(lang){
5353
// toDecimal: Boolean
5454
// Specifies if the result should be returned in decimal degrees or in an array
5555
// containing the degrees, minutes, seconds values.
56-
// returns: Float | Array
56+
// returns: Float|Array
5757
// the parsed value in decimal degrees or an array containing the degrees, minutes, seconds values.
5858

5959
var res = re.exec(v);

gfx3d/object.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -973,7 +973,7 @@ declare("dojox.gfx3d.Viewport", gfx.Group, {
973973
return this.applyCameraRightTransform(matrix); // self
974974
},
975975

976-
setLights: function(/* Array || Object */lights, /* Color? */ ambient,
976+
setLights: function(/* Array|Object */lights, /* Color? */ ambient,
977977
/* Color? */ specular){
978978
// summary:
979979
// set the lights
@@ -998,7 +998,7 @@ declare("dojox.gfx3d.Viewport", gfx.Group, {
998998
addLights: function(lights){
999999
// summary:
10001000
// add new light/lights to the viewport.
1001-
// lights: Array || light object
1001+
// lights: Array|Object
10021002
// light object(s)
10031003
return this.setLights(this.lights.sources.concat(lights));
10041004
},

grid/LazyTreeGrid.js

+5-1
Original file line numberDiff line numberDiff line change
@@ -342,15 +342,19 @@ var LazyTreeGrid = declare("dojox.grid.LazyTreeGrid", TreeGrid, {
342342
// and dojox.grid.TreeGrid also apply here
343343
//
344344
// LazyTreeGrid does not support summary row/items aggregate due to the lazy-loading rationale.
345+
345346
_layoutClass: _LazyTreeLayout,
346347
_size: 0,
347-
// treeModel: dijit.tree.ForestStoreModel | dojox.grid.LazyTreeGridStoreModel
348+
349+
// treeModel: dijit/tree/.ForestStoreModel|dojox/grid/LazyTreeGridStoreModel
348350
// A tree store model object.
349351
treeModel: null,
352+
350353
// defaultState: Object
351354
// Used to restore the state of LazyTreeGrid.
352355
// This object should ONLY be obtained from `LazyTreeGrid.getState()`.
353356
defaultState: null,
357+
354358
// colSpans: Object
355359
// A json object that defines column span of each level rows. Attributes:
356360
//

grid/enhanced/_PluginManager.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ var _PluginManager = declare("dojox.grid.enhanced._PluginManager", null, {
215215
getPluginClazz: function(clazz){
216216
// summary:
217217
// Load target plugin which must be already required (require(..))
218-
// clazz: class | String
218+
// clazz: Class|String
219219
// Plugin class
220220
if(lang.isFunction(clazz)){
221221
return clazz;//return if it's already a clazz

grid/enhanced/plugins/CellMerge.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ var CellMerge = declare("dojox.grid.enhanced.plugins.CellMerge", _Plugin, {
6060
// The column index of the cell whose content should be used as the content of the merged cell.
6161
// It must be larger than or equal to the startColumnIndex, and less than or equal to the endColumnIndex.
6262
// If it is omitted, the content of the leading edge (left-most for ltr, right most for rtl) cell will be used.
63-
// returns: Object | null
63+
// returns: Object|null
6464
// A handler for the merged cells created by a call of this function.
6565
// This handler can be used later to unmerge cells using the function unmergeCells
6666
// If the merge is not valid, returns null;
@@ -73,7 +73,7 @@ var CellMerge = declare("dojox.grid.enhanced.plugins.CellMerge", _Plugin, {
7373
if(item){
7474
this._updateRows(item);
7575
}
76-
return item;
76+
return item; // Object|null
7777
},
7878
unmergeCells: function(mergeHandler){
7979
// summary:

grid/enhanced/plugins/Menu.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ var Menu = declare("dojox.grid.enhanced.plugins.Menu", _Plugin, {
4141
}
4242
}
4343
},
44-
_initMenu: function(/*String*/menuType, /*String | Widget(dijit.Menu)*/menu){
44+
_initMenu: function(/*String*/ menuType, /*String|dijit/Menu*/ menu){
4545
var g = this.grid;
4646
if(!g[menuType]){//in case already created in _Grid.postCreate()
4747
var m = this._getMenuWidget(menu);

grid/enhanced/plugins/Pagination.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -778,9 +778,9 @@ var Pagination = declare("dojox.grid.enhanced.plugins.Pagination", _Plugin, {
778778
currentPageSize: function(size){
779779
// summary:
780780
// Change the size of current page or return the current page size.
781-
// size: Integer || null
781+
// size: Integer|null
782782
// An integer identifying the number of rows per page. If the size
783-
// is an Infinity, all rows will be displayed; if an invalid value pssed
783+
// is an Infinity, all rows will be displayed; if an invalid value passed
784784
// in, the current page size will be returned.
785785
// returns:
786786
// Current size of items per page.

grid/enhanced/plugins/Printer.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var Printer = declare("dojox.grid.enhanced.plugins.Printer", _Plugin, {
2929
// title: String
3030
// A title of the printed page can be specified. Optional.
3131
// If given, it's shown in an <h1> tag at the top of the page.
32-
// cssFiles: Array | String
32+
// cssFiles: Array|String
3333
// CSS file paths. Optional.
3434
// Every row and column is given CSS classes, including:
3535
//
@@ -39,8 +39,8 @@ var Printer = declare("dojox.grid.enhanced.plugins.Printer", _Plugin, {
3939
// - Row classes are for <thead> and <tbody> tags.
4040
// - Column classes are for <th> and <td> tags.
4141
// - Users can use these classes in the CSS files, but cannot define their own.
42-
// writerArgs: Object (Association Array)
43-
// Arguments for TableWriter.
42+
// writerArgs: Object
43+
// Associative Array, arguments for TableWriter.
4444
// fetchArgs: object?
4545
// Any arguments for store.fetch
4646
},

grid/enhanced/plugins/Selector.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -280,10 +280,10 @@ var Selector = declare("dojox.grid.enhanced.plugins.Selector", _Plugin, {
280280
// public
281281
// type: String
282282
// "row" or "col" or "cell"
283-
// start: Integer | Object
283+
// start: Integer|Object
284284
// If type is "row" or "col", this is the index of the starting row or column.
285285
// If type if "cell", this is the left-top cell of the range.
286-
// end: Integer | Object
286+
// end: Integer|Object
287287
// If type is "row" or "col", this is the index of the ending row or column.
288288
// If type if "cell", this is the right-bottom cell of the range.
289289
this.grid._selectingRange = true;
@@ -324,8 +324,8 @@ var Selector = declare("dojox.grid.enhanced.plugins.Selector", _Plugin, {
324324
// tag:
325325
// public
326326
// toEnable: Boolean?
327-
// To enable or not. Optional.
328-
// returns: Boolean | undefined
327+
// To enable or not.
328+
// returns: Boolean|undefined
329329
// Enabled or not.
330330
if(typeof toEnable != "undefined" && !this.isSelecting()){
331331
this._enabled = !!toEnable;

grid/enhanced/plugins/_StoreLayer.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ define([
55
"dojo/_base/xhr"
66
], function(declare, array, lang, xhr){
77
// summary:
8-
// The dojo.data.api.Read API is powerful, but it's difficult to give the store some special commands before
8+
// The dojo/data/api/Read API is powerful, but it's difficult to give the store some special commands before
99
// fetch, so that the store content can be temporarily modified or transformed, and acts as another store. The
1010
// parameter *query* or *queryOptions* in keywordArgs for *fetch* is not enough because:
1111
//
@@ -340,7 +340,7 @@ define([
340340
this.onCommandLoad("", userRequest);
341341
this.originFetch(userRequest);
342342
}
343-
return userRequest; //dojo.data.api.Request
343+
return userRequest; // dojo/data/api/Request
344344
},
345345
command: function(/* string */cmdName,/* (string|number|bool|...)? */cmdContent){
346346
// summary:
@@ -368,7 +368,7 @@ define([
368368
// callback extension
369369
// response: string
370370
// server response
371-
// userRequest: [in|out] dojo.data.api.Request
371+
// userRequest: [in|out] dojo/data/api/Request
372372
// The request object for *fetch*. You can modify this object according to the *response*
373373
// so as to change the behavior of *fetch*
374374
this._onUserCommandLoad(this.__cmds, userRequest, response);

grid/enhanced/plugins/filter/FilterLayer.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ define([
220220
// Implement _StoreLayer._fetch
221221
// tags:
222222
// private callback
223-
// filterRequest: dojo.data.api.Request
223+
// filterRequest: dojo/data/api/Request
224224
// The actual request used in store.fetch.
225225
// This function is called recursively to fill the result store items
226226
// until the user specified item count is reached. Only in recursive calls,

grid/enhanced/plugins/filter/_ConditionExpr.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ var _OperatorExpr = declare("dojox.grid.enhanced.plugins.filter._OperatorExpr",
135135
// An operator expression is a _ConditionExpr that represents an operation.
136136
_name: "operator",
137137

138-
constructor: function(/* Array | operand1,operand2,... */){
138+
constructor: function(/* Array|operand1,operand2,... */){
139139
// summary:
140140
// The arguments are operands (or an array of operands, if the first argument
141141
// is an Array) of this operator, ordering from left to right.

image/Gallery.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -117,10 +117,10 @@ dojo.declare("dojox.image.Gallery",
117117
// summary:
118118
// Sets the data store and request objects to read data from.
119119
// dataStore:
120-
// An implementation of the dojo.data.api.Read API. This accesses the image
120+
// An implementation of the dojo/data/api/Read API. This accesses the image
121121
// data.
122122
// request:
123-
// An implementation of the dojo.data.api.Request API. This specifies the
123+
// An implementation of the dojo/data/api/Request API. This specifies the
124124
// query and paging information to be used by the data store
125125
// paramNames:
126126
// An object defining the names of the item attributes to fetch from the

image/SlideShow.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ dojo.declare("dojox.image.SlideShow",
7373
fixedHeight: false,
7474

7575
// imageStore: Object
76-
// Implementation of the dojo.data.api.Read API, which provides data on the images
76+
// Implementation of the dojo/data/api/Read API, which provides data on the images
7777
// to be displayed.
7878
imageStore: null,
7979

@@ -107,7 +107,7 @@ dojo.declare("dojox.image.SlideShow",
107107
_tmpImage: null,
108108

109109
// _request: Object
110-
// Implementation of the dojo.data.api.Request API, which defines the query
110+
// Implementation of the dojo/data/api/Request API, which defines the query
111111
// parameters for accessing the store.
112112
_request: null,
113113

@@ -150,10 +150,10 @@ dojo.declare("dojox.image.SlideShow",
150150
// summary:
151151
// Sets the data store and request objects to read data from.
152152
// dataStore:
153-
// An implementation of the dojo.data.api.Read API. This accesses the image
153+
// An implementation of the dojo/data/api/Read API. This accesses the image
154154
// data.
155155
// request:
156-
// An implementation of the dojo.data.api.Request API. This specifies the
156+
// An implementation of the dojo/data/api/Request API. This specifies the
157157
// query and paging information to be used by the data store
158158
// paramNames:
159159
// An object defining the names of the item attributes to fetch from the

image/ThumbnailPicker.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -215,10 +215,10 @@ dojo.declare("dojox.image.ThumbnailPicker",
215215
// summary:
216216
// Sets the data store and request objects to read data from.
217217
// dataStore:
218-
// An implementation of the dojo.data.api.Read API. This accesses the image
218+
// An implementation of the dojo/data/api/Read API. This accesses the image
219219
// data.
220220
// request:
221-
// An implementation of the dojo.data.api.Request API. This specifies the
221+
// An implementation of the dojo/data/api/Request API. This specifies the
222222
// query and paging information to be used by the data store
223223
// paramNames:
224224
// An object defining the names of the item attributes to fetch from the

math/stats.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ define(["dojo", "../main"], function(dojo, dojox) {
2222
return (squares/a.length)-Math.pow(mean/a.length, 2); // Number
2323
},
2424

25-
bestFit: function(/* Object[] || Number[] */a, /* String? */xProp, /* String? */yProp){
25+
bestFit: function(/* Object[]|Number[] */ a, /* String? */ xProp, /* String? */ yProp){
2626
// summary:
2727
// Calculate the slope and intercept in a linear fashion. An array
2828
// of objects is expected; optionally you can pass in the property
@@ -75,7 +75,7 @@ define(["dojo", "../main"], function(dojo, dojox) {
7575
};
7676
},
7777

78-
forecast: function(/* Object[] || Number[] */a, /* Number */x, /* String? */xProp, /* String? */yProp){
78+
forecast: function(/* Object[]|Number[] */a, /* Number */x, /* String? */xProp, /* String? */yProp){
7979
// summary:
8080
// Using the bestFit algorithm above, find y for the given x.
8181
var fit = st.bestFit(a, xProp, yProp);

timing/ThreadPool.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ define(["./_base"], function(){
7373
this.getMaxThreads=function(){ return maxThreads; };
7474
this.getAvailableThreads=function(){ return availableThreads; };
7575
this.getTickInterval=function(){ return interval; };
76-
this.queueUserWorkItem=function(/* Function || dojox.timing.Thread */fn){
76+
this.queueUserWorkItem=function(/* Function|dojox/timing/Thread */fn){
7777
var item=fn;
7878
if(item instanceof Function){
7979
item=new t.Thread(item);
@@ -92,7 +92,7 @@ define(["./_base"], function(){
9292
}
9393
return true;
9494
};
95-
this.removeQueuedUserWorkItem=function(/* Function || dojox.timing.Thread */item){
95+
this.removeQueuedUserWorkItem=function(/* Function|dojox/timing/Thread */item){
9696
if(item instanceof Function){
9797
var idx=-1;
9898
for(var i=0; i<queue.length; i++){

validate/creditCard.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ validate.isValidCreditCardNumber = function(value, ccType){
8484
results.push(p);
8585
}
8686
}
87-
return results.length ? results.join('|') : false; // String | boolean
87+
return results.length ? results.join('|') : false; // String|Boolean
8888
};
8989

9090
validate.isValidCvv = function(/* String|Int */value, /* String */ccType) {

0 commit comments

Comments
 (0)