Permalink
Browse files

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.
  • Loading branch information...
1 parent 2f5c1c2 commit 04f289f0db334a648c6e95cdebf7d24022c5557c @wkeese wkeese committed Jun 18, 2012
Showing with 102 additions and 349 deletions.
  1. +0 −4 BackgroundIframe.js
  2. +0 −2 Calendar.js
  3. +0 −2 CalendarLite.js
  4. +0 −2 CheckedMenuItem.js
  5. +0 −2 ColorPalette.js
  6. +0 −3 Declaration.js
  7. +0 −2 Destroyable.js
  8. +0 −3 Dialog.js
  9. +0 −2 DialogUnderlay.js
  10. +0 −2 DropDownMenu.js
  11. +0 −2 Editor.js
  12. +0 −2 InlineEditBox.js
  13. +0 −2 Menu.js
  14. +0 −2 MenuBar.js
  15. +0 −3 MenuBarItem.js
  16. +0 −3 MenuItem.js
  17. +0 −2 MenuSeparator.js
  18. +0 −2 PopupMenuBarItem.js
  19. +0 −2 PopupMenuItem.js
  20. +0 −3 ProgressBar.js
  21. +0 −2 TitlePane.js
  22. +0 −2 Toolbar.js
  23. +0 −2 ToolbarSeparator.js
  24. +1 −2 Tooltip.js
  25. +0 −2 TooltipDialog.js
  26. +0 −2 Tree.js
  27. +13 −8 Viewport.js
  28. +2 −9 WidgetSet.js
  29. +14 −9 _BidiSupport.js
  30. +0 −2 _Contained.js
  31. +0 −2 _Container.js
  32. +0 −3 _CssStateMixin.js
  33. +0 −2 _DialogMixin.js
  34. +1 −4 _FocusMixin.js
  35. +0 −2 _HasDropDown.js
  36. +0 −3 _KeyNavContainer.js
  37. +0 −2 _MenuBase.js
  38. +10 −10 _OnDijitClickMixin.js
  39. +0 −2 _PaletteMixin.js
  40. +0 −2 _Templated.js
  41. +0 −2 _TemplatedMixin.js
  42. +0 −2 _TimePicker.js
  43. +2 −4 _Widget.js
  44. +0 −2 _WidgetBase.js
  45. +0 −2 _WidgetsInTemplateMixin.js
  46. +7 −2 _base.js
  47. +0 −7 _editor/plugins/AlwaysShowToolbar.js
  48. +0 −6 _editor/plugins/EnterKeyHandling.js
  49. +0 −2 _editor/plugins/FontChoice.js
  50. +0 −5 _editor/plugins/FullScreen.js
  51. +2 −0 _editor/plugins/LinkDialog.js
  52. +0 −3 _editor/plugins/NewPage.js
  53. +0 −3 _editor/plugins/Print.js
  54. +0 −5 _editor/plugins/TabIndent.js
  55. +0 −2 _editor/plugins/TextColor.js
  56. +0 −4 _editor/plugins/ToggleDir.js
  57. +0 −2 _editor/plugins/ViewSource.js
  58. +3 −2 a11y.js
  59. +7 −2 dijit-all.js
  60. +9 −4 dijit.js
  61. +1 −43 focus.js
  62. +8 −3 hccss.js
  63. +0 −3 layout/AccordionContainer.js
  64. +0 −2 layout/AccordionPane.js
  65. +0 −2 layout/BorderContainer.js
  66. +0 −3 layout/ContentPane.js
  67. +0 −2 layout/LayoutContainer.js
  68. +0 −3 layout/LinkPane.js
  69. +0 −3 layout/ScrollingTabController.js
  70. +0 −2 layout/SplitContainer.js
  71. +0 −2 layout/StackContainer.js
  72. +0 −2 layout/StackController.js
  73. +0 −2 layout/TabContainer.js
  74. +0 −3 layout/TabController.js
  75. +0 −4 layout/_ContentPaneResizeMixin.js
  76. +0 −3 layout/_LayoutWidget.js
  77. +0 −3 layout/_TabContainerBase.js
  78. +6 −3 layout/utils.js
  79. +8 −2 main.js
  80. +0 −2 place.js
  81. +4 −55 popup.js
  82. +4 −5 registry.js
  83. +0 −3 tree/ForestStoreModel.js
  84. +0 −3 tree/TreeStoreModel.js
  85. +0 −3 tree/_dndContainer.js
  86. +0 −3 tree/_dndSelector.js
  87. +0 −5 typematic.js
