Dijit: Remove duplicate module summaries (which occurred both at the …

…module level and also in the object returned from the module). Also removed big doc-comment code blocks from focus.js and popup.js that were no longer needed. Problem files: - Viewport.js, dojo/_base.js - Adding a summary here masks the documentation of the returned values. But I did it anyway. Refs #13101 !strict. git-svn-id: http://svn.dojotoolkit.org/src/dijit/trunk@28904 560b804f-0ae3-0310-86f3-f6aa0a117693
dojo · Jun 18, 2012 · b82dc9e · b82dc9e
1 parent 048084a
commit b82dc9e
Show file tree

Hide file tree

Showing 87 changed files with 102 additions and 349 deletions.
diff --git a/BackgroundIframe.js b/BackgroundIframe.js
@@ -12,10 +12,6 @@ define([
 
 	// module:
 	//		dijit/BackgroundIFrame
-	// summary:
-	//		new dijit.BackgroundIframe(node)
-	//		Makes a background iframe as a child of node, that fills
-	//		area (and position) of node
 
 	// TODO: remove _frames, it isn't being used much, since popups never release their
 	// iframes (see [22236])

diff --git a/Calendar.js b/Calendar.js
@@ -20,8 +20,6 @@ define([
 
 	// module:
 	//		dijit/Calendar
-	// summary:
-	//		A simple GUI for choosing a date in the context of a monthly calendar.
 
 	var Calendar = declare("dijit.Calendar",
 		[CalendarLite, _Widget, _CssStateMixin], // _Widget for deprecated methods like setAttribute()

diff --git a/CalendarLite.js b/CalendarLite.js
@@ -21,8 +21,6 @@ define([
 
 	// module:
 	//		dijit/CalendarLite
-	// summary:
-	//		Lightweight version of Calendar widget aimed towards mobile use
 
 	var CalendarLite = declare("dijit.CalendarLite", [_WidgetBase, _TemplatedMixin], {
 		// summary:

diff --git a/CheckedMenuItem.js b/CheckedMenuItem.js
@@ -8,8 +8,6 @@ define([
 
 	// module:
 	//		dijit/CheckedMenuItem
-	// summary:
-	//		A checkbox-like menu item for toggling on and off
 
 	return declare("dijit.CheckedMenuItem", MenuItem, {
 		// summary:

diff --git a/ColorPalette.js b/ColorPalette.js
@@ -17,8 +17,6 @@ define([
 
 // module:
 //		dijit/ColorPalette
-// summary:
-//		A keyboard accessible color-picking widget
 
 var ColorPalette = declare("dijit.ColorPalette", [_Widget, _TemplatedMixin, _PaletteMixin], {
 	// summary:

diff --git a/Declaration.js b/Declaration.js
@@ -13,9 +13,6 @@ define([
 
 	// module:
 	//		dijit/Declaration
-	// summary:
-	//		The Declaration widget allows a developer to declare new widget
-	//		classes directly from a snippet of markup.
 
 	return declare("dijit.Declaration", _Widget, {
 		// summary:

diff --git a/Destroyable.js b/Destroyable.js
@@ -6,8 +6,6 @@ define([
 
 // module:
 //		dijit/Destroyable
-// summary:
-//		Mixin to track handles and release them when instance is destroyed.
 
 return declare("dijit.Destroyable", null, {
 	// summary:

diff --git a/Dialog.js b/Dialog.js
@@ -38,9 +38,6 @@ define([
 
 	// module:
 	//		dijit/Dialog
-	// summary:
-	//		A modal dialog Widget
-
 
 	/*=====
 	dijit._underlay = function(kwArgs){

diff --git a/DialogUnderlay.js b/DialogUnderlay.js
@@ -9,8 +9,6 @@ define([
 
 	// module:
 	//		dijit/DialogUnderlay
-	// summary:
-	//		The component that blocks the screen behind a `dijit.Dialog`
 
 	return declare("dijit.DialogUnderlay", [_Widget, _TemplatedMixin], {
 		// summary:

diff --git a/DropDownMenu.js b/DropDownMenu.js
@@ -9,8 +9,6 @@ define([
 
 	// module:
 	//		dijit/DropDownMenu
-	// summary:
-	//		dijit.DropDownMenu widget
 
 	return declare("dijit.DropDownMenu", [_MenuBase, _OnDijitClickMixin], {
 		// summary:

diff --git a/Editor.js b/Editor.js
@@ -34,8 +34,6 @@ define([
 
 	// module:
 	//		dijit/Editor
-	// summary:
-	//		A rich text Editing widget
 
 	var Editor = declare("dijit.Editor", RichText, {
 		// summary:

diff --git a/InlineEditBox.js b/InlineEditBox.js
@@ -26,8 +26,6 @@ define([
 
 	// module:
 	//		dijit/InlineEditBox
-	// summary:
-	//		An element with in-line edit capabilities
 
 	var InlineEditor = declare("dijit._InlineEditor", [_Widget, _TemplatedMixin, _WidgetsInTemplateMixin], {
 		// summary:

diff --git a/Menu.js b/Menu.js
@@ -21,8 +21,6 @@ define([
 
 // module:
 //		dijit/Menu
-// summary:
-//		Includes dijit.Menu widget and base class dijit._MenuBase
 
 // Back compat w/1.6, remove for 2.0
 if(has("dijit-legacy-requires")){

diff --git a/MenuBar.js b/MenuBar.js
@@ -8,8 +8,6 @@ define([
 
 // module:
 //		dijit/MenuBar
-// summary:
-//		A menu bar, listing menu choices horizontally, like the "File" menu in most desktop applications
 
 return declare("dijit.MenuBar", _MenuBase, {
 	// summary:

diff --git a/MenuBarItem.js b/MenuBarItem.js
@@ -6,9 +6,6 @@ define([
 
 	// module:
 	//		dijit/MenuBarItem
-	// summary:
-	//		Item in a MenuBar that's clickable, and doesn't spawn a submenu when pressed (or hovered)
-
 
 	var _MenuBarItemMixin = declare("dijit._MenuBarItemMixin", null, {
 		templateString: template,

diff --git a/MenuItem.js b/MenuItem.js
@@ -15,9 +15,6 @@ define([
 
 	// module:
 	//		dijit/MenuItem
-	// summary:
-	//		A line item in a Menu Widget
-
 
 	return declare("dijit.MenuItem",
 		[_Widget, _TemplatedMixin, _Contained, _CssStateMixin],

diff --git a/MenuSeparator.js b/MenuSeparator.js
@@ -9,8 +9,6 @@ define([
 
 	// module:
 	//		dijit/MenuSeparator
-	// summary:
-	//		A line between two menu items
 
 	return declare("dijit.MenuSeparator", [_WidgetBase, _TemplatedMixin, _Contained], {
 		// summary:

diff --git a/PopupMenuBarItem.js b/PopupMenuBarItem.js
@@ -6,8 +6,6 @@ define([
 
 	// module:
 	//		dijit/PopupMenuBarItem
-	// summary:
-	//		Item in a MenuBar like "File" or "Edit", that spawns a submenu when pressed (or hovered)
 
 	var _MenuBarItemMixin = MenuBarItem._MenuBarItemMixin;
 

diff --git a/PopupMenuItem.js b/PopupMenuItem.js
@@ -9,8 +9,6 @@ define([
 
 	// module:
 	//		dijit/PopupMenuItem
-	// summary:
-	//		An item in a Menu that spawn a drop down (usually a drop down menu)
 
 	return declare("dijit.PopupMenuItem", MenuItem, {
 		// summary:

diff --git a/ProgressBar.js b/ProgressBar.js
@@ -11,9 +11,6 @@ define([
 
 // module:
 //		dijit/ProgressBar
-// summary:
-//		A progress indication widget, showing the amount completed
-//		(often the percentage completed) of a task.
 
 
 return declare("dijit.ProgressBar", [_Widget, _TemplatedMixin], {

diff --git a/TitlePane.js b/TitlePane.js
@@ -19,8 +19,6 @@ define([
 
 // module:
 //		dijit/TitlePane
-// summary:
-//		A pane with a title on top, that can be expanded or collapsed.
 
 
 return declare("dijit.TitlePane", [ContentPane, _TemplatedMixin, _CssStateMixin], {

diff --git a/Toolbar.js b/Toolbar.js
@@ -11,8 +11,6 @@ define([
 
 	// module:
 	//		dijit/Toolbar
-	// summary:
-	//		A Toolbar widget, used to hold things like `dijit.Editor` buttons
 
 
 	// Back compat w/1.6, remove for 2.0

diff --git a/ToolbarSeparator.js b/ToolbarSeparator.js
@@ -7,8 +7,6 @@ define([
 
 	// module:
 	//		dijit/ToolbarSeparator
-	// summary:
-	//		A spacer between two `dijit.Toolbar` items
 
 
 	return declare("dijit.ToolbarSeparator", [_Widget, _TemplatedMixin], {

diff --git a/Tooltip.js b/Tooltip.js
@@ -22,8 +22,6 @@ define([
 
 	// module:
 	//		dijit/Tooltip
-	// summary:
-	//		Defines dijit.Tooltip widget (to display a tooltip), showTooltip()/hideTooltip(), and _MasterTooltip
 
 
 	// TODO: Tooltip should really share more positioning code with TooltipDialog, like:
@@ -295,6 +293,7 @@ define([
 	var Tooltip = declare("dijit.Tooltip", _Widget, {
 		// summary:
 		//		Pops up a tooltip (a help message) when you hover over a node.
+		//		Also provides static show() and hide() methods that can be used without instantiating a dijit/Tooltip.
 
 		// label: String
 		//		Text to display in the tooltip.

diff --git a/TooltipDialog.js b/TooltipDialog.js
@@ -16,8 +16,6 @@ define([
 
 	// module:
 	//		dijit/TooltipDialog
-	// summary:
-	//		Pops up a dialog that appears like a Tooltip
 
 
 	return declare("dijit.TooltipDialog",

diff --git a/Tree.js b/Tree.js
@@ -38,8 +38,6 @@ define([
 
 // module:
 //		dijit/Tree
-// summary:
-//		dijit.Tree widget, and internal dijit._TreeNode widget
 
 
 var TreeNode = declare(

diff --git a/Viewport.js b/Viewport.js
@@ -8,14 +8,19 @@ define([
 
 	// module:
 	//		dijit/Viewport
-	// summary:
-	//		Utility singleton to watch for viewport resizes, avoiding duplicate notifications
-	//		which can lead to infinite loops.
-	//
-	//		Usage: Viewport.on("resize", myCallback).
-	//
-	//		myCallback() is called without arguments in case it's _WidgetBase.resize(),
-	//		which would interpret the argument as the size to make the widget.
+
+	/*=====
+	return {
+		// summary:
+		//		Utility singleton to watch for viewport resizes, avoiding duplicate notifications
+		//		which can lead to infinite loops.
+		// description:
+		//		Usage: Viewport.on("resize", myCallback).
+		//
+		//		myCallback() is called without arguments in case it's _WidgetBase.resize(),
+		//		which would interpret the argument as the size to make the widget.
+	};
+	=====*/
 
 	var Viewport = new Evented();
 

diff --git a/WidgetSet.js b/WidgetSet.js
@@ -7,14 +7,11 @@ define([
 
 	// module:
 	//		dijit/WidgetSet
-	// summary:
-	//		Legacy registry code.   New modules should just use registry.
-	//		Will be removed in 2.0.
 
 	var WidgetSet = declare("dijit.WidgetSet", null, {
 		// summary:
-		//		A set of widgets indexed by id. A default instance of this class is
-		//		available as `dijit.registry`
+		//		A set of widgets indexed by id.
+		//		Deprecated, will be removed in 2.0.
 		//
 		// example:
 		//		Create a small list of widgets:
@@ -23,10 +20,6 @@ define([
 		//		|	ws.add(dijit.byId("two"));
 		//		|	// destroy both:
 		//		|	ws.forEach(function(w){ w.destroy(); });
-		//
-		// example:
-		//		Using dijit.registry:
-		//		|	dijit.registry.forEach(function(w){ /* do something */ });
 
 		constructor: function(){
 			this._hash = {};

diff --git a/_BidiSupport.js b/_BidiSupport.js
@@ -2,15 +2,20 @@ define(["./_WidgetBase"], function(_WidgetBase){
 
 	// module:
 	//		dijit/_BidiSupport
-	// summary:
-	//		Module that deals with BIDI, special with the auto
-	//		direction if needed without changing the GUI direction.
-	//		Including this module will extend _WidgetBase with BIDI related methods.
-	// description:
-	//		There's a special need for displaying BIDI text in rtl direction
-	//		in ltr GUI, sometimes needed auto support.
-	//		In creation of widget, if it's want to activate this class,
-	//		the widget should define the "textDir".
+
+	/*=====
+	return function(){
+		// summary:
+		//		Module that deals with BIDI, special with the auto
+		//		direction if needed without changing the GUI direction.
+		//		Including this module will extend _WidgetBase with BIDI related methods.
+		// description:
+		//		There's a special need for displaying BIDI text in rtl direction
+		//		in ltr GUI, sometimes needed auto support.
+		//		In creation of widget, if it's want to activate this class,
+		//		the widget should define the "textDir".
+	};
+	=====*/
 
 	_WidgetBase.extend({
 

diff --git a/_Contained.js b/_Contained.js
@@ -5,8 +5,6 @@ define([
 
 	// module:
 	//		dijit/_Contained
-	// summary:
-	//		Mixin for widgets that are children of a container widget
 
 	return declare("dijit._Contained", null, {
 		// summary:

diff --git a/_Container.js b/_Container.js
@@ -7,8 +7,6 @@ define([
 
 	// module:
 	//		dijit/_Container
-	// summary:
-	//		Mixin for widgets that can contain other widgets.
 
 	return declare("dijit._Container", null, {
 		// summary:

diff --git a/_CssStateMixin.js b/_CssStateMixin.js
@@ -12,9 +12,6 @@ define([
 
 // module:
 //		dijit/_CssStateMixin
-// summary:
-//		Mixin for widgets to set CSS classes on the widget DOM nodes depending on hover/mouse press/focus
-//		state changes, and also higher-level state changes such becoming disabled or selected.
 
 var CssStateMixin = declare("dijit._CssStateMixin", [], {
 	// summary:

diff --git a/_DialogMixin.js b/_DialogMixin.js
@@ -5,8 +5,6 @@ define([
 
 	// module:
 	//		dijit/_DialogMixin
-	// summary:
-	//		_DialogMixin provides functions useful to Dialog and TooltipDialog
 
 	return declare("dijit._DialogMixin", null, {
 		// summary:

diff --git a/_FocusMixin.js b/_FocusMixin.js
@@ -7,9 +7,6 @@ define([
 
 	// module:
 	//		dijit/_FocusMixin
-	// summary:
-	//		Mixin to widget to provide _onFocus() and _onBlur() methods that
-	//		fire when a widget or it's descendants get/lose focus
 
 	// We don't know where _FocusMixin will occur in the inheritance chain, but we need the _onFocus()/_onBlur() below
 	// to be last in the inheritance chain, so mixin to _WidgetBase.
@@ -60,7 +57,7 @@ define([
 	return declare("dijit._FocusMixin", null, {
 		// summary:
 		//		Mixin to widget to provide _onFocus() and _onBlur() methods that
-		//		fire when a widget or it's descendants get/lose focus
+		//		fire when a widget or its descendants get/lose focus
 
 		// flag that I want _onFocus()/_onBlur() notifications from focus manager
 		_focusManager: focus

diff --git a/_HasDropDown.js b/_HasDropDown.js
@@ -22,8 +22,6 @@ define([
 
 	// module:
 	//		dijit/_HasDropDown
-	// summary:
-	//		Mixin for widgets that need drop down ability.
 
 	return declare("dijit._HasDropDown", _FocusMixin, {
 		// summary: