Skip to content

Commit

Permalink
diji: fix api doc formatting, refs #13101 !strict
Browse files Browse the repository at this point in the history
  • Loading branch information
wkeese committed Jun 24, 2012
1 parent e406722 commit f26d07d
Show file tree
Hide file tree
Showing 24 changed files with 76 additions and 77 deletions.
24 changes: 12 additions & 12 deletions Calendar.js
Expand Up @@ -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);
},
Expand Down Expand Up @@ -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)
Expand All @@ -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>.
Expand All @@ -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; }

Expand Down Expand Up @@ -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){
Expand All @@ -233,7 +233,7 @@ define([
// dateObject: Date
// locale: String?
// tags:
// extension
// extension

/*=====
return ""; // String
Expand Down
22 changes: 11 additions & 11 deletions CalendarLite.js
Expand Up @@ -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);
}
Expand Down Expand Up @@ -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);
}
Expand All @@ -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);
Expand Down Expand Up @@ -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);
Expand All @@ -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());
},

Expand Down Expand Up @@ -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(){
Expand Down Expand Up @@ -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")){
Expand Down Expand Up @@ -436,7 +436,7 @@ define([
// dateObject: Date
// locale: String?
// tags:
// extension
// extension
/*=====
return false; // Boolean
=====*/
Expand All @@ -449,7 +449,7 @@ define([
// dateObject: Date
// locale: String?
// tags:
// extension
// extension

/*=====
return ""; // String
Expand Down
2 changes: 1 addition & 1 deletion Destroyable.js
Expand Up @@ -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);
Expand Down
4 changes: 2 additions & 2 deletions Editor.js
Expand Up @@ -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')){
Expand Down Expand Up @@ -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')){
Expand Down
2 changes: 1 addition & 1 deletion Tooltip.js
Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions Tree.js
Expand Up @@ -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[]
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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{
Expand Down
6 changes: 3 additions & 3 deletions _BidiSupport.js
Expand Up @@ -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;
},
Expand All @@ -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
Expand All @@ -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;
Expand Down
6 changes: 3 additions & 3 deletions _Contained.js
Expand Up @@ -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"];
Expand Down
2 changes: 1 addition & 1 deletion _Container.js
Expand Up @@ -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];
Expand Down
8 changes: 4 additions & 4 deletions _DialogMixin.js
Expand Up @@ -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:
Expand All @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions _PaletteMixin.js
Expand Up @@ -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
}
}
Expand Down
2 changes: 1 addition & 1 deletion _TimePicker.js
Expand Up @@ -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){
Expand Down
4 changes: 2 additions & 2 deletions _Widget.js
Expand Up @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions _WidgetBase.js
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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;
},
Expand Down

0 comments on commit f26d07d

Please sign in to comment.