Skip to content

Commit

Permalink
Fix indentation errors: our API doc shouldn't have any indentation (b…
Browse files Browse the repository at this point in the history 
…eyond the initial two tabs) except for code blocks or nested lists. Refs #13101 !strict
  • Loading branch information
@wkeese
wkeese committed Jul 3, 2012
1 parent 3ff01c6 commit ddb9978
Show file tree
Hide file tree
Showing 50 changed files with 479 additions and 436 deletions.
38 changes: 19 additions & 19 deletions av/FLAudio.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,18 +148,18 @@ return dojo.declare("dojox.av.FLAudio", null, {
// Adds a media object to the playlist
// ***This can be called repeatedly to add multiple items.
// options: Object
// url: String
// - url: String:
// (required) path to MP3 media
// url must be absolute or relative to SWF,
// not dojo or the html. An effort will be made
// to fix incorrect paths.
// id: String
// - id: String:
// (optional) an identifier to later determine
// which media to control.
// returns:
// The normalized url, which can be used to identify the
// audio.
//

if(dojox.timing.doLater(this.flashMedia, this)){ return false; }
if(!options.url){
throw new Error("An url is required for loading media");
Expand All @@ -181,12 +181,12 @@ return dojo.declare("dojox.av.FLAudio", null, {
// Tell media to play, based on
// the options passed.
// options: Object
// - volume: Number
// - volume: Number:
// Sets the volume
// - pan: Number
// - pan: Number:
// Sets left/right pan
// - index:Number OR id:String OR url:String
// Choose one of the above to indentify
// - index:Number OR id:String OR url:String:
// Choose one of the above to identify
// the media you wish to control. id is
// set by you. index is the order in which
// media was added (zero based)
Expand All @@ -203,8 +203,8 @@ return dojo.declare("dojox.av.FLAudio", null, {
// Tell media to pause, based on identifier in
// the options passed.
// options: Object
// index:Number OR id:String OR url:String
// See doPlay()
// index:Number OR id:String OR url:String.
// See doPlay().

this.flashMedia.pause(options);
},
Expand All @@ -214,8 +214,8 @@ return dojo.declare("dojox.av.FLAudio", null, {
// Tell media to stop, based on identifier in
// the options passed.
// options:
// index:Number OR id:String OR url:String
// See doPlay()
// index:Number OR id:String OR url:String.
// See doPlay().

this.flashMedia.doStop(options);
},
Expand All @@ -227,8 +227,8 @@ return dojo.declare("dojox.av.FLAudio", null, {
// options:
// volume: Number
// 0 to 1
// index:Number OR id:String OR url:String
// See doPlay()
// index:Number OR id:String OR url:String.
// See doPlay().

this.flashMedia.setVolume(options);
},
Expand All @@ -249,8 +249,8 @@ return dojo.declare("dojox.av.FLAudio", null, {
// Get media volume, based on identifier in
// the options passed.
// options:
// index:Number OR id:String OR url:String
// See doPlay()
// index:Number OR id:String OR url:String.
// See doPlay().

return this.flashMedia.getVolume(options);
},
Expand All @@ -260,8 +260,8 @@ return dojo.declare("dojox.av.FLAudio", null, {
// Set media pan, based on identifier in
// the options passed.
// options:
// index:Number OR id:String OR url:String
// See doPlay()
// index:Number OR id:String OR url:String.
// See doPlay().

return this.flashMedia.getPan(options);
},
Expand All @@ -270,8 +270,8 @@ return dojo.declare("dojox.av.FLAudio", null, {
// summary:
// Get the current time.
// options:
// index:Number OR id:String OR url:String
// See doPlay()
// index:Number OR id:String OR url:String.
// See doPlay().

return this.flashMedia.getPosition(options);
},
Expand Down
12 changes: 7 additions & 5 deletions av/FLVideo.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -176,11 +176,13 @@ dojo.declare("dojox.av.FLVideo", [_Widget, _Media], {
onMetaData: function(data, evt){
// summary:
// The video properties. Width, height, duration, etc.
// NOTE: if data is empty, this is an older FLV with no meta data.
// Duration cannot be determined. In original FLVs, duration
// could only be obtained with Flash Media Server.
// NOTE: Older FLVs can still return width and height
// and will do so on a second event call
//
// NOTE: if data is empty, this is an older FLV with no meta data.
// Duration cannot be determined. In original FLVs, duration
// could only be obtained with Flash Media Server.
//
// NOTE: Older FLVs can still return width and height
// and will do so on a second event call
},
onPosition: function( time){
Expand Down
22 changes: 13 additions & 9 deletions charting/BidiSupport.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,15 +160,19 @@ define(["../main", "dojo/_base/lang", "dojo/dom-style", "dojo/_base/array", "doj
// Enables bidi support for truncated labels.
// description:
// Can be two types of labels: html or gfx.
// gfx labels:
// Need to be stored in registry to be used when the textDir will be set dynamically.
// Additional work on truncated labels is needed for case as 111111A (A stands for "bidi" character rtl directioned).
// let say in this case the truncation is "111..." If the textDir is auto, the display should be: "...111" but in gfx
// case we will get "111...". Because this.surface.setTextDir will calculate the dir of truncated
// label, which value is "111..." but th real is "111111A".
// each time we created a gfx truncated label we store it in the truncatedLabelsRegistry.
// html labels:
// no need for repository (stored in another place). Here we only need to update the current dir according to textDir.
//
// ####gfx labels:
//
// Need to be stored in registry to be used when the textDir will be set dynamically.
// Additional work on truncated labels is needed for case as 111111A (A stands for "bidi" character rtl directioned).
// let's say in this case the truncation is "111..." If the textDir is auto, the display should be: "...111" but in gfx
// case we will get "111...". Because this.surface.setTextDir will calculate the dir of truncated
// label, which value is "111..." but th real is "111111A".
// each time we created a gfx truncated label we store it in the truncatedLabelsRegistry.
//
// ####html labels:
//
// no need for repository (stored in another place). Here we only need to update the current dir according to textDir.
// tags:
// private

Expand Down
20 changes: 7 additions & 13 deletions charting/DataChart.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -144,20 +144,14 @@ define(["dojo/_base/kernel", "dojo/_base/lang", "dojo/_base/declare", "dojo/_bas
// summary:
// Set up properties and initialize chart build.
// node: DomNode
// The node to attach the chart to.
// The node to attach the chart to.
// kwArgs: Object
// xaxis: Object
// optional parameters for xaxis (see above)
// yaxis: Object
// optional parameters for yaxis (see above)
// store: Object
// dojo.data store (currently nly supports Persevere)
// xaxis: Object
// First query for store
// grid: Object
// Options for the grid plot
// chartPlot: Object
// Options for chart elements (lines, bars, etc)
// - xaxis: Object: optional parameters for xaxis (see above)
// - yaxis: Object: optional parameters for yaxis (see above)
// - store: Object: dojo.data store (currently nly supports Persevere)
// - xaxis: Object: First query for store
// - grid: Object: Options for the grid plot
// - chartPlot: Object: Options for chart elements (lines, bars, etc)

this.domNode = dom.byId(node);

Expand Down
4 changes: 2 additions & 2 deletions charting/SimpleTheme.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ define(["dojo/_base/lang", "dojo/_base/array","dojo/_base/declare","dojo/_base/C
// theme object from a Chart, and not in the theme itself (i.e. either do that before using .setTheme
// on a chart).
//
// example:
// The default theme (and structure) looks like so:
// example:
// The default theme (and structure) looks like so:
// | // all objects are structs used directly in dojox.gfx
// | chart:{
// | stroke: null,
Expand Down
10 changes: 5 additions & 5 deletions charting/plot2d/CartesianBase.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ define(["dojo/_base/lang", "dojo/_base/declare", "dojo/_base/connect",
// Compute page coordinates from plot axis data coordinates.
// coord: Object?
// The coordinates in plot axis data coordinate space. For cartesian charts that is of the following form:
// `{ hAxisName: 50, vAxisName: 200 }`
// If not provided return the tranform method instead of the result of the transformation.
// `{ hAxisName: 50, vAxisName: 200 }`
// If not provided return the transform method instead of the result of the transformation.
// returns: Object
// The resulting page pixel coordinates. That is of the following form:
// `{ x: 50, y: 200 }`
// `{ x: 50, y: 200 }`
var ah = this._hAxis, av = this._vAxis,
sh = ah.getScaler(), sv = av.getScaler(),
th = sh.scaler.getTransformerFromModel(sh),
Expand All @@ -74,11 +74,11 @@ define(["dojo/_base/lang", "dojo/_base/declare", "dojo/_base/connect",
// Compute plot axis data coordinates from page coordinates.
// coord: Object
// The pixel coordinate in page coordinate space. That is of the following form:
// `{ x: 50, y: 200 }`
// `{ x: 50, y: 200 }`
// If not provided return the tranform method instead of the result of the transformation.
// returns: Object
// The resulting plot axis data coordinates. For cartesian charts that is of the following form:
// `{ hAxisName: 50, vAxisName: 200 }`
// `{ hAxisName: 50, vAxisName: 200 }`
var ah = this._hAxis, av = this._vAxis,
sh = ah.getScaler(), sv = av.getScaler(),
th = sh.scaler.getTransformerFromPlot(sh),
Expand Down
2 changes: 1 addition & 1 deletion charting/widget/Chart.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ define(["dojo/_base/kernel", "dojo/_base/lang", "dojo/_base/array","dojo/dom-att
// Resize the widget.
// description:
// Resize the domNode and the widget surface to the dimensions of a box of the following form:
// `{ l: 50, t: 200, w: 300: h: 150 }`
// `{ l: 50, t: 200, w: 300: h: 150 }`
// If no box is provided, resize the surface to the marginBox of the domNode.
// box:
// If passed, denotes the new size of the widget.
Expand Down
14 changes: 7 additions & 7 deletions data/AndOrReadStore.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ return declare("dojox.data.AndOrReadStore", [ItemFileReadStore], {
// AndOrReadStore uses ItemFileReadStore as a base, modifying only the query (_fetchItems) section.
// Supports queries of the form: query:"id:1* OR dept:'Sales Department' || (id:2* && NOT dept:S*)"
// Includes legacy/widget support via:
// query:{complexQuery:"id:1* OR dept:'Sales Department' || (id:2* && NOT dept:S*)"}
// | query:{complexQuery:"id:1* OR dept:'Sales Department' || (id:2* && NOT dept:S*)"}
// The ItemFileReadStore implements the dojo.data.api.Read API and reads
// data from JSON files that have contents in this format --
// { items: [
// { name:'Kermit', color:'green', age:12, friends:['Gonzo', {_reference:{name:'Fozzie Bear'}}]},
// { name:'Fozzie Bear', wears:['hat', 'tie']},
// { name:'Miss Piggy', pets:'Foo-Foo'}
// ]}
// Note that it can also contain an 'identifer' property that specified which attribute on the items
// | { items: [
// | { name:'Kermit', color:'green', age:12, friends:['Gonzo', {_reference:{name:'Fozzie Bear'}}]},
// | { name:'Fozzie Bear', wears:['hat', 'tie']},
// | { name:'Miss Piggy', pets:'Foo-Foo'}
// | ]}
// Note that it can also contain an 'identifier' property that specified which attribute on the items
// in the array of items that acts as the unique identifier for that item.

_containsValue: function( /* item */ item, /* attribute-name-string */ attribute, /* anything */ value, /* String? | RegExp? */ regexp){
Expand Down
10 changes: 5 additions & 5 deletions data/AppStore.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -744,11 +744,11 @@ dojo.declare("dojox.data.AppStore",
// summary:
// See dojo.data.api.Write.save()
// keywordArgs:
// {
// onComplete: function
// onError: function
// scope: object
// }
// | {
// | onComplete: function
// | onError: function
// | scope: object
// | }
var i;
for(i in this._adds){
this._atomIO.addEntry(this._adds[i], null, function(){}, keywordArgs.onError, false, keywordArgs.scope);
Expand Down
56 changes: 32 additions & 24 deletions data/CdfStore.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,48 +191,56 @@ dojo.declare("dojox.data.CdfStore", null, {
// be return directly as well as within the onComplete method.
//
// note:
// The mode can be set on store initialization or during a fetch as one of the
// parameters.
// query: String
// The mode can be set on store initialization or during a fetch as one of the
// parameters.
//
// See:
//
// - http://www.tibco.com/devnet/resources/gi/3_7/api/html/jsx3/xml/Entity.html#method:selectNodes
// - http://www.w3.org/TR/xpath
// - http://msdn.microsoft.com/en-us/library/ms256086.aspx
//
// See dojo.data.Read.fetch():
//
// - onBegin
// - onComplete
// - onItem
// - onError
// - scope
// - start
// - count
// - sort
// request: String
// The items in the store are treated as objects, but this is reading an XML
// document. Further, the actual querying of the items takes place in Tibco GI's
// jsx3.xml.Entity. Therefore, we are using their syntax which is xpath.
//
// Note:
// As conforming to a CDF document, most, if not all nodes are considered "records"
// and their tagNames are as such. The root node is named "data".
// examples:
// As conforming to a CDF document, most, if not all nodes are considered "records"
// and their tagNames are as such. The root node is named "data".
// example:
// All items:
// | store.fetch({query:"*"});
// example:
// Item with a jsxid attribute equal to "1" (note you could use byId for this)
// | store.fetch({query:"//record[@jsxid='1']"});
// example:
// All items with any jsxid attribute:
// | "//record[@jsxid='*']"
// example:
// The items with a jsxid of '1' or '4':
// | "//record[@jsxid='4' or @jsxid='1']"
// example:
// All children within a "group" node (could be multiple group nodes):
// "//group/record"
// example:
// All children within a specific group node:
// "//group[@name='mySecondGroup']/record"
// example:
// Any record, anywhere in the document:
// | "//record"
// Only the records beneath the root (data) node:
// | "//data/record"
//
// See:
// http://www.tibco.com/devnet/resources/gi/3_7/api/html/jsx3/xml/Entity.html#method:selectNodes
// http://www.w3.org/TR/xpath
// http://msdn.microsoft.com/en-us/library/ms256086.aspx
//
// See dojo.data.Read.fetch():
// onBegin
// onComplete
// onItem
// onError
// scope
// start
// count
// sort

request = request || {};
if(!request.store){
Expand Down Expand Up @@ -484,7 +492,7 @@ dojo.declare("dojox.data.CdfStore", null, {
// Subsequent fetches will load the new data.
//
// Note:
// Any items outside the store will no longer be valid and may cause errors.
// Any items outside the store will no longer be valid and may cause errors.

delete this.cdfDoc;
this._modifiedItems = {};
Expand Down Expand Up @@ -573,8 +581,8 @@ dojo.declare("dojox.data.CdfStore", null, {
// See dojo.data.api.Identity.fetchItemByIdentity(keywordArgs)
//
// Note:
// This method can be synchronous if mode is set.
// Also, there is a more finger friendly alias of this method, byId();
// This method can be synchronous if mode is set.
// Also, there is a more finger friendly alias of this method, byId();
if(dojo.isString(args)){
var id = args;
args = {query:"//record[@jsxid='"+id+"']", mode: dojox.data.SYNC_MODE};
Expand Down
9 changes: 5 additions & 4 deletions data/ClientFilter.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,11 @@ define(["dojo/_base/declare", "dojo/_base/lang", "dojo/_base/array", "dojo/_base
// results by itself in this case. In this situations, data stores can provide a isUpdateable(request) function
// and matchesQuery(item,request) function. If a data store can handle a query, it can return true from
// isUpdateable and if an item matches a query, it can return true from matchesQuery. Here is
// definition of isUpdateable and matchesQuery
// isUpdateable(request) - request is the keywords arguments as is passed to the fetch function.
// matchesQuery(item,request) - item is the item to test, and request is the value arguments object
// for the fetch function.
// definition of isUpdateable and matchesQuery:
//
// - isUpdateable(request) - request is the keywords arguments as is passed to the fetch function.
// - matchesQuery(item,request) - item is the item to test, and request is the value arguments object
// for the fetch function.
//
// You can define a property on this object instance "cacheByDefault" to a value of true that will
// cause all queries to be cached by default unless the cache queryOption is explicitly set to false.
Expand Down
5 changes: 3 additions & 2 deletions data/CssClassStore.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ return declare("dojox.data.CssClassStore", CssRuleStore, {
// description:
// The CssClassStore allows users to get information about active Css classes in the page running the CssClassStore.
// It can also filter out classes from specific stylesheets. The attributes it exposes on classes are as follows:
// class: The classname, including the '.'.
// classSans: The classname without the '.'.
//
// - class: The classname, including the '.'.
// - classSans: The classname without the '.'.

// _labelAttribute:
// text representation of the Item [label and identifier may need to stay due to method names]
Expand Down
Loading

0 comments on commit ddb9978

Please sign in to comment.