From: Alan Knowles Date: Wed, 4 Aug 2021 05:00:51 +0000 (+0800) Subject: Fix #6913 - add more documentation to code X-Git-Url: http://git.roojs.org/?p=roojs1;a=commitdiff_plain;h=9c7a8ec74e80c6351625f2b02b15673ef54753ae Fix #6913 - add more documentation to code --- diff --git a/Roo/ComponentMgr.js b/Roo/ComponentMgr.js index 44d0ea945e..36c1649d7c 100644 --- a/Roo/ComponentMgr.js +++ b/Roo/ComponentMgr.js @@ -13,7 +13,7 @@ /** * @class Roo.ComponentMgr * Provides a common registry of all components on a page so that they can be easily accessed by component id (see {@link Roo.getCmp}). - * @singleton + * @static */ Roo.ComponentMgr = function(){ var all = new Roo.util.MixedCollection(); diff --git a/Roo/DomHelper.js b/Roo/DomHelper.js index 194a6c4913..f12b8885d3 100644 --- a/Roo/DomHelper.js +++ b/Roo/DomHelper.js @@ -29,7 +29,7 @@ * @class Roo.DomHelper * Utility class for working with DOM and/or Templates. It transparently supports using HTML fragments or DOM. * For more information see this blog post with examples. - * @singleton + * @static */ Roo.DomHelper = function(){ var tempTableEl = null; diff --git a/Roo/DomQuery.js b/Roo/DomQuery.js index 25137a05eb..f26e29e8b3 100644 --- a/Roo/DomQuery.js +++ b/Roo/DomQuery.js @@ -73,7 +73,7 @@ All selectors, attribute filters and pseudos below can be combined infinitely in
  • E{display%=2} css value "display" that is evenly divisible by 2
  • E{display!=none} css value "display" that does not equal "none"
  • - * @singleton + * @static */ Roo.DomQuery = function(){ var cache = {}, simpleCache = {}, valueCache = {}; diff --git a/Roo/EventManager.js b/Roo/EventManager.js index d23defd6b4..a2322c885e 100644 --- a/Roo/EventManager.js +++ b/Roo/EventManager.js @@ -14,7 +14,7 @@ * Registers event handlers that want to receive a normalized EventObject instead of the standard browser event and provides * several useful events directly. * See {@link Roo.EventObject} for more details on normalized event objects. - * @singleton + * @static */ Roo.EventManager = function(){ var docReadyEvent, docReadyProcId, docReadyState = false; @@ -576,7 +576,7 @@ Roo.onReady(function(){ Roo.EventManager.on("myDiv", 'click', handleClick); Roo.EventManager.addListener("myDiv", 'click', handleClick); - * @singleton + * @static */ Roo.EventObject = function(){ diff --git a/Roo/MessageBox.js b/Roo/MessageBox.js index 7562c5759d..a43dd34826 100644 --- a/Roo/MessageBox.js +++ b/Roo/MessageBox.js @@ -33,7 +33,7 @@ Roo.Msg.show({ animEl: 'elId' }); - * @singleton + * @static */ Roo.MessageBox = function(){ var dlg, opt, mask, waitTimer; diff --git a/Roo/QuickTips.js b/Roo/QuickTips.js index 31d6515a43..c5a52ae31e 100644 --- a/Roo/QuickTips.js +++ b/Roo/QuickTips.js @@ -11,7 +11,7 @@ /** * @class Roo.QuickTips * Provides attractive and customizable tooltips for any element. - * @singleton + * @static */ Roo.QuickTips = function(){ var el, tipBody, tipBodyText, tipTitle, tm, cfg, close, tagEls = {}, esc, removeCls = null, bdLeft, bdRight; diff --git a/Roo/bootstrap/MessageBox.js b/Roo/bootstrap/MessageBox.js index 76038e7b59..80a1ffdda9 100644 --- a/Roo/bootstrap/MessageBox.js +++ b/Roo/bootstrap/MessageBox.js @@ -28,7 +28,7 @@ Roo.Msg.show({ animEl: 'elId' }); - * @singleton + * @static */ Roo.bootstrap.MessageBox = function(){ var dlg, opt, mask, waitTimer; diff --git a/Roo/bootstrap/menu/Manager.js b/Roo/bootstrap/menu/Manager.js index 4e1172fcec..423efd01a9 100644 --- a/Roo/bootstrap/menu/Manager.js +++ b/Roo/bootstrap/menu/Manager.js @@ -2,7 +2,7 @@ * @class Roo.bootstrap.MenuMgr * @licence LGPL * Provides a common registry of all menu items on a page so that they can be easily accessed by id. - * @singleton + * @static */ Roo.bootstrap.menu.Manager = function(){ var menus, active, groups = {}, attached = false, lastShow = new Date(); diff --git a/Roo/data/SortTypes.js b/Roo/data/SortTypes.js index 473b2ce9c8..31c39f132b 100644 --- a/Roo/data/SortTypes.js +++ b/Roo/data/SortTypes.js @@ -12,7 +12,7 @@ /** * @class Roo.data.SortTypes - * @singleton + * @static * Defines the default sorting (casting?) comparison functions used when sorting data. */ Roo.data.SortTypes = { diff --git a/Roo/dd/DragDropMgr.js b/Roo/dd/DragDropMgr.js index 9befe30563..18fabfe87b 100644 --- a/Roo/dd/DragDropMgr.js +++ b/Roo/dd/DragDropMgr.js @@ -28,7 +28,7 @@ if (!Roo.dd.DragDropMgr) { * all DragDrop items in the window. Generally, you will not call * this class directly, but it does have helper methods that could * be useful in your DragDrop implementations. - * @singleton + * @static */ Roo.dd.DragDropMgr = function() { diff --git a/Roo/dd/Registry.js b/Roo/dd/Registry.js index 6eee28f9ad..406776b1c6 100644 --- a/Roo/dd/Registry.js +++ b/Roo/dd/Registry.js @@ -14,7 +14,7 @@ * @class Roo.dd.Registry * Provides easy access to all drag drop components that are registered on a page. Items can be retrieved either * directly by DOM node id, or by passing in the drag drop event that occurred and looking up the event target. - * @singleton + * @static */ Roo.dd.Registry = function(){ var elements = {}; diff --git a/Roo/dd/ScrollManager.js b/Roo/dd/ScrollManager.js index 9aa4be0120..56abb72295 100644 --- a/Roo/dd/ScrollManager.js +++ b/Roo/dd/ScrollManager.js @@ -14,7 +14,7 @@ * @class Roo.dd.ScrollManager * Provides automatic scrolling of overflow regions in the page during drag operations.

    * Note: This class uses "Point Mode" and is untested in "Intersect Mode". - * @singleton + * @static */ Roo.dd.ScrollManager = function(){ var ddm = Roo.dd.DragDropMgr; diff --git a/Roo/form/VTypes.js b/Roo/form/VTypes.js index e7140b3b10..78b338a7e4 100644 --- a/Roo/form/VTypes.js +++ b/Roo/form/VTypes.js @@ -11,7 +11,7 @@ /** * @class Roo.form.VTypes * Overridable validation definitions. The validations provided are basic and intended to be easily customizable and extended. - * @singleton + * @static */ Roo.form.VTypes = function(){ // closure these in so they are only created once. diff --git a/Roo/lib/Ajax.js b/Roo/lib/Ajax.js index 86db338621..1535eeee69 100644 --- a/Roo/lib/Ajax.js +++ b/Roo/lib/Ajax.js @@ -1,15 +1,17 @@ -/* - * Portions of this file are based on pieces of Yahoo User Interface Library - * Copyright (c) 2007, Yahoo! Inc. All rights reserved. - * YUI licensed under the BSD License: - * http://developer.yahoo.net/yui/license.txt - *