View
@@ -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])
View
@@ -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()
View
@@ -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:
View
@@ -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:
View
@@ -17,8 +17,6 @@ define([
// module:
// dijit/ColorPalette
-// summary:
-// A keyboard accessible color-picking widget
var ColorPalette = declare("dijit.ColorPalette", [_Widget, _TemplatedMixin, _PaletteMixin], {
// summary:
View
@@ -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:
View
@@ -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:
View
@@ -38,9 +38,6 @@ define([
// module:
// dijit/Dialog
- // summary:
- // A modal dialog Widget
-
/*=====
dijit._underlay = function(kwArgs){
View
@@ -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:
View
@@ -9,8 +9,6 @@ define([
// module:
// dijit/DropDownMenu
- // summary:
- // dijit.DropDownMenu widget
return declare("dijit.DropDownMenu", [_MenuBase, _OnDijitClickMixin], {
// summary:
View
@@ -34,8 +34,6 @@ define([
// module:
// dijit/Editor
- // summary:
- // A rich text Editing widget
var Editor = declare("dijit.Editor", RichText, {
// summary:
View
@@ -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:
View
@@ -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")){
View
@@ -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:
View
@@ -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,
View
@@ -15,9 +15,6 @@ define([
// module:
// dijit/MenuItem
- // summary:
- // A line item in a Menu Widget
-
return declare("dijit.MenuItem",
[_Widget, _TemplatedMixin, _Contained, _CssStateMixin],
View
@@ -9,8 +9,6 @@ define([
// module:
// dijit/MenuSeparator
- // summary:
- // A line between two menu items
return declare("dijit.MenuSeparator", [_WidgetBase, _TemplatedMixin, _Contained], {
// summary:
View
@@ -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;
View
@@ -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:
View
@@ -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], {
View
@@ -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], {
View
@@ -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
View
@@ -7,8 +7,6 @@ define([
// module:
// dijit/ToolbarSeparator
- // summary:
- // A spacer between two `dijit.Toolbar` items
return declare("dijit.ToolbarSeparator", [_Widget, _TemplatedMixin], {
View
@@ -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.
View
@@ -16,8 +16,6 @@ define([
// module:
// dijit/TooltipDialog
- // summary:
- // Pops up a dialog that appears like a Tooltip
return declare("dijit.TooltipDialog",
View
@@ -38,8 +38,6 @@ define([
// module:
// dijit/Tree
-// summary:
-// dijit.Tree widget, and internal dijit._TreeNode widget
var TreeNode = declare(
View
@@ -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();
View
@@ -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 = {};
View
@@ -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({
View
@@ -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:
View
@@ -7,8 +7,6 @@ define([
// module:
// dijit/_Container
- // summary:
- // Mixin for widgets that can contain other widgets.
return declare("dijit._Container", null, {
// summary:
View
@@ -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:
View
@@ -5,8 +5,6 @@ define([
// module:
// dijit/_DialogMixin
- // summary:
- // _DialogMixin provides functions useful to Dialog and TooltipDialog
return declare("dijit._DialogMixin", null, {
// summary:
View
@@ -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
View
@@ -22,8 +22,6 @@ define([
// module:
// dijit/_HasDropDown
- // summary:
- // Mixin for widgets that need drop down ability.
return declare("dijit._HasDropDown", _FocusMixin, {
// summary:
Oops, something went wrong.

0 comments on commit 04f289f

Please sign in to comment.