Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

diji: fix api doc formatting, refs #13101 !strict

  • Loading branch information...
commit f26d07d6576680d402c684f8e850e8bb786b8bf2 1 parent e406722
@wkeese wkeese authored
View
24 Calendar.js
@@ -44,9 +44,9 @@ define([
setValue: function(/*Date*/ value){
// summary:
- // Deprecated. Use set('value', ...) instead.
+ // Deprecated. Use set('value', ...) instead.
// tags:
- // deprecated
+ // deprecated
kernel.deprecated("dijit.Calendar:setValue() is deprecated. Use set('value', ...) instead.", "", "2.0");
this.set('value', value);
},
@@ -77,9 +77,9 @@ define([
_onMonthSelect: function(/*Number*/ newMonth){
// summary:
- // Handler for when user selects a month from the drop down list
+ // Handler for when user selects a month from the drop down list
// tags:
- // protected
+ // protected
// move to selected month, bounding by the number of days in the month
// (ex: dec 31 --> jan 28, not jan 31)
@@ -89,9 +89,9 @@ define([
_onDayMouseOver: function(/*Event*/ evt){
// summary:
- // Handler for mouse over events on days, sets hovered style
+ // Handler for mouse over events on days, sets hovered style
// tags:
- // protected
+ // protected
// event can occur on <td> or the <span> inside the td,
// set node to the <td>.
@@ -111,9 +111,9 @@ define([
_onDayMouseOut: function(/*Event*/ evt){
// summary:
- // Handler for mouse out events on days, clears hovered style
+ // Handler for mouse out events on days, clears hovered style
// tags:
- // protected
+ // protected
if(!this._currentNode){ return; }
@@ -216,10 +216,10 @@ define([
// summary:
// Deprecated. Notification that a date cell was selected. It may be the same as the previous value.
// description:
- // Formerly used by `dijit.form._DateTimeTextBox` (and thus `dijit.form.DateTextBox`)
- // to get notification when the user has clicked a date. Now onExecute() (above) is used.
+ // Formerly used by `dijit.form._DateTimeTextBox` (and thus `dijit.form.DateTextBox`)
+ // to get notification when the user has clicked a date. Now onExecute() (above) is used.
// tags:
- // protected
+ // protected
},
onChange: function(value){
@@ -233,7 +233,7 @@ define([
// dateObject: Date
// locale: String?
// tags:
- // extension
+ // extension
/*=====
return ""; // String
View
22 CalendarLite.js
@@ -120,7 +120,7 @@ define([
// value:
// Either a Date or the number of seconds since 1970.
// tags:
- // protected
+ // protected
if(typeof value == "string"){
value = stamp.fromISOString(value);
}
@@ -162,7 +162,7 @@ define([
// This just sets the content of node to the specified text.
// Can't do "node.innerHTML=text" because of an IE bug w/tables, see #3434.
// tags:
- // private
+ // private
while(node.firstChild){
node.removeChild(node.firstChild);
}
@@ -171,10 +171,10 @@ define([
_populateGrid: function(){
// summary:
- // Fills in the calendar grid with each day (1-31).
+ // Fills in the calendar grid with each day (1-31).
// Call this on creation, when moving to a new month.
// tags:
- // private
+ // private
var month = new this.dateClassObj(this.currentFocus);
month.setDate(1);
@@ -247,7 +247,7 @@ define([
// summary:
// Fill in localized month, and prev/current/next years
// tags:
- // protected
+ // protected
var month = new this.dateClassObj(this.currentFocus);
month.setDate(1);
@@ -266,7 +266,7 @@ define([
goToToday: function(){
// summary:
- // Sets calendar's value to today's date
+ // Sets calendar's value to today's date
this.set('value', new this.dateClassObj());
},
@@ -324,7 +324,7 @@ define([
// summary:
// Set up connects for increment/decrement of months/years
// tags:
- // protected
+ // protected
var connect = lang.hitch(this, function(nodeProp, part, amount){
this.connect(this[nodeProp], "onclick", function(){
@@ -387,9 +387,9 @@ define([
_onDayClick: function(/*Event*/ evt){
// summary:
- // Handler for day clicks, selects the date if appropriate
+ // Handler for day clicks, selects the date if appropriate
// tags:
- // protected
+ // protected
event.stop(evt);
for(var node = evt.target; node && !node.dijitDateValue; node = node.parentNode);
if(node && !domClass.contains(node, "dijitCalendarDisabledDate")){
@@ -436,7 +436,7 @@ define([
// dateObject: Date
// locale: String?
// tags:
- // extension
+ // extension
/*=====
return false; // Boolean
=====*/
@@ -449,7 +449,7 @@ define([
// dateObject: Date
// locale: String?
// tags:
- // extension
+ // extension
/*=====
return ""; // String
View
2  Destroyable.js
@@ -40,7 +40,7 @@ return declare("dijit.Destroyable", null, {
// When this is destroyed, destroy handle. Since I'm using aspect.before(),
// the handle will be destroyed before a subclass's destroy() method starts running, before it calls
// this.inherited() or even if it doesn't call this.inherited() at all. If that's an issue, make an
- // onDestroy() method and connect to that instead.
+ // onDestroy() method and connect to that instead.
handle._odh = aspect.before(this, "destroy", function(preserveDom){
handle._odh.remove();
handle[destroyMethodName](preserveDom);
View
4 Editor.js
@@ -357,7 +357,7 @@ define([
execCommand: function(cmd){
// summary:
// Main handler for executing any commands to the editor, like paste, bold, etc.
- // Called by plugins, but not meant to be called by end users.
+ // Called by plugins, but not meant to be called by end users.
// tags:
// protected
if(this.customUndo && (cmd == 'undo' || cmd == 'redo')){
@@ -429,7 +429,7 @@ define([
queryCommandEnabled: function(cmd){
// summary:
// Returns true if specified editor command is enabled.
- // Used by the plugins to know when to highlight/not highlight buttons.
+ // Used by the plugins to know when to highlight/not highlight buttons.
// tags:
// protected
if(this.customUndo && (cmd == 'undo' || cmd == 'redo')){
View
2  Tooltip.js
@@ -229,7 +229,7 @@ define([
_setAutoTextDir: function(/*Object*/node){
// summary:
- // Resolve "auto" text direction for children nodes
+ // Resolve "auto" text direction for children nodes
// tags:
// private
View
8 Tree.js
@@ -573,7 +573,7 @@ var Tree = declare("dijit.Tree", [_Widget, _TemplatedMixin], {
paths: [],
// path: String[] or Item[]
- // Backward compatible singular variant of paths.
+ // Backward compatible singular variant of paths.
path: [],
// selectedItems: [readonly] Item[]
@@ -584,7 +584,7 @@ var Tree = declare("dijit.Tree", [_Widget, _TemplatedMixin], {
selectedItems: null,
// selectedItem: [readonly] Item
- // Backward compatible singular variant of selectedItems.
+ // Backward compatible singular variant of selectedItems.
selectedItem: null,
// openOnClick: Boolean
@@ -608,7 +608,7 @@ var Tree = declare("dijit.Tree", [_Widget, _TemplatedMixin], {
// dndController: [protected] Function|String
// Class to use as as the dnd controller. Specifying this class enables DnD.
// Generally you should specify this as dijit.tree.dndSource.
- // Setting of dijit.tree._dndSelector handles selection only (no actual DnD).
+ // Setting of dijit.tree._dndSelector handles selection only (no actual DnD).
dndController: _dndSelector,
// parameters to pull off of the tree and pass on to the dndController as its params
@@ -938,7 +938,7 @@ var Tree = declare("dijit.Tree", [_Widget, _TemplatedMixin], {
_setPathAttr: function(/*Item[] || String[]*/ path){
// summary:
- // Singular variant of _setPathsAttr
+ // Singular variant of _setPathsAttr
if(path.length){
return this.set("paths", [path]);
}else{
View
6 _BidiSupport.js
@@ -26,7 +26,7 @@ define(["./_WidgetBase"], function(_WidgetBase){
// If textDir is ltr or rtl returns the value.
// If it's auto, calls to another function that responsible
// for checking the value, and defining the direction.
- // tags:
+ // tags:
// protected.
return this.textDir == "auto" ? this._checkContextual(text) : this.textDir;
},
@@ -35,7 +35,7 @@ define(["./_WidgetBase"], function(_WidgetBase){
// summary:
// Finds the first strong (directional) character, return ltr if isLatin
// or rtl if isBidiChar.
- // tags:
+ // tags:
// private.
// look for strong (directional) characters
@@ -55,7 +55,7 @@ define(["./_WidgetBase"], function(_WidgetBase){
// If textDir is ltr or rtl returns the value.
// If it's auto, calls to another function that responsible
// for checking the value, and defining the direction.
- // tags:
+ // tags:
// protected.
var textDir = this.textDir == "auto" ? this._checkContextual(text) : this.textDir;
View
6 _Contained.js
@@ -16,11 +16,11 @@ define([
_getSibling: function(/*String*/ which){
// summary:
- // Returns next or previous sibling
+ // Returns next or previous sibling
// which:
- // Either "next" or "previous"
+ // Either "next" or "previous"
// tags:
- // private
+ // private
var node = this.domNode;
do{
node = node[which+"Sibling"];
View
2  _Container.js
@@ -80,7 +80,7 @@ define([
// if 1, get the next sibling
// if -1, get the previous sibling
// tags:
- // private
+ // private
var children = this.getChildren(),
idx = array.indexOf(this.getChildren(), child); // int
return children[idx + dir];
View
8 _DialogMixin.js
@@ -26,9 +26,9 @@ define([
onCancel: function(){
// summary:
- // Called when user has pressed the Dialog's cancel button, to notify container.
+ // Called when user has pressed the Dialog's cancel button, to notify container.
// description:
- // Developer shouldn't override or connect to this method;
+ // Developer shouldn't override or connect to this method;
// it's a private communication device between the TooltipDialog
// and the thing that opened it (ex: `dijit.form.DropDownButton`)
// type:
@@ -37,9 +37,9 @@ define([
onExecute: function(){
// summary:
- // Called when user has pressed the dialog's OK button, to notify container.
+ // Called when user has pressed the dialog's OK button, to notify container.
// description:
- // Developer shouldn't override or connect to this method;
+ // Developer shouldn't override or connect to this method;
// it's a private communication device between the TooltipDialog
// and the thing that opened it (ex: `dijit.form.DropDownButton`)
// type:
View
4 _PaletteMixin.js
@@ -328,9 +328,9 @@ declare("dijit.Dye",
fillCell: function(cell, blankGif){
// summary:
// Add cell DOMNode inner structure
- // cell: DomNode
+ // cell: DomNode
// The surrounding cell
- // blankGif: String
+ // blankGif: String
// URL for blank cell image
}
}
View
2  _TimePicker.js
@@ -334,7 +334,7 @@ define([
// summary:
// Notification that a time was selected. It may be the same as the previous value.
// tags:
- // public
+ // public
},
_highlightOption: function(/*node*/ node, /*Boolean*/ highlight){
View
4 _Widget.js
@@ -253,11 +253,11 @@ var _Widget = declare("dijit._Widget", [_WidgetBase, _OnDijitClickMixin, _FocusM
attr: function(/*String|Object*/name, /*Object?*/value){
// summary:
// Set or get properties on a widget instance.
- // name:
+ // name:
// The property to get or set. If an object is passed here and not
// a string, its keys are used as names of attributes to be set
// and the value of the object as values to set in the widget.
- // value:
+ // value:
// Optional. If provided, attr() operates as a setter. If omitted,
// the current value of the named property is returned.
// description:
View
8 _WidgetBase.js
@@ -684,7 +684,7 @@ return declare("dijit._WidgetBase", [Stateful, Destroyable], {
get: function(name){
// summary:
// Get a property from a widget.
- // name:
+ // name:
// The property to get.
// description:
// Get a named property from a widget. The property may
@@ -704,9 +704,9 @@ return declare("dijit._WidgetBase", [Stateful, Destroyable], {
set: function(name, value){
// summary:
// Set a property on a widget
- // name:
+ // name:
// The property to set.
- // value:
+ // value:
// The value to set in the property.
// description:
// Sets named properties on a widget which may potentially be handled by a
@@ -1042,7 +1042,7 @@ return declare("dijit._WidgetBase", [Stateful, Destroyable], {
// The function overridden in the _BidiSupport module,
// its main purpose is to calculate the direction of the
// text, if was defined by the programmer through textDir.
- // tags:
+ // tags:
// protected.
return originalDir;
},
View
10 _editor/RichText.js
@@ -916,7 +916,7 @@ var RichText = declare("dijit._editor.RichText", [_Widget, _CssStateMixin], {
// summary:
// Handler for onkeyup event
// tags:
- // callback
+ // callback
},
setDisabled: function(/*Boolean*/ disabled){
@@ -929,7 +929,7 @@ var RichText = declare("dijit._editor.RichText", [_Widget, _CssStateMixin], {
},
_setValueAttr: function(/*String*/ value){
// summary:
- // Registers that attr("value", foo) should call setValue(foo)
+ // Registers that attr("value", foo) should call setValue(foo)
this.setValue(value);
},
_setDisableSpellCheckAttr: function(/*Boolean*/ disabled){
@@ -1443,7 +1443,7 @@ var RichText = declare("dijit._editor.RichText", [_Widget, _CssStateMixin], {
// summary:
// Return the current content of the editing area (post filters
// are applied). Users should call get('value') instead.
- // nonDestructive:
+ // nonDestructive:
// defaults to false. Should the post-filtering be run over a copy
// of the live DOM? Most users should pass "true" here unless they
// *really* know that none of the installed filters are going to
@@ -1592,11 +1592,11 @@ var RichText = declare("dijit._editor.RichText", [_Widget, _CssStateMixin], {
// the DOM which is passed is run through each of the
// contentPostFilters functions.
//
- // dom:
+ // dom:
// a node, set of nodes, which to filter using each of the current
// members of the contentDomPostFilters and contentPostFilters arrays.
//
- // nonDestructive:
+ // nonDestructive:
// defaults to "false". If true, ensures that filtering happens on
// a clone of the passed-in content and not the actual node
// itself.
View
10 _editor/_Plugin.js
@@ -195,9 +195,9 @@ var _Plugin = declare("dijit._editor._Plugin", null, {
set: function(/* attribute */ name, /* anything */ value){
// summary:
// Set a property on a plugin
- // name:
+ // name:
// The property to set.
- // value:
+ // value:
// The value to set in the property.
// description:
// Sets named properties on a plugin which may potentially be handled by a
@@ -212,12 +212,12 @@ var _Plugin = declare("dijit._editor._Plugin", null, {
// would be equivalent to writing:
// | plugin.bar = 3;
//
- // set() may also be called with a hash of name/value pairs, ex:
+ // set() may also be called with a hash of name/value pairs, ex:
// | plugin.set({
// | foo: "Howdy",
// | bar: 3
// | })
- // This is equivalent to calling set(foo, "Howdy") and set(bar, 3)
+ // This is equivalent to calling set(foo, "Howdy") and set(bar, 3)
if(typeof name === "object"){
for(var x in name){
this.set(x, name[x]);
@@ -237,7 +237,7 @@ var _Plugin = declare("dijit._editor._Plugin", null, {
get: function(name){
// summary:
// Get a property from a plugin.
- // name:
+ // name:
// The property to get.
// description:
// Get a named property from a plugin. The property may
View
10 _editor/plugins/EnterKeyHandling.js
@@ -581,14 +581,14 @@ return declare("dijit._editor.plugins.EnterKeyHandling", _Plugin, {
_adjustNodeAndOffset: function(/*DomNode*/node, /*Int*/offset){
// summary:
- // In the case there are multiple text nodes in a row the offset may not be within the node. If the offset is larger than the node length, it will attempt to find
- // the next text sibling until it locates the text node in which the offset refers to
+ // In the case there are multiple text nodes in a row the offset may not be within the node. If the offset is larger than the node length, it will attempt to find
+ // the next text sibling until it locates the text node in which the offset refers to
// node:
- // The node to check.
+ // The node to check.
// offset:
- // The position to find within the text node
+ // The position to find within the text node
// tags:
- // private.
+ // private.
while(node.length < offset && node.nextSibling && node.nextSibling.nodeType==3){
//Adjust the offset and node in the case of multiple text nodes in a row
offset = offset - node.length;
View
2  _editor/plugins/ViewSource.js
@@ -7,7 +7,7 @@ define([
"dojo/dom-style", // domStyle.set
"dojo/_base/event", // event.stop
"dojo/i18n", // i18n.getLocalization
- "dojo/keys", // keys.F12
+ "dojo/keys", // keys.F12
"dojo/_base/lang", // lang.hitch
"dojo/on", // on()
"dojo/sniff", // has("ie") has("webkit")
View
4 form/Select.js
@@ -124,7 +124,7 @@ var Select = declare("dijit.form.Select", [_FormSelectWidget, _HasDropDown], {
// Currently displayed error/prompt message
message: "",
- // tooltipPosition: String[]
+ // tooltipPosition: String[]
// See description of `dijit/Tooltip.defaultPosition` for details on this parameter.
tooltipPosition: [],
@@ -198,7 +198,7 @@ var Select = declare("dijit.form.Select", [_FormSelectWidget, _HasDropDown], {
// summary:
// Resets the menu and the length attribute of the button - and
// ensures that the label is appropriately set.
- // loadMenuItems: Boolean
+ // loadMenuItems: Boolean
// actually loads the child menu items - we only do this when we are
// populating for showing the dropdown.
View
5 form/_FormMixin.js
@@ -41,12 +41,11 @@ define([
// which indicates that the form is ready to be submitted.
state: "",
- // TODO:
+ // TODO:
// * Repeater
// * better handling for arrays. Often form elements have names with [] like
// * people[3].sex (for a list of people [{name: Bill, sex: M}, ...])
- //
- //
+
_getDescendantFormWidgets: function(/*dijit/_WidgetBase[]?*/ children){
// summary:
View
2  form/_TextBoxMixin.js
@@ -226,7 +226,7 @@ var _TextBoxMixin = declare("dijit.form._TextBoxMixin", null, {
// normalize input events to reduce spurious event processing
// onkeydown: do not forward modifier keys
- // set charOrCode to numeric keycode
+ // set charOrCode to numeric keycode
// onkeypress: do not forward numeric charOrCode keys (already sent through onkeydown)
// onpaste & oncut: set charOrCode to 229 (IME)
// oninput: if primary event not already processed, set charOrCode to 229 (IME), else do not forward
View
4 layout/ContentPane.js
@@ -216,7 +216,7 @@ return declare("dijit.layout.ContentPane", [_Widget, _Container, _ContentPaneRes
// description:
// Reset the (external defined) content of this pane and replace with new url
// Note: It delays the download until widget is shown if preload is false.
- // href:
+ // href:
// url to the page you want to get, must be within the same domain as your mainpage
// Cancel any in-flight requests (a set('href', ...) will cancel any in-flight set('href', ...))
@@ -251,7 +251,7 @@ return declare("dijit.layout.ContentPane", [_Widget, _Container, _ContentPaneRes
// summary:
// Hook to make set("content", ...) work.
// Replaces old content with data content, include style classes from old content
- // data:
+ // data:
// the new Content may be String, DomNode or NodeList
//
// if data is a NodeList (or an array of nodes) nodes are copied
View
2  layout/StackContainer.js
@@ -195,7 +195,7 @@ return declare("dijit.layout.StackContainer", _LayoutWidget, {
}
// If all our children are being destroyed than don't run the code below (to select another page),
- // because we are deleting every page one by one
+ // because we are deleting every page one by one
if(this._descendantsBeingDestroyed){ return; }
// Select new page to display, also updating TabController to show the respective tab.
View
2  tree/_dndSelector.js
@@ -58,7 +58,7 @@ define([
);
},
- // singular: Boolean
+ // singular: Boolean
// Allows selection of only one element, if true.
// Tree hasn't been tested in singular=true mode, unclear if it works.
singular: false,
Please sign in to comment.
Something went wrong with that request. Please try again.