[TASK] Streamline JavaScript documentation 70/44170/5
authorFrank Nägler <frank.naegler@typo3.org>
Mon, 19 Oct 2015 21:50:37 +0000 (23:50 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Fri, 23 Oct 2015 12:24:29 +0000 (14:24 +0200)
Resolves: #70966
Releases: master
Change-Id: Ic78753be0facd860e5ab30ce6d7340e040dee59c
Reviewed-on: https://review.typo3.org/44170
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
115 files changed:
typo3/sysext/backend/Resources/Public/JavaScript/AjaxDataHandler.js
typo3/sysext/backend/Resources/Public/JavaScript/ClickMenu.js
typo3/sysext/backend/Resources/Public/JavaScript/ContextHelp.js
typo3/sysext/backend/Resources/Public/JavaScript/DateTimePicker.js
typo3/sysext/backend/Resources/Public/JavaScript/DebugConsole.js
typo3/sysext/backend/Resources/Public/JavaScript/DocumentHeader.js
typo3/sysext/backend/Resources/Public/JavaScript/DragUploader.js
typo3/sysext/backend/Resources/Public/JavaScript/FormEngine.js
typo3/sysext/backend/Resources/Public/JavaScript/FormEngine/Element/SelectSingleElement.js
typo3/sysext/backend/Resources/Public/JavaScript/FormEngineFlexForm.js
typo3/sysext/backend/Resources/Public/JavaScript/FormEngineSuggest.js
typo3/sysext/backend/Resources/Public/JavaScript/FormEngineValidation.js
typo3/sysext/backend/Resources/Public/JavaScript/Icons.js
typo3/sysext/backend/Resources/Public/JavaScript/ImageManipulation.js
typo3/sysext/backend/Resources/Public/JavaScript/LayoutModule/DragDrop.js
typo3/sysext/backend/Resources/Public/JavaScript/LegacyCssClasses.js
typo3/sysext/backend/Resources/Public/JavaScript/LegacyTree.js
typo3/sysext/backend/Resources/Public/JavaScript/LiveSearch.js
typo3/sysext/backend/Resources/Public/JavaScript/Login.js
typo3/sysext/backend/Resources/Public/JavaScript/LoginRefresh.js
typo3/sysext/backend/Resources/Public/JavaScript/Modal.js
typo3/sysext/backend/Resources/Public/JavaScript/Notification.js
typo3/sysext/backend/Resources/Public/JavaScript/OnlineMedia.js
typo3/sysext/backend/Resources/Public/JavaScript/PageActions.js
typo3/sysext/backend/Resources/Public/JavaScript/Popover.js
typo3/sysext/backend/Resources/Public/JavaScript/SplitButtons.js
typo3/sysext/backend/Resources/Public/JavaScript/Storage.js
typo3/sysext/backend/Resources/Public/JavaScript/Tabs.js
typo3/sysext/backend/Resources/Public/JavaScript/ToggleSearchToolbox.js
typo3/sysext/backend/Resources/Public/JavaScript/Toolbar/ClearCacheMenu.js
typo3/sysext/backend/Resources/Public/JavaScript/Toolbar/ShortcutMenu.js
typo3/sysext/backend/Resources/Public/JavaScript/Toolbar/SystemInformationMenu.js
typo3/sysext/backend/Resources/Public/JavaScript/Tooltip.js
typo3/sysext/backend/Resources/Public/JavaScript/UserPassLogin.js
typo3/sysext/backend/Resources/Public/JavaScript/Utility.js
typo3/sysext/backend/Resources/Public/JavaScript/ValueSlider.js
typo3/sysext/backend/Resources/Public/JavaScript/Wizard/Colorpicker.js
typo3/sysext/backend/Resources/Public/JavaScript/extjs/components/pagetree/javascript/tree.js
typo3/sysext/backend/Resources/Public/JavaScript/notifications.js
typo3/sysext/beuser/Resources/Public/JavaScript/BackendUserListing.js
typo3/sysext/beuser/Resources/Public/JavaScript/Permissions.js
typo3/sysext/core/Resources/Public/JavaScript/QueryGenerator.js
typo3/sysext/documentation/Resources/Public/JavaScript/Main.js
typo3/sysext/extensionmanager/Resources/Public/JavaScript/Main.js
typo3/sysext/filelist/Resources/Public/JavaScript/FileList.js
typo3/sysext/filelist/Resources/Public/JavaScript/FileListLocalisation.js
typo3/sysext/filelist/Resources/Public/JavaScript/FileSearch.js
typo3/sysext/form/Resources/Public/JavaScript/Wizard/Initialize.js
typo3/sysext/impexp/Resources/Public/JavaScript/ImportExport.js
typo3/sysext/lang/Resources/Public/JavaScript/Lang.js
typo3/sysext/lang/Resources/Public/JavaScript/LanguageModule.js
typo3/sysext/linkvalidator/Resources/Public/JavaScript/Linkvalidator.js
typo3/sysext/opendocs/Resources/Public/JavaScript/Toolbar/OpendocsMenu.js
typo3/sysext/recordlist/Resources/Public/JavaScript/BrowseDatabase.js
typo3/sysext/recordlist/Resources/Public/JavaScript/BrowseFiles.js
typo3/sysext/recordlist/Resources/Public/JavaScript/BrowseFolders.js
typo3/sysext/recordlist/Resources/Public/JavaScript/ElementBrowser.js
typo3/sysext/recordlist/Resources/Public/JavaScript/FieldSelectBox.js
typo3/sysext/recordlist/Resources/Public/JavaScript/FileLinkHandler.js
typo3/sysext/recordlist/Resources/Public/JavaScript/LinkBrowser.js
typo3/sysext/recordlist/Resources/Public/JavaScript/MailLinkHandler.js
typo3/sysext/recordlist/Resources/Public/JavaScript/PageLinkHandler.js
typo3/sysext/recordlist/Resources/Public/JavaScript/Recordlist.js
typo3/sysext/recordlist/Resources/Public/JavaScript/Tooltip.js
typo3/sysext/recordlist/Resources/Public/JavaScript/UrlLinkHandler.js
typo3/sysext/recycler/Resources/Public/JavaScript/Recycler.js
typo3/sysext/rsaauth/Resources/Public/JavaScript/RsaEncryptionModule.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Ajax/Ajax.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/CSS/Parser.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Configuration/Config.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/DOM/BookMark.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/DOM/DOM.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/DOM/Node.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/DOM/Selection.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/DOM/Walker.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Editor/Editor.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Editor/Framework.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Editor/Iframe.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Editor/StatusBar.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Editor/TextAreaContainer.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Editor/Toolbar.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Event/Event.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Event/KeyMap.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Extjs/ColorPalette.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Extjs/ux/ColorMenu.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Extjs/ux/ColorPaletteField.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/HTMLArea.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Plugin/Plugin.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Toolbar/Button.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Toolbar/Select.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Toolbar/ToolbarText.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/UserAgent/UserAgent.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Util/Color.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Util/Resizable.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Util/String.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Util/TYPO3.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Util/Tips.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/HTMLArea/Util/Util.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/Modules/SelectImage.js
typo3/sysext/rtehtmlarea/Resources/Public/JavaScript/RteLinkBrowser.js
typo3/sysext/scheduler/Resources/Public/JavaScript/Scheduler.js
typo3/sysext/sys_action/Resources/Public/JavaScript/ActionTask.js
typo3/sysext/t3editor/Resources/Public/JavaScript/FileEdit.js
typo3/sysext/t3editor/Resources/Public/JavaScript/Plugins/CodeCompletion/CompletionResult.js
typo3/sysext/t3editor/Resources/Public/JavaScript/Plugins/CodeCompletion/DescriptionPlugin.js
typo3/sysext/t3editor/Resources/Public/JavaScript/Plugins/CodeCompletion/TsCodeCompletion.js
typo3/sysext/t3editor/Resources/Public/JavaScript/Plugins/CodeCompletion/TsParser.js
typo3/sysext/t3editor/Resources/Public/JavaScript/Plugins/CodeCompletion/TsRef.js
typo3/sysext/t3editor/Resources/Public/JavaScript/T3editor.js
typo3/sysext/taskcenter/Resources/Public/JavaScript/Taskcenter.js
typo3/sysext/tstemplate/Resources/Public/JavaScript/ConstantEditor.js
typo3/sysext/tstemplate/Resources/Public/JavaScript/TypoScriptObjectBrowser.js
typo3/sysext/viewpage/Resources/Public/JavaScript/Main.js
typo3/sysext/wizard_crpages/Resources/Public/JavaScript/WizardCreatePages.js
typo3/sysext/workspaces/Resources/Public/JavaScript/Toolbar/WorkspacesMenu.js

index e625841..3001a73 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/AjaxDataHandler
  * AjaxDataHandler - Javascript functions to work with AJAX and interacting with tce_db.php
  */
 define(['jquery', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/Icons', 'TYPO3/CMS/Backend/Notification'], function ($, Modal, Icons) {
        'use strict';
 
+       /**
+        *
+        * @type {{identifier: {hide: string, delete: string, icon: string}}}
+        * @exports TYPO3/CMS/Backend/AjaxDataHandler
+        */
        var AjaxDataHandler = {
                identifier: {
                        hide: '.t3js-record-hide',
@@ -27,8 +33,9 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/Icons', 'TYPO3/C
 
        /**
         * generic function to call from the outside the script and validate directly showing errors
-        * @param parameters
-        * @return a jQuery deferred object (promise)
+        *
+        * @param {Object} parameters
+        * @return {Promise<Object>} a jQuery deferred object (promise)
         */
        AjaxDataHandler.process = function(parameters) {
                return AjaxDataHandler._call(parameters).done(function(result) {
@@ -38,6 +45,9 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/Icons', 'TYPO3/C
                });
        };
 
+       /**
+        *
+        */
        AjaxDataHandler.initialize = function() {
 
                // HIDE/UNHIDE: click events for all action icons to hide/unhide
@@ -94,7 +104,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/Icons', 'TYPO3/C
        /**
         * Toggle row visibility after record has been changed
         *
-        * @param $rowElement
+        * @param {Object} $rowElement
         */
        AjaxDataHandler.toggleRow = function($rowElement) {
                var $anchorElement = $rowElement.find(AjaxDataHandler.identifier.hide);
@@ -150,7 +160,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/Icons', 'TYPO3/C
         * delete record by given element (icon in table)
         * don't call it directly!
         *
-        * @param element
+        * @param {HTMLElement} element
         */
        AjaxDataHandler.deleteRecord = function(element) {
                var $anchorElement = $(element);
@@ -202,7 +212,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/Icons', 'TYPO3/C
        /**
         * handle the errors from result object
         *
-        * @param result
+        * @param {Object} result
         * @private
         */
        AjaxDataHandler.handleErrors = function(result) {
@@ -224,6 +234,9 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/Icons', 'TYPO3/C
        /**
         * AJAX call to tce_db.php
         * returns a jQuery Promise to work with
+        *
+        * @param {Object} params
+        * @returns {Object}
         * @private
         */
        AjaxDataHandler._call = function(params) {
@@ -232,6 +245,8 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/Icons', 'TYPO3/C
 
        /**
         * Replace the given icon with a spinner icon
+        *
+        * @param {Object} $iconElement
         * @private
         */
        AjaxDataHandler._showSpinnerIcon = function($iconElement) {
index 92c1f74..ffe6a73 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/ClickMenu
  * Javascript container used to load the clickmenu via AJAX
  * to render the result in a layer next to the mouse cursor
  */
 define(['jquery'], function($) {
 
+       /**
+        *
+        * @type {{mousePos: {X: null, Y: null}, delayClickMenuHide: boolean}}
+        * @exports TYPO3/CMS/Backend/ClickMenu
+        */
        var ClickMenu = {
                mousePos: {
                        X: null,
@@ -25,6 +31,9 @@ define(['jquery'], function($) {
                delayClickMenuHide: false
        };
 
+       /**
+        * Initialize events
+        */
        ClickMenu.initializeEvents = function() {
                $(document).on('click contextmenu', '.t3-js-clickmenutrigger', function(event) {
                        // if there is an other "inline" onclick setting, clickmenu is not triggered
@@ -47,13 +56,13 @@ define(['jquery'], function($) {
        };
 
        /**
-        * main function, called from most clickmenu links
+        * Main function, called from most clickmenu links
         *
-        * @param table Table from where info should be fetched
-        * @param uid The UID of the item
-        * @param listFr list Frame?
-        * @param enDisItems Items to disable / enable
-        * @param addParams Additional params
+        * @param {String} table Table from where info should be fetched
+        * @param {(String|Number)} uid The UID of the item
+        * @param {String} listFr list Frame?
+        * @param {String} enDisItems Items to disable / enable
+        * @param {String} addParams Additional params
         * @return void
         */
        ClickMenu.show = function(table, uid, listFr, enDisItems, addParams) {
@@ -78,9 +87,9 @@ define(['jquery'], function($) {
        };
 
        /**
-        * make the AJAX request
+        * Make the AJAX request
         *
-        * @param array parameters Parameters sent to the server
+        * @param {array} parameters Parameters sent to the server
         * @return void
         */
        ClickMenu.fetch = function(parameters) {
@@ -108,8 +117,9 @@ define(['jquery'], function($) {
        /**
         * fills the clickmenu with content and displays it correctly
         * depending on the mouse position
-        * @param data The data that will be put in the menu
-        * @param level The depth of the clickmenu
+        *
+        * @param {String} data The data that will be put in the menu
+        * @param {Number} level The depth of the clickmenu
         */
        ClickMenu.populateData = function(data, level) {
                this.initializeClickMenuContainer();
@@ -166,7 +176,8 @@ define(['jquery'], function($) {
         * event handler function that saves the
         * actual position of the mouse
         * in the Clickmenu object
-        * @param event The event object
+        *
+        * @param {Event} event The event object
         */
        ClickMenu.storeMousePositionEvent = function(event) {
                ClickMenu.mousePos.X = event.pageX;
@@ -178,8 +189,8 @@ define(['jquery'], function($) {
        /**
         * hides a visible menu if the mouse has moved outside
         * of the object
-        * @param obj The object to hide
-        * @result void
+        *
+        * @param {Object} obj The object to hide
         */
        ClickMenu.mouseOutFromMenu = function(obj) {
                var $element = $(obj);
@@ -191,6 +202,13 @@ define(['jquery'], function($) {
                }
        };
 
+       /**
+        *
+        * @param {Object} $element
+        * @param {Number} x
+        * @param {Number} y
+        * @returns {Boolean}
+        */
        ClickMenu.within = function($element, x, y) {
                var offset = $element.offset();
            return (y >= offset.top &&
@@ -202,8 +220,7 @@ define(['jquery'], function($) {
        /**
         * hides a clickmenu
         *
-        * @param obj The clickmenu object to hide
-        * @result void
+        * @param {Object} obj The clickmenu object to hide
         */
        ClickMenu.hide = function(obj) {
                this.delayClickMenuHide = false;
@@ -224,8 +241,6 @@ define(['jquery'], function($) {
 
        /**
         * manipulates the DOM to add the divs needed for clickmenu at the bottom of the <body>-tag
-        *
-        * @return void
         */
        ClickMenu.initializeClickMenuContainer = function() {
                if ($('#contentMenu0').length === 0) {
index 592e272..d31e76e 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/ContextHelp
  * API for context help.
  */
 define(['jquery', 'TYPO3/CMS/Backend/Popover', 'bootstrap'], function($) {
@@ -19,7 +20,8 @@ define(['jquery', 'TYPO3/CMS/Backend/Popover', 'bootstrap'], function($) {
        /**
         * The main ContextHelp object
         *
-        * @type {{ajaxUrl: *, localCache: {}, openContext: null}}
+        * @type {{ajaxUrl: *, localCache: {}, helpModuleUrl: string, trigger: string, placement: string, selector: string}}
+        * @exports TYPO3/CMS/Backend/ContextHelp
         */
        var ContextHelp = {
                ajaxUrl: TYPO3.settings.ajaxUrls['context_help'],
@@ -96,7 +98,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Popover', 'bootstrap'], function($) {
        /**
         * Open the help popup
         *
-        * @param {object} $trigger
+        * @param {Object} $trigger
         */
        ContextHelp.showHelpPopup = function($trigger) {
                var configuration = top.TYPO3.configuration.ContextHelpWindows || top.TYPO3.configuration.PopupWindow;
@@ -119,7 +121,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Popover', 'bootstrap'], function($) {
        /**
         * Load help data
         *
-        * @param {object} $trigger
+        * @param {Object} $trigger
         */
        ContextHelp.loadHelp = function($trigger) {
                var table = $trigger.data('table');
index f451204..34202a0 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/DateTimePicker
  * contains all logic for the date time picker used in FormEngine
  * and EXT:belog and EXT:scheduler
  */
 define(['jquery'], function ($) {
 
+       /**
+        *
+        * @type {{options: {fieldSelector: string, format: *}}}
+        * @exports TYPO3/CMS/Backend/DateTimePicker
+        */
        var DateTimePicker = {
                options: {
                        fieldSelector: '.t3js-datetimepicker',
index 859b60c..ae7c1e6 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/DebugConsole
  * The debug console shown at the bottom of the backend
  */
 define(['jquery'], function ($) {
        'use strict';
 
+       /**
+        *
+        * @type {{$consoleDom: null, settings: {autoscroll: boolean}}}
+        * @exports TYPO3/CMS/Backend/DebugConsole
+        */
        var DebugConsole = {
                $consoleDom: null,
                settings: {
@@ -100,6 +106,10 @@ define(['jquery'], function ($) {
 
        /**
         * Adds a button and it's callback to the console's toolbar
+        *
+        * @param {Object} $button
+        * @param {function} callback
+        * @returns {{$consoleDom: null, settings: {autoscroll: boolean}}}
         */
        DebugConsole.addButton = function($button, callback) {
                $button.on('click', callback);
@@ -120,6 +130,10 @@ define(['jquery'], function ($) {
 
        /**
         * Add the debug message to the console
+        *
+        * @param {String} message
+        * @param {String} header
+        * @param {String} [group=Debug]
         */
        DebugConsole.add = function(message, header, group) {
                DebugConsole.attachToViewport();
@@ -178,6 +192,8 @@ define(['jquery'], function ($) {
 
        /**
         * Gets a proper console icon depending on the amount of tabs
+        *
+        * @param {Object} $tabs
         */
        DebugConsole.identifyTabLengthPresentationIcon = function($tabs) {
                var terminalIcon1 = true,
@@ -195,6 +211,8 @@ define(['jquery'], function ($) {
 
        /**
         * Increment the counter of unread messages in the given tab
+        *
+        * @param {Object} $tab
         */
        DebugConsole.incrementInactiveTabCounter = function($tab) {
                if (!$tab.hasClass('active')) {
index a1dd9cc..0840d61 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/DocumentHeader
  * Calculates the height of the docHeader and hides it upon scrolling
  */
 define(['jquery'], function($) {
        'use strict';
 
+       /**
+        *
+        * @type {{$documentHeader: null, $documentHeaderBars: null, $documentHeaderNavigationBar: null, $documentHeaderSearchBar: null, $moduleBody: null, direction: string, reactionRange: number, lastPosition: number, currentPosition: number, changedPosition: number, settings: {margin: number, offset: number, selectors: {moduleDocumentHeader: string, moduleDocheaderBar: string, moduleNavigationBar: string, moduleButtonBar: string, moduleSearchBar: string, moduleBody: string}}}}
+        * @exports TYPO3/CMS/Backend/DocumentHeader
+        */
        var DocumentHeader = {
                $documentHeader: null,
                $documentHeaderBars: null,
index b441938..f566ebe 100644 (file)
@@ -12,7 +12,7 @@
  */
 
 /**
- * JavaScript RequireJS module called "TYPO3/CMS/Backend/DragUploader"
+ * Module: TYPO3/CMS/Backend/DragUploader
  *
  */
 define(['jquery', 'moment', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Lang/Lang'], function($, moment, NProgress, Modal) {
@@ -20,7 +20,7 @@ define(['jquery', 'moment', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/L
        /**
         * Array of files which are asked for being overridden
         *
-        * @type {Array}
+        * @type {array}
         */
        var askForOverride = [],
                percentagePerFile = 1;
@@ -40,6 +40,12 @@ define(['jquery', 'moment', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/L
         */
 
        // register the constructor
+       /**
+        *
+        * @param {HTMLElement} element
+        * @constructor
+        * @exports TYPO3/CMS/Backend/DragUploader
+        */
        var DragUploaderPlugin = function(element) {
                var me = this;
                me.$body = $('body');
@@ -70,16 +76,28 @@ define(['jquery', 'moment', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/L
                        Progress: "upload" in new XMLHttpRequest
                };
 
+               /**
+                *
+                */
                me.showDropzone = function() {
                        me.$dropzone.show();
                };
 
+               /**
+                *
+                * @param {Event} event
+                */
                me.hideDropzone = function(event) {
                        event.stopPropagation();
                        event.preventDefault();
                        me.$dropzone.hide();
                };
 
+               /**
+                *
+                * @param {Event} event
+                * @returns {Boolean}
+                */
                me.dragFileIntoDocument = function(event) {
                        event.stopPropagation();
                        event.preventDefault();
@@ -88,6 +106,11 @@ define(['jquery', 'moment', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/L
                        return false;
                };
 
+               /**
+                *
+                * @param {Event} event
+                * @returns {Boolean}
+                */
                me.dragAborted = function(event) {
                        event.stopPropagation();
                        event.preventDefault();
@@ -95,6 +118,11 @@ define(['jquery', 'moment', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/L
                        return false;
                };
 
+               /**
+                *
+                * @param {Event} event
+                * @returns {Boolean}
+                */
                me.ignoreDrop = function(event) {
                        // stops the browser from redirecting.
                        event.stopPropagation();
@@ -103,12 +131,20 @@ define(['jquery', 'moment', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/L
                        return false;
                };
 
+               /**
+                *
+                * @param {Event} event
+                */
                me.handleDrop = function(event) {
                        me.ignoreDrop(event);
                        me.processFiles(event.originalEvent.dataTransfer.files);
                        me.$dropzone.removeClass('drop-status-ok');
                };
 
+               /**
+                *
+                * @param {Array} files
+                */
                me.processFiles = function(files) {
                        me.queueLength = files.length;
 
@@ -155,16 +191,27 @@ define(['jquery', 'moment', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/L
                        me.$fileInput.val('');
                };
 
-
+               /**
+                *
+                * @param {Event} event
+                */
                me.fileInDropzone = function(event) {
                        me.$dropzone.addClass('drop-status-ok');
                };
 
+               /**
+                *
+                * @param {Event} event
+                */
                me.fileOutOfDropzone = function(event) {
                        me.$dropzone.removeClass('drop-status-ok');
                };
 
-               // bind file picker to default upload button
+               /**
+                * bind file picker to default upload button
+                *
+                * @param {Object} button
+                */
                me.bindUploadButton = function(button) {
                        button.click(function(event) {
                                event.preventDefault();
@@ -219,6 +266,9 @@ define(['jquery', 'moment', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/L
                        me.bindUploadButton(me.$trigger.length ? me.$trigger : me.$element);
                }
 
+               /**
+                *
+                */
                me.decrementQueueLength = function() {
                        if (me.queueLength > 0) {
                                me.queueLength--;
@@ -239,6 +289,9 @@ define(['jquery', 'moment', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/L
                        }
                };
 
+               /**
+                *
+                */
                me.drawOverrideModal = function() {
                        var amountOfItems = Object.keys(askForOverride).length;
                        if (amountOfItems === 0) {
index 49754c2..15a7cb8 100644 (file)
@@ -27,11 +27,16 @@ var setFormValueOpenBrowser
        ,setFormValueManipulate
        ,setFormValue_getFObj;
 
-
+/**
+ * Module: TYPO3/CMS/Backend/FormEngine
+ */
 define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
 
-
-       // main options
+       /**
+        *
+        * @type {{formName: *, backPath: *, openedPopupWindow: null, legacyFieldChangedCb: Function, browserUrl: string}}
+        * @exports TYPO3/CMS/Backend/FormEngine
+        */
        var FormEngine = {
                formName: TYPO3.settings.FormEngine.formName
                ,backPath: TYPO3.settings.FormEngine.backPath
@@ -40,6 +45,10 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
                ,browserUrl: ''
        };
 
+       /**
+        *
+        * @param {String} browserUrl
+        */
        FormEngine.setBrowserUrl = function(browserUrl) {
                FormEngine.browserUrl = browserUrl;
        };
@@ -49,10 +58,10 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
        /**
         * opens a popup window with the element browser (browser.php)
         *
-        * @param mode can be "db" or "file"
-        * @param params additional params for the browser window
-        * @param width width of the window
-        * @param height height of the window
+        * @param {String} mode can be "db" or "file"
+        * @param {String} params additional params for the browser window
+        * @param {Number} width width of the window
+        * @param {Number} height height of the window
         */
        FormEngine.openPopupWindow = setFormValueOpenBrowser = function(mode, params, width, height) {
                var url = FormEngine.backPath + FormEngine.browserUrl + '&mode=' + mode + '&bparams=' + params;
@@ -68,11 +77,11 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
         * or from a multi-select (two selects side-by-side)
         * previously known as "setFormValueFromBrowseWin"
         *
-        * @param fieldName formerly known as "fName" name of the field, like [tt_content][2387][header]
-        * @param value the value to fill in (could be an integer)
-        * @param label the visible name in the selector
-        * @param title the title when hovering over it
-        * @param exclusiveValues if the select field has exclusive options that are not combine-able
+        * @param {String} fieldName formerly known as "fName" name of the field, like [tt_content][2387][header]
+        * @param {(String|Number)} value the value to fill in (could be an integer)
+        * @param {String} label the visible name in the selector
+        * @param {String} title the title when hovering over it
+        * @param {String} exclusiveValues if the select field has exclusive options that are not combine-able
         */
        FormEngine.setSelectOptionFromExternalSource = setFormValueFromBrowseWin = function(fieldName, value, label, title, exclusiveValues) {
                exclusiveValues = String(exclusiveValues);
@@ -182,8 +191,8 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
         * sets the value of the hidden field, from the select list, always executed after the select field was updated
         * previously known as global function setHiddenFromList()
         *
-        * @param selectFieldEl the select field
-        * @param originalFieldEl the hidden form field
+        * @param {HTMLElement} selectFieldEl the select field
+        * @param {HTMLElement} originalFieldEl the hidden form field
         */
        FormEngine.updateHiddenFieldValueFromSelect = setHiddenFromList = function(selectFieldEl, originalFieldEl) {
                var selectedValues = [];
@@ -196,7 +205,13 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
                $(originalFieldEl).val(selectedValues.join(','));
        };
 
-       // legacy function, can be removed once this function is not in use anymore
+       /**
+        * legacy function, can be removed once this function is not in use anymore
+        *
+        * @param {String} fName
+        * @param {String} type
+        * @param {Number} maxLength
+        */
        setFormValueManipulate = function(fName, type, maxLength) {
                var $formEl = FormEngine.getFormElement(fName);
                if ($formEl.length > 0) {
@@ -362,12 +377,12 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
 
 
        /**
-        * legacy function
+        * Legacy function
         * returns the DOM object for the given form name of the current form,
         * but only if the given field name is valid, legacy function, use "getFormElement" instead
         *
-        * @param fieldName the name of the field name
-        * @returns {*|DOMElement}
+        * @param {String} fieldName the name of the field name
+        * @returns {*|HTMLElement}
         */
        setFormValue_getFObj = function(fieldName) {
                var $formEl = FormEngine.getFormElement(fieldName);
@@ -384,7 +399,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
         * if the parameter "fieldName" is given, then the form element is only returned if the field name is available
         * the latter behaviour mirrors the one of the function "setFormValue_getFObj"
         *
-        * @param fieldName the field name to check for, optional
+        * @param {String} fieldName the field name to check for, optional
         * @returns {*|HTMLElement}
         */
        FormEngine.getFormElement = function(fieldName) {
@@ -412,12 +427,12 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
 
 
        /**
-        * returns a jQuery object of the field DOM element of the current form, can also be used to
+        * Returns a jQuery object of the field DOM element of the current form, can also be used to
         * request an alternative field like "_hr", "_list" or "_mul"
         *
-        * @param fieldName the name of the field (<input name="fieldName">)
-        * @param appendix optional
-        * @param noFallback if set, then the appendix value is returned no matter if it exists or not
+        * @param {String} fieldName the name of the field (<input name="fieldName">)
+        * @param {String} appendix optional
+        * @param {Boolean} noFallback if set, then the appendix value is returned no matter if it exists or not
         * @returns {*|HTMLElement}
         */
        FormEngine.getFieldElement = function(fieldName, appendix, noFallback) {
@@ -450,10 +465,10 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
         **************************************************/
 
        /**
-        * moves currently selected options from a select field to the very top,
+        * Moves currently selected options from a select field to the very top,
         * can be multiple entries as well
         *
-        * @param $fieldEl a jQuery object, containing the select field
+        * @param {Object} $fieldEl a jQuery object, containing the select field
         */
        FormEngine.moveOptionToTop = function($fieldEl) {
                // remove the selected options
@@ -467,7 +482,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
         * moves currently selected options from a select field up by one position,
         * can be multiple entries as well
         *
-        * @param $fieldEl a jQuery object, containing the select field
+        * @param {Object} $fieldEl a jQuery object, containing the select field
         */
        FormEngine.moveOptionUp = function($fieldEl) {
                // remove the selected options and add it before the previous sibling
@@ -489,7 +504,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
         * moves currently selected options from a select field down one position,
         * can be multiple entries as well
         *
-        * @param $fieldEl a jQuery object, containing the select field
+        * @param {Object} $fieldEl a jQuery object, containing the select field
         */
        FormEngine.moveOptionDown = function($fieldEl) {
                // remove the selected options and add it after the next sibling
@@ -514,7 +529,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
        /**
         * moves currently selected options from a select field as the very last entries
         *
-        * @param $fieldEl a jQuery object, containing the select field
+        * @param {Object} $fieldEl a jQuery object, containing the select field
         */
        FormEngine.moveOptionToBottom = function($fieldEl) {
                // remove the selected options
@@ -526,7 +541,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
        /**
         * removes currently selected options from a select field
         *
-        * @param $fieldEl a jQuery object, containing the select field
+        * @param {Object} $fieldEl a jQuery object, containing the select field
         */
        FormEngine.removeOption = function($fieldEl) {
                // remove the selected options
@@ -695,6 +710,9 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
 
        /**
         * Get the properties required for proper rendering of the character counter
+        *
+        * @param {Object} $field
+        * @returns {{remainingCharacters: number, labelClass: string}}
         */
        FormEngine.getCharacterCounterProperties = function($field) {
                var fieldText = $field.val(),
@@ -720,7 +738,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
        };
 
        /**
-        * select field filter functions, see TCA option "enableMultiSelectFilterTextfield"
+        * Select field filter functions, see TCA option "enableMultiSelectFilterTextfield"
         * and "multiSelectFilterItems"
         */
        FormEngine.SelectBoxFilter = {
@@ -734,7 +752,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
        };
 
        /**
-        * make sure that all selectors and input filters are recognized
+        * Make sure that all selectors and input filters are recognized
         * note: this also works on elements that are loaded asynchronously via AJAX, no need to call this method
         * after an AJAX load.
         */
@@ -749,7 +767,10 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
        };
 
        /**
-        * fetch the "itemstoselect" select element where a filter item is attached to
+        * Fetch the "itemstoselect" select element where a filter item is attached to
+        *
+        * @param {Object} $relativeElement
+        * @returns {*}
         */
        FormEngine.SelectBoxFilter.getSelectElement = function($relativeElement) {
                var $containerElement = $relativeElement.closest(FormEngine.SelectBoxFilter.options.fieldContainerSelector);
@@ -757,7 +778,10 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
        };
 
        /**
-        * filter the actual items
+        * Filter the actual items
+        *
+        * @param {Object} $selectElement
+        * @param {String} filterText
         */
        FormEngine.SelectBoxFilter.filter = function($selectElement, filterText) {
                var $allOptionElements;
index fa42808..1e47d6c 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/FormEngine/Element/SelectSingleElement
  * Logic for SelectSingleElement
  */
 define(['jquery'], function ($) {
 
+       /**
+        *
+        * @type {{}}
+        * @exports TYPO3/CMS/Backend/FormEngine/Element/SelectSingleElement
+        */
        var SelectSingleElement = {};
 
        /**
         * Initializes the SelectSingleEleemnt
+        *
+        * @param {String} selector
+        * @param {Object} options
         */
        SelectSingleElement.initialize = function(selector, options) {
 
index 894d82e..570311a 100644 (file)
  */
 
 /**
- * contains all JS functions related to TYPO3 Flexforms
+ * Module: TYPO3/CMS/Backend/FormEngineFlexForm
+ * Contains all JS functions related to TYPO3 Flexforms
  * available under the latest jQuery version
  * can be used by $('myflexform').t3FormEngineFlexFormElement({options});, all .t3-flex-form containers will be called on load
  *
  * currently TYPO3.FormEngine.FlexFormElement represents one Flexform element
  * which can contain one ore more sections
  */
-
 define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($) {
 
+       /**
+        *
+        * @param {HTMLElement} el
+        * @param {Object} options
+        * @constructor
+        * @exports TYPO3/CMS/Backend/FormEngineFlexForm
+        */
        TYPO3.FormEngine.FlexFormElement = function(el, options) {
                var me = this;  // avoid scope issues
                var opts;       // shorthand options notation
index ca116f9..3b3d007 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/FormEngineSuggest
  * Functionality to load suggest functionality
  */
 define(['jquery', 'jquery/autocomplete'], function ($) {
@@ -92,7 +93,8 @@ define(['jquery', 'jquery/autocomplete'], function ($) {
        };
 
        /**
-        * return a function that gets DOM elements that are checked if suggest is already initialized
+        * Return a function that gets DOM elements that are checked if suggest is already initialized
+        * @exports TYPO3/CMS/Backend/FormEngineSuggest
         */
        return function(selectorElements) {
                $(selectorElements).each(function(key, el) {
index 623e73d..9cc55e2 100644 (file)
@@ -12,7 +12,8 @@
  */
 
 /**
- * contains all JS functions related to TYPO3 TCEforms/FormEngineValidation
+ * Module: TYPO3/CMS/Backend/FormEngineValidation
+ * Contains all JS functions related to TYPO3 TCEforms/FormEngineValidation
  * @internal
  */
 define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
@@ -21,6 +22,7 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
         * The main FormEngineValidation object
         *
         * @type {{rulesSelector: string, inputSelector: string, markerSelector: string, dateTimeSelector: string, groupFieldHiddenElement: string, relatedFieldSelector: string, errorClass: string, lastYear: number, lastDate: number, lastTime: number, refDate: Date, USmode: number, passwordDummy: string}}
+        * @exports TYPO3/CMS/Backend/FormEngineValidation
         */
        var FormEngineValidation = {
                rulesSelector: '[data-formengine-validation-rules]',
@@ -76,9 +78,9 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        };
 
        /**
-        * initialize all input fields
+        * Initialize all input fields
         *
-        * @returns {*|jQuery}
+        * @returns {Object}
         */
        FormEngineValidation.initializeInputFields = function() {
                return $(document).find(FormEngineValidation.inputSelector).each(function() {
@@ -97,7 +99,7 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
 
        /**
         *
-        * @param {number} mode
+        * @param {Number} mode
         */
        FormEngineValidation.setUsMode = function(mode) {
                FormEngineValidation.USmode = mode;
@@ -106,7 +108,7 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         * Initialize field by name
         *
-        * @param {string} fieldName
+        * @param {String} fieldName
         */
        FormEngineValidation.initializeInputField = function(fieldName) {
                var $field = $('[name="' + fieldName + '"]');
@@ -141,10 +143,10 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         * Format field value
         *
-        * @param {string} type
-        * @param {string} value
+        * @param {String} type
+        * @param {String} value
         * @param {array} config
-        * @returns {string}
+        * @returns {String}
         */
        FormEngineValidation.formatValue = function(type, value, config) {
                var theString = '';
@@ -189,7 +191,7 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         * Update input field after change
         *
-        * @param {string} fieldName
+        * @param {String} fieldName
         */
        FormEngineValidation.updateInputField = function(fieldName) {
                var $field = $('[name="' + fieldName + '"]');
@@ -228,9 +230,9 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         * Run validation for field
         *
-        * @param {object} $field
-        * @param {string=} [value=$field.val()]
-        * @returns {string}
+        * @param {Object} $field
+        * @param {String} [value=$field.val()]
+        * @returns {String}
         */
        FormEngineValidation.validateField = function($field, value) {
                value = value || FormEngineValidation.ltrim($field.val());
@@ -328,10 +330,10 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         * Process a value by given command and config
         *
-        * @param {string} command
-        * @param {string} value
-        * @param {array} config
-        * @returns {string}
+        * @param {String} command
+        * @param {String} value
+        * @param {Array} config
+        * @returns {String}
         */
        FormEngineValidation.processValue = function(command, value, config) {
                var newString = '';
@@ -480,6 +482,9 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
 
        /**
         * Set the caret position in a text field
+        *
+        * @param {Object} $element
+        * @param {Number} caretPos
         */
        FormEngineValidation.setCaretPosition = function($element, caretPos) {
                var elem = $element.get(0);
@@ -501,8 +506,8 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         * Helper function to get clean trimmed array from comma list
         *
-        * @param {string} delimiter
-        * @param {string} string
+        * @param {String} delimiter
+        * @param {String} string
         * @returns {Array}
         */
        FormEngineValidation.trimExplode = function(delimiter, string) {
@@ -520,8 +525,8 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         * Parse value to integer
         *
-        * @param {(number|string)} value
-        * @returns {number}
+        * @param {(Number|String)} value
+        * @returns {Number}
         */
        FormEngineValidation.parseInt = function(value) {
                var theVal = '' + value;
@@ -539,8 +544,8 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         * Parse value to double
         *
-        * @param {string} value
-        * @returns {string}
+        * @param {String} value
+        * @returns {String}
         */
        FormEngineValidation.parseDouble = function(value) {
                var theVal = '' + value;
@@ -564,8 +569,8 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
 
        /**
         *
-        * @param {string} value
-        * @returns {string}
+        * @param {String} value
+        * @returns {String}
         */
        FormEngineValidation.ltrim = function(value) {
                var theVal = '' + value;
@@ -582,8 +587,8 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
 
        /**
         *
-        * @param {string} value
-        * @returns {string}
+        * @param {String} value
+        * @returns {String}
         */
        FormEngineValidation.btrim = function(value) {
                var theVal = '' + value;
@@ -601,8 +606,8 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         * Parse datetime value
         *
-        * @param {string} value
-        * @param {string} command
+        * @param {String} value
+        * @param {String} command
         * @returns {*}
         */
        FormEngineValidation.parseDateTime = function(value, command) {
@@ -646,8 +651,8 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         * Parse date value
         *
-        * @param {string} value
-        * @param {string} command
+        * @param {String} value
+        * @param {String} command
         * @returns {*}
         */
        FormEngineValidation.parseDate = function(value, command) {
@@ -707,9 +712,9 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         * Parse time value
         *
-        * @param {string} value
-        * @param {string} command
-        * @param {string} type
+        * @param {String} value
+        * @param {String} command
+        * @param {String} type
         * @returns {*}
         */
        FormEngineValidation.parseTime = function(value, command, type) {
@@ -774,8 +779,8 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         * Parse year value
         *
-        * @param {string} value
-        * @param {string} command
+        * @param {String} value
+        * @param {String} command
         * @returns {*}
         */
        FormEngineValidation.parseYear = function(value, command) {
@@ -832,7 +837,7 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
         * Get date as timestamp from Date object
         *
         * @param {Date} timeObj
-        * @returns {number}
+        * @returns {Number}
         */
        FormEngineValidation.getDate = function(timeObj) {
                var theTime = new Date(FormEngineValidation.getYear(timeObj), timeObj.getUTCMonth(), timeObj.getUTCDate());
@@ -841,8 +846,8 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
 
        /**
         *
-        * @param {string} foreign
-        * @param {string} value
+        * @param {String} foreign
+        * @param {String} value
         * @returns {Object}
         */
        FormEngineValidation.pol = function(foreign, value) {
@@ -852,8 +857,8 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         * Substract timezone offset from client to a timestamp to get UTC-timestamp to be send to server
         *
-        * @param {number} timestamp
-        * @param {number} timeonly
+        * @param {Number} timestamp
+        * @param {Number} timeonly
         * @returns {*}
         */
        FormEngineValidation.convertClientTimestampToUTC = function(timestamp, timeonly) {
@@ -871,8 +876,8 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         * Parse date string or object and return unix timestamp
         *
-        * @param {(string|Date)} timeObj
-        * @returns {number}
+        * @param {(String|Date)} timeObj
+        * @returns {Number}
         */
        FormEngineValidation.getTimestamp = function(timeObj) {
                return Date.parse(timeObj)/1000;
@@ -891,7 +896,7 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         *
         * @param timeObj
-        * @returns {number}
+        * @returns {Number}
         */
        FormEngineValidation.getSecs = function(timeObj) {
                return timeObj.getUTCSeconds();
@@ -900,7 +905,7 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         *
         * @param timeObj
-        * @returns {number}
+        * @returns {Number}
         */
        FormEngineValidation.getTimeSecs = function(timeObj) {
                return timeObj.getHours() * 60 * 60 + timeObj.getMinutes() * 60 + timeObj.getSeconds();
@@ -909,7 +914,7 @@ define(['jquery', 'TYPO3/CMS/Backend/FormEngine'], function ($, FormEngine) {
        /**
         * Find tab by field and mark it as has-validation-error
         *
-        * @param {object} $element
+        * @param {Object} $element
         */
        FormEngineValidation.markParentTab = function($element) {
                var $panes = $element.parents('.tab-pane');
index 4867fdf..bc92203 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/Icons
  * Uses the icon API of the core to fetch icons via AJAX.
  */
 define(['jquery'], function($) {
        'use strict';
 
+       /**
+        *
+        * @type {{cache: {}, sizes: {small: string, default: string, large: string, overlay: string}, states: {default: string, disabled: string}}}
+        * @exports TYPO3/CMS/Backend/Icons
+        */
        var Icons = {
                cache: {},
                sizes: {
@@ -34,10 +40,10 @@ define(['jquery'], function($) {
        /**
         * Get the icon by its identifier.
         *
-        * @param {string} identifier
-        * @param {string} size
-        * @param {string} overlayIdentifier
-        * @param {string} state
+        * @param {String} identifier
+        * @param {String} size
+        * @param {String} overlayIdentifier
+        * @param {String} state
         * @return {Promise<Array>}
         */
        Icons.getIcon = function(identifier, size, overlayIdentifier, state) {
index 543cbea..24177c3 100644 (file)
  */
 
 /**
- * contains all logic for the image crop GUI
+ * Module: TYPO3/CMS/Backend/ImageManipulation
+ * Contains all logic for the image crop GUI
  */
 define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
 
+       /**
+        *
+        * @type {{margin: number, currentModal: null, cropperSelector: string, $trigger: null}}
+        * @exports TYPO3/CMS/Backend/ImageManipulation
+        */
        var ImageManipulation = {
                margin: 20,
                currentModal: null,
@@ -23,7 +29,6 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
                $trigger: null
        };
 
-
        /**
         * Initialize triggers
         */
@@ -38,7 +43,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
        /**
         * Functions that should be bind to the trigger button
         *
-        * @param e click event
+        * @param {Event} e click event
         */
        ImageManipulation.buttonClick = function(e) {
                e.preventDefault();
@@ -176,7 +181,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
        /**
         * Get image to be cropped
         *
-        * @returns jQuery object
+        * @returns {Object} jQuery object
         */
        ImageManipulation.getCropper = function() {
                return ImageManipulation.currentModal.find(ImageManipulation.cropperSelector);
@@ -199,7 +204,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
        /**
         * Change the aspect ratio of the crop box
         *
-        * @param aspectRatio Number
+        * @param {Number} aspectRatio
         */
        ImageManipulation.setAspectRatio = function(aspectRatio) {
                var $cropper = ImageManipulation.getCropper();
@@ -212,7 +217,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
         * Zoom in: requires a positive number (ratio > 0)
         * Zoom out: requires a negative number (ratio < 0)
         *
-        * @param ratio Number
+        * @param {Number} ratio
         */
        ImageManipulation.zoom = function(ratio) {
                var $cropper = ImageManipulation.getCropper();
index 3799284..7d26a4a 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/LayoutModule/DragDrop
  * this JS code does the drag+drop logic for the Layout module (Web => Page)
  * based on jQuery UI
  */
 define(['jquery', 'jquery-ui/sortable'], function ($) {
        'use strict';
 
+       /**
+        *
+        * @type {{contentIdentifier: string, dragIdentifier: string, dropZoneAvailableIdentifier: string, dropPossibleClass: string, sortableItemsIdentifier: string, columnIdentifier: string, columnHolderIdentifier: string, addContentIdentifier: string, langClassPrefix: string}}
+        * @exports TYPO3/CMS/Backend/LayoutModule/DragDrop
+        */
        var DragDrop = {
                contentIdentifier: '.t3js-page-ce',
                dragIdentifier: '.t3js-page-ce-draghandle',
@@ -67,6 +73,9 @@ define(['jquery', 'jquery-ui/sortable'], function ($) {
 
        /**
         * Called when an item is about to be moved
+        *
+        * @param {Object} $container
+        * @param {Object} ui
         */
        DragDrop.onSortStart = function($container, ui) {
                var $item = $(ui.item),
@@ -83,6 +92,9 @@ define(['jquery', 'jquery-ui/sortable'], function ($) {
 
        /**
         * Called when the sorting stopped
+        *
+        * @param {Object} $container
+        * @param {Object} ui
         */
        DragDrop.onSortStop = function($container, ui) {
                var $allColumns = $container.parents(DragDrop.columnHolderIdentifier);
@@ -92,12 +104,20 @@ define(['jquery', 'jquery-ui/sortable'], function ($) {
 
        /**
         * Called when the index of the element in the sortable list has changed
+        *
+        * @param {Object} $container
+        * @param {Object} ui
         */
        DragDrop.onSortChange = function($container, ui) {
                var $placeholder = $(ui.placeholder);
                DragDrop.changeDropzoneVisibility($container, $placeholder);
        };
 
+       /**
+        *
+        * @param {Object} $container
+        * @param {Object} $subject
+        */
        DragDrop.changeDropzoneVisibility = function($container, $subject) {
                var $prev = $subject.prev(':visible'),
                        droppableClassName = DragDrop.langClassPrefix + $container.data('language-uid');
@@ -111,6 +131,9 @@ define(['jquery', 'jquery-ui/sortable'], function ($) {
 
        /**
         * Called when the new position of the element gets stored
+        *
+        * @param {Object} $container
+        * @param {Object} ui
         */
        DragDrop.onSortUpdate = function($container, ui) {
                var $selectedItem = $(ui.item),
index 7e0b171..8302cf1 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/LegacyCssClasses
  * JavaScript replacement for Legacy CSS Classes
  */
 define(['jquery'], function($) {
        'use strict';
 
+       /**
+        *
+        * @type {{replacements: Array}}
+        * @exports TYPO3/CMS/Backend/LegacyCssClasses
+        */
        var LegacyCssClasses = {
                replacements: [
                        {
index e2b005f..76c227b 100644 (file)
  * The TYPO3 project - inspiring people to share!
  */
 
+var Tree, DragDrop;
+
 /**
+ * Module: TYPO3/CMS/Backend/LegacyTree
  * JavaScript RequireJS module in use for legacy trees, used
  * in FolderTree, Element Browser PageTree and
  * Element Browser FolderTree
  * note that this should not be used (thus, declared as anonymous
  * UMD module)
+ * @exports TYPO3/CMS/Backend/LegacyTree
  */
-var Tree, DragDrop;
 define(['jquery'], function($) {
 
        DragDrop = {
index e9953bd..223b5ba 100644 (file)
@@ -12,7 +12,9 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/LiveSearch
  * Global search to deal with everything in the backend that is search-related
+ * @exports TYPO3/CMS/Backend/LiveSearch
  */
 define(['jquery', 'jquery/autocomplete', 'TYPO3/CMS/Backend/jquery.clearable'], function ($) {
        'use strict';
index b5275de..d89a5c8 100755 (executable)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/Login
  * JavaScript module for the backend login form
  */
 define(['jquery', 'TYPO3/CMS/Backend/jquery.clearable', 'bootstrap'], function($) {
        'use strict';
 
+       /**
+        *
+        * @type {{options: {loginForm: string, interfaceField: string, useridentField: string, submitButton: string, error: string, errorNoCookies: string, formFields: string, submitHandler: null}}}
+        * @exports TYPO3/CMS/Backend/Login
+        */
        var BackendLogin = {
                options: {
                        loginForm: '#typo3-login-form',
@@ -43,7 +49,7 @@ define(['jquery', 'TYPO3/CMS/Backend/jquery.clearable', 'bootstrap'], function($
        /**
         * Pass on to registered submit handler
         *
-        * @param event
+        * @param {Event} event
         */
        BackendLogin.handleSubmit = function(event) {
                BackendLogin.showLoginProcess();
index 9a7bcee..086470b 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/LoginRefresh
  * Task that periodically checks if a blocking event in the backend occurred and
  * displays a proper dialog to the user.
  */
 define(['jquery', 'bootstrap'], function($) {
+       /**
+        *
+        * @type {{identifier: {loginrefresh: string, lockedModal: string, loginFormModal: string}, options: {modalConfig: {backdrop: string}}, webNotification: null, intervalId: null, backendIsLocked: boolean, isTimingOut: boolean, $timeoutModal: string, $backendLockedModal: string, $loginForm: string, loginFramesetUrl: string, logoutUrl: string}}
+        * @exports TYPO3/CMS/Backend/LoginRefresh
+        */
        var LoginRefresh = {
                identifier: {
                        loginrefresh: 't3-modal-loginrefresh',
@@ -61,6 +67,9 @@ define(['jquery', 'bootstrap'], function($) {
 
        /**
         * Generates a modal dialog as template.
+        *
+        * @param {String} identifier
+        * @returns {Object}
         */
        LoginRefresh.generateModal = function(identifier) {
                return TYPO3.jQuery('<div />', {id: identifier, class: 't3-modal t3-blr-modal ' + identifier + ' modal fade'}).append(
@@ -78,6 +87,8 @@ define(['jquery', 'bootstrap'], function($) {
 
        /**
         * Set logout url
+        *
+        * @param {String} logoutUrl
         */
        LoginRefresh.setLogoutUrl = function(logoutUrl) {
                LoginRefresh.logoutUrl = logoutUrl;
@@ -296,6 +307,8 @@ define(['jquery', 'bootstrap'], function($) {
        /**
         * Creates additional data based on the security level and "submits" the form
         * via an AJAX request.
+        *
+        * @param {Event} event
         */
        LoginRefresh.submitForm = function(event) {
                event.preventDefault();
@@ -345,6 +358,9 @@ define(['jquery', 'bootstrap'], function($) {
         * the interval check starts again.
         * This method is not invoked for the backend locked modal, because we still
         * need to check if the backend gets unlocked again.
+        *
+        * @param {Object} $modal
+        * @returns {Object}
         */
        LoginRefresh.registerDefaultModalEvents = function($modal) {
                $modal.on('hidden.bs.modal', function() {
index 5a5697f..868112f 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/Modal
  * API for modal windows powered by Twitter Bootstrap.
  * This module depends on TYPO3/CMS/Backend/Notification due to top.TYPO3.Severity.
  */
@@ -32,6 +33,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Notification', 'bootstrap'], function($) {
         * The main object of the modal API
         *
         * @type {{instances: Array, currentModal: null, template: (*|jQuery|HTMLElement)}}
+        * @exports TYPO3/CMS/Backend/Modal
         */
        var Modal = {
                instances: [],
@@ -59,7 +61,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Notification', 'bootstrap'], function($) {
         * Get the correct css class for given severity
         *
         * @param {int} severity use constants from top.TYPO3.Severity.*
-        * @returns {string}
+        * @returns {String}
         * @private
         */
        Modal.getSeverityClass = function(severity) {
@@ -92,8 +94,8 @@ define(['jquery', 'TYPO3/CMS/Backend/Notification', 'bootstrap'], function($) {
         * - confirm.button.cancel
         * - confirm.button.ok
         *
-        * @param {string} title the title for the confirm modal
-        * @param {string} content the content for the conform modal, e.g. the main question
+        * @param {String} title the title for the confirm modal
+        * @param {String} content the content for the conform modal, e.g. the main question
         * @param {int} severity default top.TYPO3.Severity.warning
         * @param {array} buttons an array with buttons, default no buttons
         * @param {array} additionalCssClasses additional css classes to add to the modal
@@ -129,11 +131,11 @@ define(['jquery', 'TYPO3/CMS/Backend/Notification', 'bootstrap'], function($) {
         * load URL with AJAX, append the content to the modal-body
         * and trigger the callback
         *
-        * @param {string} title
+        * @param {String} title
         * @param {int} severity
         * @param {array} buttons
-        * @param {string} url
-        * @param {string} target
+        * @param {String} url
+        * @param {String} target
         * @param {function} callback
         */
        Modal.loadUrl = function(title, severity, buttons, url, callback, target) {
@@ -153,8 +155,8 @@ define(['jquery', 'TYPO3/CMS/Backend/Notification', 'bootstrap'], function($) {
         * Events:
         * - button.clicked
         *
-        * @param {string} title the title for the confirm modal
-        * @param {string} content the content for the conform modal, e.g. the main question
+        * @param {String} title the title for the confirm modal
+        * @param {String} content the content for the conform modal, e.g. the main question
         * @param {int} severity default top.TYPO3.Severity.info
         * @param {array} buttons an array with buttons, default no buttons
         * @param {array} additionalCssClasses additional css classes to add to the modal
index 8aa9ecc..42e2515 100644 (file)
@@ -12,9 +12,9 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/Notification
  * Notification API for the TYPO3 backend
  */
-
 define(['jquery'], function ($) {
        'use strict';
 
@@ -22,6 +22,7 @@ define(['jquery'], function ($) {
         * Severity object
         *
         * @type {{notice: number, information: number, info: number, ok: number, warning: number, error: number}}
+        * @exports TYPO3/CMS/Backend/Severity
         */
        var Severity = {
                notice: -2,
@@ -37,6 +38,7 @@ define(['jquery'], function ($) {
         * The main Notification object
         *
         * @type {{NOTICE: number, INFO: number, OK: number, WARNING: number, ERROR: number, messageContainer: null}}
+        * @exports TYPO3/CMS/Backend/Notification
         */
        var Notification = {
                NOTICE: -2,
@@ -50,8 +52,8 @@ define(['jquery'], function ($) {
        /**
         * Show a notice notification
         *
-        * @param {string} title The title for the notification
-        * @param {string} message The message for the notification
+        * @param {String} title The title for the notification
+        * @param {String} message The message for the notification
         * @param {float} duration Time in seconds to show notification before it disappears, default 5, 0 = sticky
         *
         * @public
@@ -63,8 +65,8 @@ define(['jquery'], function ($) {
        /**
         * Show an info notification
         *
-        * @param {string} title The title for the notification
-        * @param {string} message The message for the notification
+        * @param {String} title The title for the notification
+        * @param {String} message The message for the notification
         * @param {float} duration Time in seconds to show notification before it disappears, default 5, 0 = sticky
         *
         * @public
@@ -76,8 +78,8 @@ define(['jquery'], function ($) {
        /**
         * Show an ok notification
         *
-        * @param {string} title The title for the notification
-        * @param {string} message The message for the notification
+        * @param {String} title The title for the notification
+        * @param {String} message The message for the notification
         * @param {float} duration Time in seconds to show notification before it disappears, default 5, 0 = sticky
         *
         * @public
@@ -89,8 +91,8 @@ define(['jquery'], function ($) {
        /**
         * Show a warning notification
         *
-        * @param {string} title The title for the notification
-        * @param {string} message The message for the notification
+        * @param {String} title The title for the notification
+        * @param {String} message The message for the notification
         * @param {float} duration Time in seconds to show notification before it disappears, default 5, 0 = sticky
         *
         * @public
@@ -101,9 +103,9 @@ define(['jquery'], function ($) {
 
        /**
         * Show an error notification
-        *, duration
-        * @param {string} title The title for the notification
-        * @param {string} message The message for the notification
+        *
+        * @param {String} title The title for the notification
+        * @param {String} message The message for the notification
         * @param {float} duration Time in seconds to show notification before it disappears, default 0, 0 = sticky
         *
         * @public
@@ -116,8 +118,8 @@ define(['jquery'], function ($) {
        /**
         * Show message
         *
-        * @param {string} title The title for the notification
-        * @param {string} message The message for the notification
+        * @param {String} title The title for the notification
+        * @param {String} message The message for the notification
         * @param {int} severity See constants in this object
         * @param {float} duration Time in seconds to show notification before it disappears, default 5, 0 = sticky
         *
index 75d3472..d427fb5 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/OnlineMedia
  * Javascript for show the online media dialog
  */
 define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Lang/Lang'], function($, NProgress, Modal) {
        'use strict';
 
+       /**
+        *
+        * @param element
+        * @constructor
+        * @exports TYPO3/CMS/Backend/OnlineMedia
+        */
        var OnlineMediaPlugin = function(element) {
                var me = this;
                me.$btn = $(element);
@@ -26,6 +33,10 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Lang/Lang']
                me.btnSubmit = me.$btn.data('data-btn-submit') || 'Add';
                me.placeholder = me.$btn.data('placeholder') || 'Paste media url here...';
 
+               /**
+                *
+                * @param {String} url
+                */
                me.addOnlineMedia = function(url) {
                        NProgress.start();
                        $.post(TYPO3.settings.ajaxUrls['online_media_create'],
@@ -62,6 +73,9 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Lang/Lang']
                        );
                };
 
+               /**
+                * Trigger the modal
+                */
                me.triggerModal = function() {
                        var $modal = Modal.show(
                                me.$btn.attr('title'),
index f138c31..97cc2a5 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/PageActions
  * JavaScript implementations for page actions
  */
 define(['jquery', 'TYPO3/CMS/Backend/Storage'], function($, Storage) {
        'use strict';
 
+       /**
+        *
+        * @type {{settings: {pageId: number, canEditPage: boolean, language: {pageOverlayId: number}}, identifier: {pageTitle: string, hiddenElements: string}, elements: {$pageTitle: null, $showHiddenElementsCheckbox: null}, documentIsReady: boolean}}
+        * @exports TYPO3/CMS/Backend/PageActions
+        */
        var PageActions = {
                settings: {
                        pageId: 0,
@@ -62,6 +68,9 @@ define(['jquery', 'TYPO3/CMS/Backend/Storage'], function($, Storage) {
                        .append($editActionLink);
        };
 
+       /**
+        * Initialize elements
+        */
        PageActions.initializeElements = function() {
                PageActions.elements.$pageTitle = $(PageActions.identifier.pageTitle + ':first');
                PageActions.elements.$showHiddenElementsCheckbox = $('#checkTt_content_showHidden');
@@ -157,6 +166,8 @@ define(['jquery', 'TYPO3/CMS/Backend/Storage'], function($, Storage) {
 
        /**
         * Set the page id (used in the RequireJS callback)
+        *
+        * @param {Number} pageId
         */
        PageActions.setPageId = function(pageId) {
                PageActions.settings.pageId = pageId;
@@ -164,6 +175,8 @@ define(['jquery', 'TYPO3/CMS/Backend/Storage'], function($, Storage) {
 
        /**
         * Set if user can edit the page properties
+        *
+        * @param {Boolean} allowed
         */
        PageActions.setCanEditPage = function(allowed) {
                PageActions.settings.canEditPage = allowed;
@@ -171,6 +184,8 @@ define(['jquery', 'TYPO3/CMS/Backend/Storage'], function($, Storage) {
 
        /**
         * Set the overlay id
+        *
+        * @param {Number} overlayId
         */
        PageActions.setLanguageOverlayId = function(overlayId) {
                PageActions.settings.language.pageOverlayId = overlayId;
@@ -178,6 +193,8 @@ define(['jquery', 'TYPO3/CMS/Backend/Storage'], function($, Storage) {
 
        /**
         * Save the changes and reload the page tree
+        *
+        * @param {Object} $field
         */
        PageActions.saveChanges = function($field) {
                var $inputFieldWrap = $field.parents('form');
index caf5488..e06c2e4 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/Popover
  * API for popover windows powered by Twitter Bootstrap.
  */
 define(['jquery', 'bootstrap'], function($) {
@@ -20,6 +21,7 @@ define(['jquery', 'bootstrap'], function($) {
         * the main popover object
         *
         * @type {{}}
+        * @exports TYPO3/CMS/Backend/Popover
         */
        var Popover = {
        };
@@ -33,9 +35,9 @@ define(['jquery', 'bootstrap'], function($) {
        };
 
        /**
-        * popover wrapper function
+        * Popover wrapper function
         *
-        * @param $element
+        * @param {Object} $element
         */
        Popover.popover = function($element) {
                $element.popover();
@@ -44,8 +46,8 @@ define(['jquery', 'bootstrap'], function($) {
        /**
         * Set popover options on $element
         *
-        * @param {object} $element
-        * @param {object} options
+        * @param {Object} $element
+        * @param {Object} options
         */
        Popover.setOptions = function($element, options) {
                options = options || {};
@@ -61,7 +63,7 @@ define(['jquery', 'bootstrap'], function($) {
        /**
         * Show popover with title and content on $element
         *
-        * @param {object} $element
+        * @param {Object} $element
         */
        Popover.show = function($element) {
                $element.popover('show');
@@ -70,7 +72,7 @@ define(['jquery', 'bootstrap'], function($) {
        /**
         * Hide popover on $element
         *
-        * @param $element
+        * @param {Object} $element
         */
        Popover.hide = function($element) {
                $element.popover('hide');
@@ -79,7 +81,7 @@ define(['jquery', 'bootstrap'], function($) {
        /**
         * Destroy popover on $element
         *
-        * @param $element
+        * @param {Object} $element
         */
        Popover.destroy = function($element) {
                $element.popover('destroy');
@@ -88,7 +90,7 @@ define(['jquery', 'bootstrap'], function($) {
        /**
         * Toggle popover on $element
         *
-        * @param $element
+        * @param {Object} $element
         */
        Popover.toggle = function($element) {
                $element.popover('toggle');
index bafca14..79e23a1 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/SplitButtons
  * Initializes global handling of split buttons.
  */
 define(['jquery'], function($) {
        'use strict';
 
+       /**
+        *
+        * @type {{preSubmitCallbacks: Array}}
+        * @exports TYPO3/CMS/Backend/SplitButtons
+        */
        var SplitButtons = {
                preSubmitCallbacks: []
        };
@@ -55,7 +61,7 @@ define(['jquery'], function($) {
        /**
         * Adds a callback being executed before submit
         *
-        * @param callback
+        * @param {function} callback
         */
        SplitButtons.addPreSubmitCallback = function(callback) {
                if (typeof callback !== 'function') {
index 979bb9d..3c1858f 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/Storage
  * Adds a public API for the browsers' localStorage called
  * TYPO3.Storage.Client and the Backend Users "uc",
  * available via TYPO3.Storage.Persistent
@@ -35,6 +36,11 @@ define(['jquery'], function ($) {
        }
 
        // we didn't find an existing object, so create it
+       /**
+        *
+        * @type {{Client: {}, Persistent: {_data: boolean}}}
+        * @exports TYPO3/CMS/Backend/Storage
+        */
        var Storage = {
                Client: {},
                Persistent: {
@@ -43,19 +49,34 @@ define(['jquery'], function ($) {
        };
 
        /**
-        * simple localStorage wrapper, common functions get/set/clear
+        * Simple localStorage wrapper, to get value from localStorage
+        * @param {String} key
         */
        Storage.Client.get = function(key) {
                return localStorage.getItem('t3-' + key);
        };
+
+       /**
+        * Simple localStorage wrapper, to set value from localStorage
+        * @param {String} key
+        * @param {String} value
+        */
        Storage.Client.set = function(key, value) {
                return localStorage.setItem('t3-' + key, value);
        };
+
+       /**
+        * Simple localStorage wrapper, to clear localStorage
+        */
        Storage.Client.clear = function() {
                localStorage.clear();
        };
+
        /**
-        * checks if a key was set before, useful to not do all the undefined checks all the time
+        * Checks if a key was set before, useful to not do all the undefined checks all the time
+        *
+        * @param {String} key
+        * @returns {Boolean}
         */
        Storage.Client.isset = function(key) {
                var value = this.get(key);
@@ -63,9 +84,11 @@ define(['jquery'], function ($) {
        };
 
        /**
-        * persistent storage, stores everything on the server
-        * via AJAX, does a greedy load on read
+        * Persistent storage, stores everything on the server via AJAX, does a greedy load on read
         * common functions get/set/clear
+        *
+        * @param {String} key
+        * @returns {*}
         */
        Storage.Persistent.get = function(key) {
                if (this._data === false) {
@@ -79,6 +102,13 @@ define(['jquery'], function ($) {
                }
        };
 
+       /**
+        * Store data persistent on server
+        *
+        * @param {String} key
+        * @param {String} value
+        * @returns {jQuery}
+        */
        Storage.Persistent.set = function(key, value) {
                if (this._data !== false) {
                        this._data = this._setRecursiveDataByDeepKey(this._data, key.split('.'), value);
@@ -86,31 +116,54 @@ define(['jquery'], function ($) {
                return this._storeOnServer(key, value);
        };
 
+       /**
+        *
+        * @param {String} key
+        * @param {String} value
+        * @returns {*}
+        */
        Storage.Persistent.addToList = function(key, value) {
                return $.ajax(TYPO3.settings.ajaxUrls['usersettings_process'], {data: {'action': 'addToList', key: key, value: value}}).done(function(data) {
                        Storage.Persistent._data = data;
                });
        };
 
+       /**
+        *
+        * @param {String} key
+        * @param {String} value
+        * @returns {*}
+        */
        Storage.Persistent.removeFromList = function(key, value) {
                return $.ajax(TYPO3.settings.ajaxUrls['usersettings_process'], {data: {'action': 'removeFromList', key: key, value: value}}).done(function(data) {
                        Storage.Persistent._data = data;
                });
        };
 
+       /**
+        *
+        * @param {String} key
+        * @returns {*}
+        */
        Storage.Persistent.unset = function(key) {
                return $.ajax(TYPO3.settings.ajaxUrls['usersettings_process'], {data: {'action': 'unset', key: key}}).done(function(data) {
                        Storage.Persistent._data = data;
                });
        };
 
+       /**
+        *
+        */
        Storage.Persistent.clear = function() {
                $.ajax(TYPO3.settings.ajaxUrls['usersettings_process'], {data: {'action': 'clear'}});
                this._data = false;
        };
 
        /**
-        * checks if a key was set before, useful to not do all the undefined checks all the time
+        * Checks if a key was set before, useful to not do all the undefined checks all the time
+        *
+        * @param {String} key
+        * @returns {Boolean}
         */
        Storage.Persistent.isset = function(key) {
                var value = this.get(key);
@@ -118,16 +171,18 @@ define(['jquery'], function ($) {
        };
 
        /**
-        * loads the data from outside, only used for the initial call from BackendController
-        * @param data
+        * Loads the data from outside, only used for the initial call from BackendController
+        *
+        * @param {String} data
         */
        Storage.Persistent.load = function(data) {
                this._data = data;
        };
 
        /**
-        * loads all data from the server
-        * @returns jQuery Deferred
+        * Loads all data from the server
+        *
+        * @returns {*}
         * @private
         */
        Storage.Persistent._loadFromServer = function() {
@@ -137,9 +192,12 @@ define(['jquery'], function ($) {
        };
 
        /**
-        * stores data on the server, and gets the updated data on return
+        * Stores data on the server, and gets the updated data on return
         * to always be up-to-date inside the browser
-        * @returns jQuery Deferred
+        *
+        * @param {String} key
+        * @param {String} value
+        * @returns {*}
         * @private
         */
        Storage.Persistent._storeOnServer = function(key, value) {
@@ -153,10 +211,10 @@ define(['jquery'], function ($) {
         * data[my][foo][bar]
         * is called recursively by itself
         *
-        * @param data the data to be uased as base
-        * @param keyParts the keyParts for the subtree
-        * @param value the value to be set
-        * @returns the data object
+        * @param {Object} data the data to be uased as base
+        * @param {String} keyParts the keyParts for the subtree
+        * @param {String} value the value to be set
+        * @returns {Object} the data object
         * @private
         */
        Storage.Persistent._setRecursiveDataByDeepKey = function(data, keyParts, value) {
@@ -171,13 +229,12 @@ define(['jquery'], function ($) {
        };
 
        /**
-        * helper function used to set a value which could have been a flat object key data["my.foo.bar"] to
-        * data[my][foo][bar]
-        * is called recursively by itself
+        * Helper function used to set a value which could have been a flat object key data["my.foo.bar"] to
+        * data[my][foo][bar] is called recursively by itself
         *
-        * @param data the data to be uased as base
-        * @param keyParts the keyParts for the subtree
-        * @returns {*}
+        * @param {Object} data the data to be uased as base
+        * @param {String} keyParts the keyParts for the subtree
+        * @returns {Object}
         * @private
         */
        Storage.Persistent._getRecursiveDataByDeepKey = function(data, keyParts) {
index d50592a..ae18f2f 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/Tabs
  * This class handle the tabs in the TYPO3 backend.
  * It stores the last active tab and open it again after a reload,
  */
@@ -22,6 +23,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Storage', 'bootstrap'], function ($, Storag
         * Tabs helper
         *
         * @type {{storage: (Storage.Client|*), cacheTimeInSeconds: number, storeLastActiveTab: bool}}
+        * @exports TYPO3/CMS/Backend/Tabs
         */
        var Tabs = {
                storage: Storage.Client,
@@ -31,10 +33,10 @@ define(['jquery', 'TYPO3/CMS/Backend/Storage', 'bootstrap'], function ($, Storag
        };
 
        /**
-        * receive active tab from storage
+        * Receive active tab from storage
         *
-        * @param id
-        * @returns {string}
+        * @param {String} id
+        * @returns {String}
         */
        Tabs.receiveActiveTab = function(id) {
                var target = Tabs.storage.get(id) || '';
@@ -46,10 +48,10 @@ define(['jquery', 'TYPO3/CMS/Backend/Storage', 'bootstrap'], function ($, Storag
        };
 
        /**
-        * store active tab in storage
+        * Store active tab in storage
         *
-        * @param id
-        * @param target
+        * @param {String} id
+        * @param {String} target
         */
        Tabs.storeActiveTab = function(id, target) {
                Tabs.storage.set(id, target);
@@ -57,9 +59,9 @@ define(['jquery', 'TYPO3/CMS/Backend/Storage', 'bootstrap'], function ($, Storag
        };
 
        /**
-        * get unixtimestamp
+        * Get unixtimestamp
         *
-        * @returns {number}
+        * @returns {Number}
         */
        Tabs.getTimestamp = function() {
                return Math.round((new Date()).getTime() / 1000);
index 09bcd11..f5ce431 100644 (file)
@@ -12,7 +12,9 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/ToggleSearchToolbox
  * Toggle the search toolbox
+ * @exports TYPO3/CMS/Backend/ToggleSearchToolbox
  */
 define(['jquery', 'TYPO3/CMS/Backend/DocumentHeader', 'TYPO3/CMS/Backend/jquery.clearable'], function($, DocumentHeader) {
        'use strict';
index ad1a3bd..e6dbc43 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/Toolbar/ClearCacheMenu
  * main functionality for clearing caches via the top bar
  * reloading the clear cache icon
  */
 define(['jquery', 'TYPO3/CMS/Backend/Icons'], function($, Icons) {
        'use strict';
 
+       /**
+        *
+        * @type {{options: {containerSelector: string, menuItemSelector: string, toolbarIconSelector: string}}}
+        * @exports TYPO3/CMS/Backend/Toolbar/ClearCacheMenu
+        */
        var ClearCacheMenu = {
                options: {
                        containerSelector: '#typo3-cms-backend-backend-toolbaritems-clearcachetoolbaritem',
@@ -44,7 +50,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Icons'], function($, Icons) {
         * calls TYPO3 to clear a cache, then changes the topbar icon
         * to a spinner. Once done, restores the original topbar icon
         *
-        * @param ajaxUrl the URL to load
+        * @param {String} ajaxUrl the URL to load
         */
        ClearCacheMenu.clearCache = function(ajaxUrl) {
                // Close clear cache menu
index 4154ee6..ca2fb2a 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/Toolbar/ShortcutMenu
  * shortcut menu logic to add new shortcut, remove a shortcut
  * and edit a shortcut
  */
 define(['jquery', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/Icons'], function($, Modal, Icons) {
        'use strict';
 
+       /**
+        *
+        * @type {{options: {containerSelector: string, toolbarIconSelector: string, toolbarMenuSelector: string, shortcutItemSelector: string, shortcutDeleteSelector: string, shortcutEditSelector: string, shortcutFormTitleSelector: string, shortcutFormGroupSelector: string, shortcutFormSaveSelector: string, shortcutFormCancelSelector: string}}}
+        * @exports TYPO3/CMS/Backend/Toolbar/ShortcutMenu
+        */
        var ShortcutMenu = {
                options: {
                        containerSelector: '#typo3-cms-backend-backend-toolbaritems-shortcuttoolbaritem',
@@ -35,6 +41,8 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/Icons'], functio
 
        /**
         * build the in-place-editor for a shortcut
+        *
+        * @param {Object} $shortcutRecord
         */
        ShortcutMenu.editShortcut = function($shortcutRecord) {
                // load the form
@@ -51,7 +59,9 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/Icons'], functio
        };
 
        /**
-        * save the data from the in-place-editor for a shortcut
+        * Save the data from the in-place-editor for a shortcut
+        *
+        * @param {Object} $shortcutRecord
         */
        ShortcutMenu.saveShortcutForm = function($shortcutRecord) {
                $.ajax({
@@ -71,6 +81,8 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/Icons'], functio
 
        /**
         * removes an existing short by sending an AJAX call
+        *
+        * @param {Object} $shortcutRecord
         */
        ShortcutMenu.deleteShortcut = function($shortcutRecord) {
                // @todo: translations
@@ -99,6 +111,12 @@ define(['jquery', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/Icons'], functio
        /**
         * makes a call to the backend class to create a new shortcut,
         * when finished it reloads the menu
+        *
+        * @param {String} moduleName
+        * @param {String} url
+        * @param {String} confirmationText
+        * @param {String} motherModule
+        * @param {Object} shortcutButton
         */
        ShortcutMenu.createShortcut = function(moduleName, url, confirmationText, motherModule, shortcutButton) {
                if (typeof confirmationText !== 'undefined') {
index c4e2b0c..cb595e5 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/Toolbar/SystemInformationMenu
  * System information menu handler
  */
 define(['jquery', 'TYPO3/CMS/Backend/Icons', 'TYPO3/CMS/Backend/Storage'], function($, Icons, Storage) {
        'use strict';
 
+       /**
+        *
+        * @type {{identifier: {containerSelector: string, toolbarIconSelector: string, menuContainerSelector: string, moduleLinks: string}, elements: {$counter: (*|jQuery|HTMLElement)}}}
+        * @exports TYPO3/CMS/Backend/Toolbar/SystemInformationMenu
+        */
        var SystemInformationMenu = {
                identifier: {
                        containerSelector: '#typo3-cms-backend-backend-toolbaritems-systeminformationtoolbaritem',
@@ -85,6 +91,8 @@ define(['jquery', 'TYPO3/CMS/Backend/Icons', 'TYPO3/CMS/Backend/Storage'], funct
 
        /**
         * Updates the UC and opens the linked module
+        *
+        * @param {Event} e
         */
        SystemInformationMenu.openModule = function(e) {
                e.preventDefault();
index 58c7902..2b2fb55 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/Tooltip
  * API for tooltip windows powered by Twitter Bootstrap.
  */
 define(['jquery', 'bootstrap'], function($) {
@@ -19,6 +20,9 @@ define(['jquery', 'bootstrap'], function($) {
 
        /**
         * The main tooltip object
+        *
+        * @type {{}}
+        * @exports TYPO3/CMS/Backend/Tooltip
         */
        var Tooltip = {
        };
@@ -34,8 +38,8 @@ define(['jquery', 'bootstrap'], function($) {
        /**
         * Show tooltip on $element
         *
-        * @param {object} $element
-        * @param {string} title
+        * @param {Object} $element
+        * @param {String} title
         */
        Tooltip.show = function($element, title) {
                $element
@@ -47,7 +51,7 @@ define(['jquery', 'bootstrap'], function($) {
        /**
         * Hide tooltip on $element
         *
-        * @param $element
+        * @param {Object} $element
         */
        Tooltip.hide = function($element) {
                $element.tooltip('hide');
index 28b19a3..7de688d 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/UserPassLogin
  * JavaScript module for the UsernamePasswordLoginProvider
  */
 define(['jquery', 'TYPO3/CMS/Backend/Login'], function($, Login) {
        'use strict';
 
+       /**
+        *
+        * @type {{options: {usernameField: string, passwordField: string}}}
+        * @exports TYPO3/CMS/Backend/UserPassLogin
+        */
        var UserPassLogin = {
                options: {
                        usernameField: '.t3js-login-username-field',
@@ -24,8 +30,13 @@ define(['jquery', 'TYPO3/CMS/Backend/Login'], function($, Login) {
                }
        };
 
-       // Checks whether capslock is enabled (returns TRUE if enabled, false otherwise)
-       // thanks to http://24ways.org/2007/capturing-caps-lock
+       /**
+        * Checks whether capslock is enabled (returns TRUE if enabled, false otherwise)
+        * thanks to http://24ways.org/2007/capturing-caps-lock
+        *
+        * @param {Event} e
+        * @returns {Boolean}
+        */
        UserPassLogin.isCapslockEnabled = function(e) {
                var ev = e ? e : window.event;
                if (!ev) {
@@ -62,6 +73,8 @@ define(['jquery', 'TYPO3/CMS/Backend/Login'], function($, Login) {
 
        /**
         * To prevent its unintended use when typing the password, the user is warned when Capslock is on
+        *
+        * @param {Event} event
         */
        UserPassLogin.showCapsLockWarning = function(event) {
                $(this).parent().parent().find('.t3js-login-alert-capslock').toggleClass('hidden', !UserPassLogin.isCapslockEnabled(event));
index 49c256f..6df8932 100644 (file)
  */
 
 /**
- * Utility helper
+ * Module: TYPO3/CMS/Backend/Utility
  */
 define(['jquery'], function($) {
 
        /**
         * The main Utility object
+        *
+        * @type {{}}
+        * @exports TYPO3/CMS/Backend/Utility
         */
        var Utility = {
        };
@@ -28,7 +31,7 @@ define(['jquery'], function($) {
         * Taken from:
         * http://dl.dropbox.com/u/35146/js/tests/isNumber.html
         *
-        * @param {string} number
+        * @param {String} number
         * @returns {boolean|*}
         */
        Utility.isNumber = function(number) {
@@ -38,9 +41,9 @@ define(['jquery'], function($) {
        /**
         * Gets a parameter from a given url
         *
-        * @param {string} url
-        * @param {string} parameter
-        * @returns {string}
+        * @param {String} url
+        * @param {String} parameter
+        * @returns {String}
         */
        Utility.getParameterFromUrl = function(url, parameter) {
                var parts = url.split('?'),
index 186fc06..fde9b99 100644 (file)
  */
 
 /**
- * ValueSlider
+ * Module: TYPO3/CMS/Backend/ValueSlider
  */
 define(['jquery', 'twbs/bootstrap-slider'], function($) {
        /**
         * ValueSlider object
         *
         * @type {{selector: string}}
+        * @exports TYPO3/CMS/Backend/ValueSlider
         */
        var ValueSlider = {
                selector: '[data-slider-id]'
        };
 
        /**
-        * initialize all slider elements
+        * Initialize all slider elements
         */
        ValueSlider.initializeSlider = function() {
                var $sliders = $(ValueSlider.selector);
@@ -38,7 +39,7 @@ define(['jquery', 'twbs/bootstrap-slider'], function($) {
        };
 
        /**
-        * update value of slider element
+        * Update value of slider element
         *
         * @param {Event} e
         */
index b20377e..ceecfb5 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Backend/Wizard/Colorpicker
  * Colorpicker JavaScript
  */
 define(['jquery'], function ($) {
        'use strict';
 
+       /**
+        *
+        * @type {{options: {}}}
+        * @exports TYPO3/CMS/Backend/Wizard/Colorpicker
+        */
        var Colorpicker = {
                options: {}
        };
 
+       /**
+        *
+        * @param {Object} options
+        */
        Colorpicker.setFieldChangeFunctions = function(options) {
                Colorpicker.options = options;
        };
 
+       /**
+        *
+        */
        Colorpicker.initializeEvents = function() {
-
                // Set color value
                $('.t3js-colorpicker-value').on('click', function(e) {
                        e.preventDefault();
index 32fb559..abcbd0d 100644 (file)
@@ -502,7 +502,7 @@ TYPO3.Components.PageTree.Tree = Ext.extend(Ext.tree.TreePanel, {
         *
         * This must be done to prevent the calling of the moveNode event.
         *
-        * @param {object} dragElement
+        * @param {Object} dragElement
         */
        beforeDropNode: function(dragElement) {
                if (dragElement.data && dragElement.data.item && dragElement.data.item.shouldCreateNewNode) {
index 07ee30a..31e00c5 100644 (file)
@@ -184,24 +184,43 @@ TYPO3.Windows = function() {
 
  */
 TYPO3.Dialog = function() {
-       /** @private functions */
+       /**
+        *
+        * @type {{buttons: (Ext.MessageBox.OK|{ok}), icon: string, fn: (emptyFn|Function)}}
+        * @private
+        */
        var informationDialogConfiguration = {
                buttons: Ext.MessageBox.OK,
                icon: Ext.MessageBox.INFO,
                fn: Ext.emptyFn
        };
 
+       /**
+        *
+        * @type {{buttons: (Ext.MessageBox.YESNO|{yes, no}), icon: string}}
+        * @private
+        */
        var questionDialogConfiguration = {
                buttons: Ext.MessageBox.YESNO,
                icon: Ext.MessageBox.QUESTION
        };
 
+       /**
+        *
+        * @type {{buttons: (Ext.MessageBox.OK|{ok}), icon: string, fn: (emptyFn|Function)}}
+        * @private
+        */
        var warningDialogConfiguration = {
                buttons: Ext.MessageBox.OK,
                icon: Ext.MessageBox.WARNING,
                fn: Ext.emptyFn
        };
 
+       /**
+        *
+        * @type {{buttons: (Ext.MessageBox.OK|{ok}), icon: string, fn: (emptyFn|Function)}}
+        * @private
+        */
        var errorDialogConfiguration = {
                buttons: Ext.MessageBox.OK,
                icon: Ext.MessageBox.ERROR,
@@ -209,7 +228,11 @@ TYPO3.Dialog = function() {
        };
 
        return {
-               /** @public functions */
+               /**
+                *
+                * @param configuration
+                * @constructor
+                */
                InformationDialog: function(configuration) {
                        configuration = configuration || {};
                        configuration = Ext.apply(
@@ -219,6 +242,11 @@ TYPO3.Dialog = function() {
                        Ext.Msg.show(configuration);
                },
 
+               /**
+                *
+                * @param configuration
+                * @constructor
+                */
                QuestionDialog: function(configuration) {
                        configuration = configuration || {};
                        configuration = Ext.apply(
@@ -228,6 +256,11 @@ TYPO3.Dialog = function() {
                        Ext.Msg.show(configuration);
                },
 
+               /**
+                *
+                * @param configuration
+                * @constructor
+                */
                WarningDialog: function(configuration) {
                        configuration = configuration || {};
                        configuration = Ext.apply(
@@ -237,6 +270,11 @@ TYPO3.Dialog = function() {
                        Ext.Msg.show(configuration);
                },
 
+               /**
+                * 
+                * @param configuration
+                * @constructor
+                */
                ErrorDialog: function(configuration) {
                        configuration = configuration || {};
                        configuration = Ext.apply(
index 0069ba6..6e3c1fc 100644 (file)
@@ -12,7 +12,9 @@
  */
 
 /**
- *  JavaScript for backend user listing
+ * Module: TYPO3/CMS/Beuser/BackendUserListing
+ * JavaScript for backend user listing
+ * @exports TYPO3/CMS/Beuser/BackendUserListing
  */
 define(['jquery', 'TYPO3/CMS/Backend/jquery.clearable'], function($) {
 
index e52cec9..4528615 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Beuser/Permissons
  * Javascript functions regarding the permissions module
  */
 define(['jquery'], function($) {
 
+       /**
+        *
+        * @type {{options: {containerSelector: string}}}
+        * @exports TYPO3/CMS/Beuser/Permissons
+        */
        var Permissions = {
                options: {
                        containerSelector: '#typo3-permissionList'
@@ -24,7 +30,10 @@ define(['jquery'], function($) {
        var ajaxUrl = TYPO3.settings.ajaxUrls['user_access_permissions'];
 
        /**
-        * changes the value of the permissions in the form
+        * Changes the value of the permissions in the form
+        *
+        * @param {String} checknames
+        * @param {String} varname
         */
        Permissions.setCheck = function(checknames, varname) {
                if (document.editform[varname]) {
@@ -37,6 +46,9 @@ define(['jquery'], function($) {
 
        /**
         * checks for a change of the permissions in the form
+        *
+        * @param {String} checknames
+        * @param {String} varname
         */
        Permissions.checkChange = function(checknames, varname) {
                var res = 0;
@@ -58,6 +70,8 @@ define(['jquery'], function($) {
 
        /**
         * changes permissions by sending an AJAX request to the server
+        *
+        * @param {Object} $element
         */
        Permissions.setPermissions = function($element) {
                var page = $element.data('page');
@@ -83,6 +97,8 @@ define(['jquery'], function($) {
 
        /**
         * changes the flag to lock the editing on a page by sending an AJAX request
+        *
+        * @param {Object} $element
         */
        Permissions.toggleEditLock = function($element) {
                var page = $element.data('page');
@@ -105,6 +121,8 @@ define(['jquery'], function($) {
 
        /**
         * Owner-related: Set the new owner of a page by executing an ajax call
+        *
+        * @param {Object} $element
         */
        Permissions.changeOwner = function($element) {
                var page = $element.data('page');
@@ -129,6 +147,8 @@ define(['jquery'], function($) {
        /**
         * Owner-related: load the selector for selecting
         * the owner of a page by executing an ajax call
+        *
+        * @param {Object} $element
         */
        Permissions.showChangeOwnerSelector = function($element) {
                var page = $element.data('page');
@@ -152,6 +172,8 @@ define(['jquery'], function($) {
 
        /**
         * Owner-related: Update the HTML view and show the original owner
+        *
+        * @param {Object} $element
         */
        Permissions.restoreOwner = function($element) {
                var page = $element.data('page');
@@ -184,6 +206,8 @@ define(['jquery'], function($) {
 
        /**
         * Group-related: Set the new group by executing an ajax call
+        *
+        * @param {Object} $element
         */
        Permissions.changeGroup = function($element) {
                var page = $element.data('page');
@@ -207,6 +231,8 @@ define(['jquery'], function($) {
 
        /**
         * Group-related: Load the selector by executing an ajax call
+        *
+        * @param {Object} $element
         */
        Permissions.showChangeGroupSelector = function($element) {
                var page = $element.data('page');
@@ -230,6 +256,8 @@ define(['jquery'], function($) {
 
        /**
         * Group-related: Update the HTML view and show the original group
+        *
+        * @param {Object} $element
         */
        Permissions.restoreGroup = function($element) {
                var page = $element.data('page');
index f9289a4..d9270e5 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Core/QueryGenerator
  * This module handle the QueryGenerator forms.
  */
 define(['jquery', 'TYPO3/CMS/Backend/DateTimePicker', 'TYPO3/CMS/Backend/jquery.clearable'], function ($) {
@@ -20,6 +21,7 @@ define(['jquery', 'TYPO3/CMS/Backend/DateTimePicker', 'TYPO3/CMS/Backend/jquery.
         * The QueryGenerator AMD module
         *
         * @type {{form: null, limitField: null}}
+        * @exports TYPO3/CMS/Core/QueryGenerator
         */
        var QueryGenerator = {
                form: null,
@@ -66,7 +68,7 @@ define(['jquery', 'TYPO3/CMS/Backend/DateTimePicker', 'TYPO3/CMS/Backend/jquery.
        /**
         * Set query limit
         *
-        * @param {string} value
+        * @param {String} value
         */
        QueryGenerator.setLimit = function(value) {
                QueryGenerator.limitField.val(value);
@@ -75,8 +77,8 @@ define(['jquery', 'TYPO3/CMS/Backend/DateTimePicker', 'TYPO3/CMS/Backend/jquery.
        /**
         * Add value to text field
         *
-        * @param {string} field the name of the field
-        * @param {string} value the value to add
+        * @param {String} field the name of the field
+        * @param {String} value the value to add
         */
        QueryGenerator.addValueToField = function(field, value) {
                var $target = QueryGenerator.form.find('[name="' + field + '"]');
index 72b7d64..eb72d32 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Documentation/Main
  * JavaScript module for ext:documentation
  */
 define(['jquery', 'datatables', 'TYPO3/CMS/Backend/jquery.clearable'], function($) {
        'use strict';
 
+       /**
+        *
+        * @type {{dataTable: null, searchField: null, identifier: {documentationList: string, searchField: string}}}
+        * @exports TYPO3/CMS/Documentation/Main
+        */
        var Documentation = {
                dataTable: null,
                searchField: null,
@@ -26,7 +32,9 @@ define(['jquery', 'datatables', 'TYPO3/CMS/Backend/jquery.clearable'], function(
                }
        };
 
-       // Initializes the data table, depending on the current view
+       /**
+        *  Initializes the data table, depending on the current view
+        */
        Documentation.initializeView = function() {
                var getVars = Documentation.getUrlVars();
                // init datatable
@@ -52,7 +60,11 @@ define(['jquery', 'datatables', 'TYPO3/CMS/Backend/jquery.clearable'], function(
                }
        };
 
-       // Utility method to retrieve query parameters
+       /**
+        * Utility method to retrieve query parameters
+        *
+        * @returns {Array}
+        */
        Documentation.getUrlVars = function getUrlVars() {
                var vars = [], hash;
                var hashes = window.location.href.slice(window.location.href.indexOf('?') + 1).split('&');
index 7778d4a..c64d4db 100644 (file)
@@ -11,6 +11,7 @@
  * The TYPO3 project - inspiring people to share!
  */
 /**
+ * Module: TYPO3/CMS/Extensionmanager/Main
  * main logic holding everything together, consists of multiple parts
  * ExtensionManager => Various functions for displaying the extension list / sorting
  * Repository => Various AJAX functions for TER downloads
  * ExtensionManager.uploadForm => helper to show the upload form
  */
 define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/CMS/Backend/jquery.clearable'], function($, NProgress, Modal) {
+
+       /**
+        *
+        * @type {{identifier: {extensionlist: string, searchField: string, extensionManager: string}}}
+        * @exports TYPO3/CMS/Extensionmanager/Main
+        */
        var ExtensionManager = {
                identifier: {
                        extensionlist: '#typo3-extension-list',
@@ -26,6 +33,10 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                }
        };
 
+       /**
+        *
+        * @returns {Object}
+        */
        ExtensionManager.manageExtensionListing = function() {
                var $searchField = $(this.identifier.searchField),
                        dataTable = $(this.identifier.extensionlist).DataTable({
@@ -66,6 +77,9 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                return dataTable;
        };
 
+       /**
+        *
+        */
        ExtensionManager.bindExtensionListActions = function() {
                $('.removeExtension').not('.transformed').each(function() {
                        var $me = $(this);
@@ -99,6 +113,10 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                });
        };
 
+       /**
+        *
+        * @param {Object} $extension
+        */
        ExtensionManager.removeExtensionFromDisk = function($extension) {
                var $extManager = $(Repository.identifier.extensionManager);
                $extManager.mask();
@@ -119,6 +137,10 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                });
        };
 
+       /**
+        *
+        * @returns {Array}
+        */
        ExtensionManager.getUrlVars = function() {
                var vars = [], hash;
                var hashes = window.location.href.slice(window.location.href.indexOf('?') + 1).split('&');
@@ -139,6 +161,12 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                return ExtensionManager.compare(a, b);
        };
 
+       /**
+        *
+        * @param {String} a
+        * @param {String} b
+        * @returns {Number}
+        */
        ExtensionManager.compare = function(a, b) {
                if (a === b) {
                        return 0;
@@ -174,6 +202,10 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                return 0;
        };
 
+       /**
+        *
+        * @param {Object} data
+        */
        ExtensionManager.updateExtension = function(data) {
                var message = '<h1>' + TYPO3.lang['extensionList.updateConfirmation.title'] + '</h1>';
                message += '<h2>' + TYPO3.lang['extensionList.updateConfirmation.message'] + '</h2>';
@@ -302,6 +334,10 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                });
        };
 
+       /**
+        *
+        * @type {{downloadPath: string, identifier: {extensionManager: string}}}
+        */
        var Repository = {
                downloadPath: '',
                identifier: {
@@ -309,6 +345,9 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                }
        };
 
+       /**
+        *
+        */
        Repository.initDom = function() {
                NProgress.configure({parent: '#typo3-docheader', showSpinner: false});
 
@@ -360,6 +399,9 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                Repository.bindSearchFieldResetter();
        };
 
+       /**
+        *
+        */
        Repository.bindDownload = function() {
                var installButtons = $('.downloadFromTer form.download button[type=submit]');
                installButtons.off('click');
@@ -379,6 +421,11 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                });
        };
 
+       /**
+        *
+        * @param {Object} data
+        * @returns {Boolean}
+        */
        Repository.getDependencies = function(data) {
                var $extManager = $(Repository.identifier.extensionManager);
                NProgress.done();
@@ -411,6 +458,10 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                return false;
        };
 
+       /**
+        *
+        * @param {String} url
+        */
        Repository.getResolveDependenciesAndInstallResult = function(url) {
                var $extManager = $(Repository.identifier.extensionManager);
                $.ajax({
@@ -466,6 +517,9 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                });
        };
 
+       /**
+        *
+        */
        Repository.bindSearchFieldResetter = function() {
                var $searchFields = $('.typo3-extensionmanager-searchTerForm input[type="text"]');
                var searchResultShown = ('' !== $searchFields.first().val());
@@ -481,6 +535,10 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                );
        };
 
+       /**
+        *
+        * @type {{identifier: {extensionTable: string, terUpdateAction: string, pagination: string, splashscreen: string, terTableWrapper: string, terTableDataTableWrapper: string}}}
+        */
        ExtensionManager.Update = {
                identifier: {
                        extensionTable: '#terTable',
@@ -492,7 +550,9 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                }
        };
 
-       // Register "update from ter" action
+       /**
+        * Register "update from ter" action
+        */
        ExtensionManager.Update.initializeEvents = function() {
                $(ExtensionManager.Update.identifier.terUpdateAction).each(function() {
 
@@ -516,6 +576,11 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                });
        };
 
+       /**
+        *
+        * @param {String} url
+        * @param {Number} forceUpdate
+        */
        ExtensionManager.Update.updateFromTer = function(url, forceUpdate) {
                if (forceUpdate == 1) {
                        url = url + '&tx_extensionmanager_tools_extensionmanagerextensionmanager%5BforceUpdateCheck%5D=1';
@@ -591,6 +656,9 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                });
        };
 
+       /**
+        *
+        */
        ExtensionManager.Update.transformPaginatorToAjax = function () {
                $(ExtensionManager.Update.identifier.pagination + ' a').each(function() {
                        var $me = $(this);
@@ -623,6 +691,9 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'datatables', 'TYPO3/C
                expandedUploadFormClass: 'transformed'
        };
 
+       /**
+        *
+        */
        ExtensionManager.UploadForm.initializeEvents = function() {
                // Show upload form
                $(document).on('click', '#upload-button-wrap > a', function(event) {
index bef33e0..cce41d8 100644 (file)
@@ -12,8 +12,8 @@
  */
 
 /**
- * JavaScript RequireJS module called "TYPO3/CMS/Filelist/FileList"
- *
+ * Module: TYPO3/CMS/Filelist/Filelist
+ * @exports TYPO3/CMS/Filelist/Filelist
  */
 define(['jquery'], function($) {
 
index f6d5117..a4cdff0 100644 (file)
@@ -12,8 +12,8 @@
  */
 
 /**
- * JavaScript RequireJS module called "TYPO3/CMS/Backend/FileListLocalisation"
- *
+ * Module: TYPO3/CMS/Filelist/FileListLocalisation
+ * @exports TYPO3/CMS/Filelist/FileListLocalisation
  */
 define(['jquery'], function($) {
 
index 211e796..86b0974 100644 (file)
@@ -12,7 +12,9 @@
  */
 
 /**
- *  JavaScript for file search
+ * Module: TYPO3/CMS/Filelist/FileSearch
+ * JavaScript for file search
+ * @exports TYPO3/CMS/Filelist/FileSearch
  */
 define(['jquery', 'TYPO3/CMS/Backend/jquery.clearable'], function($) {
 
index 421fcc6..676b529 100644 (file)
@@ -7,7 +7,7 @@
  *
  * @param {Function} fn The method the event invokes.
  * @param {Object} scope (optional) The scope (this reference) in which the handler function executes. Defaults to the browser window.
- * @param {boolean} options (optional) Options object as passed to {@link Ext.Element#addListener}. It is recommended that the options
+ * @param {Boolean} options (optional) Options object as passed to {@link Ext.Element#addListener}. It is recommended that the options
  * {single: true} be used so that the handler is removed on first invocation.
  *
  * @return void
index 84a9ac9..8ab3de8 100644 (file)
@@ -12,7 +12,9 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Impexp/ImportExport
  * JavaScript to handle confirm windows in the Import/Export module
+ * @exports TYPO3/CMS/Impexp/ImportExport
  */
 define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
        'use strict';
index df1378b..82e916d 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Lang/Lang
  * Transforms the TYPO3.lang object into a flat object
  *
  * `TYPO3.lang.foo[0].target = 'blah'` becomes `TYPO3.lang['foo'] = 'blah'`
  */
 define(['jquery'], function($) {
+       /**
+        *
+        * @type {{}}
+        * @exports TYPO3/CMS/Lang/Lang
+        */
        var Lang = {};
 
+       /**
+        *
+        */
        Lang.convertToOneDimension = function() {
                var originalLangObject = $.extend(true, {}, TYPO3.lang);
                TYPO3.lang = [];
index 12ef8f9..981c3de 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Lang/LanguageModule
  * Language module class
  */
 define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/Backend/jquery.clearable'], function($, moment, Icons) {
        'use strict';
 
+       /**
+        *
+        * @type {{me: *, context: null, table: null, topMenu: null, currentRequest: null, settings: {}, icons: {}, labels: {}, identifiers: {searchField: string, topMenu: string, activateIcon: string, deactivateIcon: string, downloadIcon: string, loadingIcon: string, completeIcon: string, progressBar: string, progressBarText: string, progressBarInner: string, lastUpdate: string, languagePrefix: string, extensionPrefix: string}, classes: {enabled: string, disabled: string, processing: string, complete: string, extension: string, actions: string, progressBar: string, loading: string, lastUpdate: string}}}
+        * @exports TYPO3/CMS/Lang/LanguageModule
+        */
        var LanguageModule = {
                me: this,
                context: null,
@@ -61,6 +67,9 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Initialize language table
+        *
+        * @param {HTMLElement} contextElement
+        * @param {HTMLElement} tableElement
         */
        LanguageModule.initializeLanguageTable = function(contextElement, tableElement) {
                LanguageModule.context = $(contextElement);
@@ -76,6 +85,9 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Initialize translation table
+        *
+        * @param {HTMLElement} contextElement
+        * @param {HTMLElement} tableElement
         */
        LanguageModule.initializeTranslationTable = function(contextElement, tableElement) {
                LanguageModule.context = $(contextElement);
@@ -90,6 +102,9 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Activate a language
+        *
+        * @param {HTMLElement} triggerElement
+        * @param {Object} parameters
         */
        LanguageModule.activateLanguageAction = function(triggerElement, parameters) {
                var $row = $(triggerElement).closest('tr'),
@@ -110,6 +125,9 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Deactivate a language
+        *
+        * @param {HTMLElement} triggerElement
+        * @param {Object} parameters
         */
        LanguageModule.deactivateLanguageAction = function(triggerElement, parameters) {
                var $row = $(triggerElement).closest('tr'),
@@ -130,6 +148,9 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Update a language
+        *
+        * @param {HTMLElement} triggerElement
+        * @param {Object} parameters
         */
        LanguageModule.updateLanguageAction = function(triggerElement, parameters) {
                var $row = $(triggerElement).closest('tr'),
@@ -154,6 +175,9 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Update all active languages
+        *
+        * @param {HTMLElement} triggerElement
+        * @param {Object} parameters
         */
        LanguageModule.updateActiveLanguagesAction = function(triggerElement, parameters) {
                var $activeRows = $('tr.' + LanguageModule.classes.enabled, LanguageModule.table.table().container());
@@ -181,6 +205,9 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Cancel language update
+        *
+        * @param {HTMLElement} triggerElement
+        * @param {Object} parameters
         */
        LanguageModule.cancelLanguageUpdateAction = function(triggerElement, parameters) {
                var $activeRows = $('tr.' + LanguageModule.classes.enabled, LanguageModule.table.table().container());
@@ -192,6 +219,9 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Update an extension translation
+        *
+        * @param {HTMLElement} triggerElement
+        * @param {Object} parameters
         */
        LanguageModule.updateTranslationAction = function(triggerElement, parameters) {
                var $row = $(triggerElement).closest('tr'),
@@ -212,6 +242,8 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Build icons
+        *
+        * @returns {{activate: (*|jQuery), deactivate: (*|jQuery), download: (*|jQuery), loading: (*|jQuery), complete: (*|jQuery), progressBar: (*|jQuery)}}
         */
        LanguageModule.buildIcons = function() {
                return {
@@ -226,6 +258,8 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Build labels
+        *
+        * @returns {{processing: *, search: *, loadingRecords: *, zeroRecords: *, emptyTable: *, dateFormat: *, errorHeader: *, infoHeader: *, successHeader: *, languageActivated: *, errorOccurred: *, languageDeactivated: *, updateComplete: *}}
         */
        LanguageModule.buildLabels = function() {
                return {
@@ -248,6 +282,9 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Build language table
+        *
+        * @param {HTMLElement} tableElement
+        * @returns {Object}
         */
        LanguageModule.buildLanguageTable = function(tableElement) {
                return $(tableElement).DataTable({
@@ -264,6 +301,9 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Initialize translation table
+        *
+        * @param {HTMLElement} tableElement
+        * @returns {Object}
         */
        LanguageModule.buildTranslationTable = function(tableElement) {
                var languageCount = $(tableElement).data('languageCount'),
@@ -368,7 +408,7 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
        /**
         * Update buttons in top menu
         *
-        * @param {string} action
+        * @param {String} action
         */
        LanguageModule.updateButtonStatus = function(action) {
                switch (action) {
@@ -391,6 +431,9 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Handler for "action" events
+        *
+        * @param {Object} element
+        * @param {Event} event
         */
        LanguageModule.handleActionEvent = function(element, event) {
                event.preventDefault();
@@ -403,6 +446,10 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Load translations for all extensions by given locale
+        *
+        * @param {String} locale
+        * @param {function} callback
+        * @param {Number} counter
         */
        LanguageModule.loadTranslationsByLocale = function(locale, callback, counter) {
                counter = counter || 0;
@@ -424,6 +471,9 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Load translations for all extensions by given rows
+        *
+        * @param {Object} rows
+        * @param {function} callback
         */
        LanguageModule.loadTranslationsByRows = function(rows, callback) {
                if (rows) {
@@ -446,6 +496,10 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Load translation for one extension by given locale
+        *
+        * @param {String} extension
+        * @param {String} locale
+        * @param {function} callback
         */
        LanguageModule.loadTranslationByExtensionAndLocale = function(extension, locale, callback) {
                var data = {extension: extension, locale: locale};
@@ -460,6 +514,10 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Execute AJAX request
+        *
+        * @param {String} uri
+        * @param {Object} data
+        * @param {function} callback
         */
        LanguageModule.executeAjaxRequest = function(uri, data, callback) {
                var newData = {};
@@ -497,6 +555,8 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Display error flash message
+        *
+        * @param {String} label
         */
        LanguageModule.displayError = function(label) {
                if (LanguageModule.userAbortRequest) {
@@ -508,6 +568,8 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Display information flash message
+        *
+        * @param {String} label
         */
        LanguageModule.displayInformation = function(label) {
                if (typeof label === 'string' && label !== '') {
@@ -517,6 +579,8 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Display success flash message
+        *
+        * @param {String} label
         */
        LanguageModule.displaySuccess = function(label) {
                if (typeof label === 'string' && label !== '') {
@@ -526,6 +590,11 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Build action link
+        *
+        * @param {String} action
+        * @param {Object} parameters
+        * @param {String} content
+        * @returns {Object}
         */
        LanguageModule.buildActionLink = function(action, parameters, content) {
                var $link = $('<a>');
@@ -543,6 +612,8 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Build progress bar
+        *
+        * @returns {Object}
         */
        LanguageModule.buildProgressBar = function() {
                var $span = $('<span>');
@@ -553,6 +624,8 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Build loading indicator
+        *
+        * @returns {Object}
         */
        LanguageModule.buildLoadingIndicator = function() {
                var $span = $('<span>');
@@ -563,6 +636,8 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Build complete state indicator
+        *
+        * @returns {Object}
         */
        LanguageModule.buildCompleteIndicator = function() {
                var $span = $('<span>');
@@ -573,6 +648,13 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Build image
+        *
+        * @param {String} uri
+        * @param {String} alt
+        * @param {String} title
+        * @param {Number} width
+        * @param {Number} heigth
+        * @returns {Object}
         */
        LanguageModule.buildImage = function(uri, alt, title, width, heigth) {
                var $image = $('<img>');
@@ -589,6 +671,9 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Format date
+        *
+        * @param {Number} timestamp
+        * @returns {*}
         */
        LanguageModule.formatDate = function(timestamp) {
                return moment.unix(timestamp).format(LanguageModule.labels.dateFormat);
@@ -596,6 +681,9 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
 
        /**
         * Set progress bar progress
+        *
+        * @param {Object} progressBar
+        * @param {String} progress
         */
        LanguageModule.setProgress = function(progressBar, progress) {
                var $inner = $(LanguageModule.identifiers.progressBarInner, progressBar),
@@ -605,7 +693,11 @@ define(['jquery', 'moment', 'TYPO3/CMS/Backend/Icons', 'datatables', 'TYPO3/CMS/
                $text.text(Math.round(progress) + '%');
        };
 
-       // Utility method to retrieve query parameters
+       /**
+        * Utility method to retrieve query parameters
+        *
+        * @returns {Array}
+        */
        LanguageModule.getUrlVars = function getUrlVars() {
                var vars = [], hash;
                var hashes = window.location.href.slice(window.location.href.indexOf('?') + 1).split('&');
index 7c2921d..c285155 100644 (file)
  * The TYPO3 project - inspiring people to share!
  */
 
+/**
+ * Module: TYPO3/CMS/Linkvalidator/Linkvalidator
+ */
 define(['jquery'], function($) {
        'use strict';
 
+       /**
+        *
+        * @type {{}}
+        * @exports TYPO3/CMS/Linkvalidator/Linkvalidator
+        */
        var Linkvalidator = {};
 
+       /**
+        *
+        * @param {String} prefix
+        */
        Linkvalidator.toggleActionButton = function(prefix) {
                var buttonDisable = true;
                $('.' + prefix).each(function() {
index 1cdcf41..1bd9836 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Opendocs/OpendocsMenu
  * main JS part taking care of
  *  - navigating to the documents
  *  - updating the menu
 define(['jquery', 'TYPO3/CMS/Backend/Icons'], function($, Icons) {
        'use strict';
 
+       /**
+        *
+        * @type {{options: {containerSelector: string, hashDataAttributeName: string, closeSelector: string, menuContainerSelector: string, menuItemSelector: string, toolbarIconSelector: string, openDocumentsItemsSelector: string, counterSelector: string}}}
+        * @exports TYPO3/CMS/Opendocs/OpendocsMenu
+        */
        var OpendocsMenu = {
                options: {
                        containerSelector: '#typo3-cms-opendocs-backend-toolbaritems-opendocstoolbaritem',
@@ -81,7 +87,7 @@ define(['jquery', 'TYPO3/CMS/Backend/Icons'], function($, Icons) {
        /**
         * Closes an open document
         *
-        * @param {string} md5sum
+        * @param {String} md5sum
         */
        OpendocsMenu.closeDocument = function(md5sum) {
                $.ajax({
index ef91b00..faf54e6 100644 (file)
@@ -12,7 +12,9 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Recordlist/BrowseDatabase
  * Database record selection
+ * @exports TYPO3/CMS/Recordlist/BrowseDatabase
  */
 define(['jquery', 'TYPO3/CMS/Recordlist/ElementBrowser'], function($, ElementBrowser) {
        'use strict';
index 74be57b..a3c559e 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Recordlist/BrowseFiles
  * File selection
  */
 define(['jquery', 'TYPO3/CMS/Recordlist/ElementBrowser', 'TYPO3/CMS/Backend/LegacyTree'], function($, ElementBrowser, Tree) {
        'use strict';
 
+       /**
+        *
+        * @type {{elements: {}}}
+        * @exports TYPO3/CMS/Recordlist/BrowseFiles
+        */
        var BrowseFiles = {
                elements: {}
        };
 
-       // when selecting one or multiple files, this action is called
+       /**
+        * when selecting one or multiple files, this action is called
+        *
+        * @type {{insertElement: Function, insertElementMultiple: Function}}
+        */
        BrowseFiles.File = {
                insertElement: function(index, close) {
                        var result = false;
index 37fe140..2447de7 100644 (file)
@@ -12,7 +12,9 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Recordlist/BrowseFolders
  * Folder selection
+ * @exports TYPO3/CMS/Recordlist/BrowseFolders
  */
 define(['jquery', 'TYPO3/CMS/Recordlist/ElementBrowser', 'TYPO3/CMS/Backend/Modal'], function ($, ElementBrowser, Modal) {
        'use strict';
index fb11a5b..e753e66 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Recordlist/ElementBrowser
  * ElementBrowser communication with parent windows
  */
 define(['jquery'], function($) {
        'use strict';
 
+       /**
+        *
+        * @type {{thisScriptUrl: string, mode: string, formFieldName: string, hasActionMultipleCode: boolean, fieldReference: string, fieldReferenceSlashed: string, rte: {parameters: string, configuration: string}, irre: {objectId: number, checkUniqueAction: string, addAction: string, insertAction: string}}}
+        * @exports TYPO3/CMS/Recordlist/ElementBrowser
+        */
        var ElementBrowser = {
                thisScriptUrl: '',
                mode: '',
@@ -36,6 +42,10 @@ define(['jquery'], function($) {
                }
        };
 
+       /**
+        *
+        * @returns {Boolean}
+        */
        ElementBrowser.setReferences = function() {
                if (
                        window.opener && window.opener.content && window.opener.content.document.editform
@@ -52,8 +62,8 @@ define(['jquery'], function($) {
        /**
         * Dynamically calls a function on a given context object.
         *
-        * @param {string} functionName e.g. "inline.somefunc"
-        * @param {object} context e.g. window
+        * @param {String} functionName e.g. "inline.somefunc"
+        * @param {Object} context e.g. window
         * @returns {*}
         */
        ElementBrowser.executeFunctionByName = function(functionName, context /*, args */) {
@@ -66,6 +76,19 @@ define(['jquery'], function($) {
                return context[func].apply(context, args);
        };
 
+       /**
+        *
+        * @param {String} table
+        * @param {Number} uid
+        * @param {String} type
+        * @param {String} filename
+        * @param {String} fp
+        * @param {String} filetype
+        * @param {String} imagefile
+        * @param {String} action
+        * @param {String} close
+        * @returns {Boolean}
+        */
        ElementBrowser.insertElement = function(table, uid, type, filename, fp, filetype, imagefile, action, close) {
                var performAction = true;
                // Call a check function in the opener window (e.g. for uniqueness handling):
@@ -132,6 +155,12 @@ define(['jquery'], function($) {
                return false;
        };
 
+       /**
+        *
+        * @param {String} table
+        * @param {Number} uid
+        * @returns {Boolean}
+        */
        ElementBrowser.insertMultiple = function(table, uid) {
                var type = "";
                if (ElementBrowser.irre.objectId && ElementBrowser.irre.insertAction) {
@@ -146,6 +175,13 @@ define(['jquery'], function($) {
                return false;
        };
 
+       /**
+        *
+        * @param {String} elName
+        * @param {String} elValue
+        * @param {String} altElValue
+        * @param {String} close
+        */
        ElementBrowser.addElement = function(elName, elValue, altElValue, close) {
                if (window.opener && window.opener.setFormValueFromBrowseWin) {
                        window.opener.setFormValueFromBrowseWin(ElementBrowser.fieldReference, altElValue ? altElValue : elValue, elName);
@@ -158,6 +194,9 @@ define(['jquery'], function($) {
                }
        };
 
+       /**
+        *
+        */
        ElementBrowser.focusOpenerAndClose = function() {
                window.opener.focus();
                close();
@@ -185,9 +224,9 @@ define(['jquery'], function($) {
         *
         * Used by tree implementation
         *
-        * @param {string} URL
-        * @param {string} anchor
-        * @returns {boolean}
+        * @param {String} URL
+        * @param {String} anchor
+        * @returns {Boolean}
         */
        window.jumpToUrl = function(URL, anchor) {
                if (URL.charAt(0) === '?') {
index 72af6de..fef5bf6 100644 (file)
@@ -12,7 +12,9 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Recordlist/FieldSelectBox
  * Check-all / uncheck-all for the Database Recordlist fieldSelectBox
+ * @exports TYPO3/CMS/Recordlist/FieldSelectBox
  */
 define(['jquery'], function($) {
        'use strict';
index 9a6158b..1a0441d 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Recordlist/FileLinkHandler
  * File link interaction
  */
 define(['jquery', 'TYPO3/CMS/Recordlist/LinkBrowser', 'TYPO3/CMS/Backend/LegacyTree'], function($, LinkBrowser, Tree) {
        'use strict';
 
+       /**
+        *
+        * @type {{currentLink: string}}
+        * @exports TYPO3/CMS/Recordlist/FileLinkHandler
+        */
        var FileLinkHandler = {
                currentLink: ''
        };
 
+       /**
+        *
+        * @param {Event} event
+        */
        FileLinkHandler.linkFile = function(event) {
                event.preventDefault();
 
@@ -29,6 +39,10 @@ define(['jquery', 'TYPO3/CMS/Recordlist/LinkBrowser', 'TYPO3/CMS/Backend/LegacyT
                close();
        };
 
+       /**
+        *
+        * @param {Event} event
+        */
        FileLinkHandler.linkCurrent = function(event) {
                event.preventDefault();
 
index 0bc7df1..9ad6d2c 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Recordlist/LinkBrowser
  * LinkBrowser communication with parent window
  */
 define(['jquery'], function($) {
        'use strict';
 
+       /**
+        *
+        * @type {{thisScriptUrl: string, urlParameters: {}, parameters: {}, addOnParams: string, linkAttributeFields: Array, updateFunctions: null}}
+        * @exports TYPO3/CMS/Recordlist/LinkBrowser
+        */
        var LinkBrowser = {
                thisScriptUrl: '',
                urlParameters: {},
@@ -43,7 +49,7 @@ define(['jquery'], function($) {
        /**
         * Collect the link attributes values as object
         *
-        * @returns {object}
+        * @returns {Object}
         */
        LinkBrowser.getLinkAttributeValues = function() {
                var attributeValues = {};
@@ -59,7 +65,7 @@ define(['jquery'], function($) {
        /**
         * Save the current link back to the opener
         *
-        * @param input
+        * @param {String} input
         */
        LinkBrowser.updateValueInMainForm = function(input) {
                var field = LinkBrowser.checkReference();
@@ -88,6 +94,9 @@ define(['jquery'], function($) {
                }
        };
 
+       /**
+        *
+        */
        LinkBrowser.loadTarget = function() {
                $('#linkTarget').val($(this).val());
                this.selectedIndex = 0;
@@ -96,10 +105,10 @@ define(['jquery'], function($) {
        /**
         * Encode objects to GET parameter arrays in PHP notation
         *
-        * @param {object} obj
-        * @param {string} prefix
-        * @param {string} url
-        * @returns {string}
+        * @param {Object} obj
+        * @param {String} prefix
+        * @param {String} url
+        * @returns {String}
         */
        LinkBrowser.encodeGetParameters = function(obj, prefix, url) {
                var str = [];
@@ -135,9 +144,9 @@ define(['jquery'], function($) {
         *
         * Used by tree implementation
         *
-        * @param {string} URL
-        * @param {string} anchor
-        * @returns {boolean}
+        * @param {String} URL
+        * @param {String} anchor
+        * @returns {Boolean}
         */
        window.jumpToUrl = function(URL, anchor) {
                if (URL.charAt(0) === '?') {
index dd2895d..5bf21b9 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Recordlist/MailLinkHandler
  * Mail link interaction
  */
 define(['jquery', 'TYPO3/CMS/Recordlist/LinkBrowser'], function($, LinkBrowser) {
        'use strict';
 
+       /**
+        *
+        * @type {{}}
+        * @exports TYPO3/CMS/Recordlist/MailLinkHandler
+        */
        var MailLinkHandler = {};
 
+       /**
+        *
+        * @param {Event} event
+        */
        MailLinkHandler.link = function(event) {
                event.preventDefault();
 
index 4ba0b0b..c2421c4 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Recordlist/PageLinkHandler
  * Page link interaction
  */
 define(['jquery', 'TYPO3/CMS/Recordlist/LinkBrowser'], function($, LinkBrowser) {
        'use strict';
 
+       /**
+        *
+        * @type {{currentLink: string}}
+        * @exports TYPO3/CMS/Recordlist/PageLinkHandler
+        */
        var PageLinkHandler = {
                currentLink: ''
        };
 
+       /**
+        *
+        * @param {Event} event
+        */
        PageLinkHandler.linkPage = function(event) {
                event.preventDefault();
 
@@ -31,6 +41,10 @@ define(['jquery', 'TYPO3/CMS/Recordlist/LinkBrowser'], function($, LinkBrowser)
                close();
        };
 
+       /**
+        *
+        * @param {Event} event
+        */
        PageLinkHandler.linkCurrent = function(event) {
                event.preventDefault();
 
index a58438d..d1a5dc1 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Recordlist/Recordlist
  * Usability improvements for the record list
  */
 define(['jquery', 'TYPO3/CMS/Backend/Storage', 'TYPO3/CMS/Backend/Icons'], function($, Storage, Icons) {
        'use strict';
 
+       /**
+        *
+        * @type {{identifier: {toggle: string, icons: {collapse: string, expand: string}}}}
+        * @exports TYPO3/CMS/Recordlist/Recordlist
+        */
        var Recordlist = {
                identifier: {
                        toggle: '.t3js-toggle-recordlist',
@@ -27,6 +33,10 @@ define(['jquery', 'TYPO3/CMS/Backend/Storage', 'TYPO3/CMS/Backend/Icons'], funct
                }
        };
 
+       /**
+        *
+        * @param {Event} e
+        */
        Recordlist.toggleClick = function(e) {
                e.preventDefault();
 
index a62eeb0..4651b88 100644 (file)
@@ -12,7 +12,9 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Recordlist/Tooltip
  * API for tooltip windows powered by Twitter Bootstrap.
+ * @exports TYPO3/CMS/Recordlist/Tooltip
  */
 define(['jquery', 'TYPO3/CMS/Backend/Tooltip'], function($, Tooltip) {
        'use strict';
index 7fa579c..79fe50e 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Recordlist/UrlLinkHandler
  * URL link interaction
  */
 define(['jquery', 'TYPO3/CMS/Recordlist/LinkBrowser'], function($, LinkBrowser) {
        'use strict';
 
+       /**
+        *
+        * @type {{}}
+        * @exports TYPO3/CMS/Recordlist/UrlLinkHandler
+        */
        var UrlLinkHandler = {};
 
+       /**
+        *
+        * @param {Event} event
+        */
        UrlLinkHandler.link = function(event) {
                event.preventDefault();
 
index b822c76..ff2cf37 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Recycler/Recycler
  * RequireJS module for Recycler
  */
 define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/jquery.clearable'], function($, NProgress, Modal) {
        'use strict';
 
+       /**
+        *
+        * @type {{identifiers: {searchForm: string, searchText: string, searchSubmitBtn: string, depthSelector: string, tableSelector: string, recyclerTable: string, paginator: string, reloadAction: string, massUndo: string, massDelete: string, toggleAll: string}, elements: {}, paging: {currentPage: number, totalPages: number, totalItems: number, itemsPerPage: number}, markedRecordsForMassAction: Array, allToggled: boolean}}
+        * @exports TYPO3/CMS/Recycler/Recycler
+        */
        var Recycler = {
                identifiers: {
                        searchForm: '#recycler-form',
@@ -332,6 +338,9 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/jqu
                });
        };
 
+       /**
+        *
+        */
        Recycler.deleteRecord = function() {
                if (TYPO3.settings.Recycler.deleteDisable) {
                        return;
@@ -370,6 +379,9 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/jqu
                ]);
        };
 
+       /**
+        *
+        */
        Recycler.undoRecord = function() {
                var $tr = $(this).parents('tr'),
                        isMassUndo = $tr.parent().prop('tagName') !== 'TBODY'; // undoRecord() was invoked by the mass delete button
@@ -420,7 +432,10 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/jqu
        };
 
        /**
-        * Method that really calls the action via AJAX
+        *
+        * @param {String} action
+        * @param {Object} records
+        * @param {Boolean} isMassAction
         */
        Recycler.callAjaxAction = function(action, records, isMassAction) {
                var data = {
@@ -478,6 +493,10 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/jqu
 
        /**
         * Replaces the placeholders with actual values
+        *
+        * @param {String} message
+        * @param {Array} placeholders
+        * @returns {*}
         */
        Recycler.createMessage = function(message, placeholders) {
                if (typeof message === 'undefined') {
@@ -503,6 +522,8 @@ define(['jquery', 'nprogress', 'TYPO3/CMS/Backend/Modal', 'TYPO3/CMS/Backend/jqu
 
        /**
         * Build the paginator
+        *
+        * @param {Number} totalItems
         */
        Recycler.buildPaginator = function(totalItems) {
                if (totalItems === 0) {
index f61d2d8..7d4d309 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Rsaauth/RsaEncryptionModule
  * Object that handles RSA encryption and submission of the form
  */
 define(['jquery', './RsaLibrary'], function($) {
        'use strict';
 
+       /**
+        *
+        * @type {{$currentForm: null, fetchedRsaKey: boolean, initialize: Function, handleFormSubmitRequest: Function, handlePublicKeyResponse: Function}}
+        * @exports TYPO3/CMS/Rsaauth/RsaEncryptionModule
+        */
        var RsaEncryption = {
 
                /**
@@ -53,7 +59,7 @@ define(['jquery', './RsaLibrary'], function($) {
                /**
                 * Fetches a new public key by Ajax and encrypts the password for transmission
                 *
-                * @param event
+                * @param {Event} event
                 */
                handleFormSubmitRequest: function(event) {
                        if (!RsaEncryption.fetchedRsaKey) {
@@ -79,7 +85,7 @@ define(['jquery', './RsaLibrary'], function($) {
                /**
                 * Parses the Json response and triggers submission of the form
                 *
-                * @param response Ajax response object
+                * @param {Object} response Ajax response object
                 */
                handlePublicKeyResponse: function(response) {
                        var publicKey = response.split(':');
index 394d49e..c9b8a86 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/Ajax/Ajax
  * Ajax object
  */
 define(['jquery',
@@ -20,6 +21,10 @@ define(['jquery',
 
        /**
         * Constructor method
+        *
+        * @param config
+        * @constructor
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/Ajax/Ajax
         */
        var Ajax = function (config) {
                Util.apply(this, config);
index f3330a5..c4110ec 100644 (file)
  *
  * The TYPO3 project - inspiring people to share!
  */
-/***************************************************
- *  HTMLArea.CSS.Parser: CSS Parser
- ***************************************************/
+/**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/CSS/Parser
+ * HTMLArea.CSS.Parser: CSS Parser
+ */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        'TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Util',
        'TYPO3/CMS/Rtehtmlarea/HTMLArea/Event/Event'],
@@ -20,6 +21,10 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
 
        /**
         * Parser constructor
+        *
+        * @param config
+        * @constructor
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/CSS/Parser
         */
        var Parser = function (config) {
                var configDefaults = {
index f9c9509..272aef4 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Configuration/Config
  * Configuration of af an Editor of TYPO3 htmlArea RTE
  */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
@@ -19,7 +20,8 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        function (UserAgent, Util) {
 
        /**
-        *  Constructor: Sets editor configuration defaults
+        * Constructor: Sets editor configuration defaults
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Configuration/Config
         */
        var Config = function (editorId) {
                this.editorId = editorId;
index 784550d..e1e22a9 100644 (file)
  *
  * The TYPO3 project - inspiring people to share!
  */
-/***************************************************
- *  HTMLArea.DOM.BookMark: BookMark object
- ***************************************************/
+/**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/DOM/BookMark
+ * HTMLArea.DOM.BookMark: BookMark object
+ */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        'TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Util',
        'TYPO3/CMS/Rtehtmlarea/HTMLArea/DOM/DOM'],
@@ -21,9 +22,9 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        /**
         * Constructor method
         *
-        * @param object config: an object with property "editor" giving reference to the parent object
-        *
-        * @return void
+        * @param {Object} config: an object with property "editor" giving reference to the parent object
+        * @constructor
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/DOM/BookMark
         */
        var BookMark = function (config) {
 
@@ -48,10 +49,10 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        /**
         * Get a bookMark
         *
-        * @param       object          range: the range to bookMark
-        * @param       boolean         nonIntrusive: if true, a non-intrusive bookmark is requested
+        * @param {Object} range: the range to bookMark
+        * @param {Boolean} nonIntrusive: if true, a non-intrusive bookmark is requested
         *
-        * @return      object          the bookMark
+        * @return {Object} the bookMark
         */
        BookMark.prototype.get = function (range, nonIntrusive) {
                var bookMark;
@@ -70,9 +71,9 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
         * in the range boundaries. The advantage of it is that it is possible to
         * handle DOM mutations when moving back to the bookMark.
         *
-        * @param       object          range: the range to bookMark
+        * @param {Object} range: the range to bookMark
         *
-        * @return      object          the bookMark
+        * @return {Object} the bookMark
         */
        BookMark.prototype.getIntrusiveBookMark = function (range) {
                // Create the bookmark info (random IDs).
@@ -119,10 +120,10 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
         * Get a non-intrusive bookMark
         * Adapted from FCKeditor
         *
-        * @param       object          range: the range to bookMark
-        * @param       boolean         normalized: if true, normalized enpoints are calculated
+        * @param {Object} range: the range to bookMark
+        * @param {Boolean} normalized: if true, normalized enpoints are calculated
         *
-        * @return      object          the bookMark
+        * @return {Object} the bookMark
         */
        BookMark.prototype.getNonIntrusiveBookMark = function (range, normalized) {
                var startContainer = range.startContainer,
index 3b7a941..15c1a6d 100644 (file)
  *
  * The TYPO3 project - inspiring people to share!
  */
-/*****************************************************************
+/**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/DOM/DOM
  * HTMLArea.DOM: Utility functions for dealing with the DOM tree *
- *****************************************************************/
+ */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        'TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Util'],
        function (UserAgent, Util) {
 
+       /**
+        *
+        * @type {{ELEMENT_NODE: number, ATTRIBUTE_NODE: number, TEXT_NODE: number, CDATA_SECTION_NODE: number, ENTITY_REFERENCE_NODE: number, ENTITY_NODE: number, PROCESSING_INSTRUCTION_NODE: number, COMMENT_NODE: number, DOCUMENT_NODE: number, DOCUMENT_TYPE_NODE: number, DOCUMENT_FRAGMENT_NODE: number, NOTATION_NODE: number, RE_blockTags: RegExp, RE_noClosingTag: RegExp, RE_bodyTag: RegExp, isBlockElement: Function, needsClosingTag: Function, getClassNames: Function, hasClass: Function, addClass: Function, removeClass: Function, isRequiredClass: Function, getInnerText: Function, getBlockAncestors: Function, getFirstAncestorOfType: Function, getPositionWithinParent: Function, hasAllowedAttributes: Function, removeFromParent: Function, convertNode: Function, rangeIntersectsNode: Function, makeUrlsAbsolute: Function, makeImageSourceAbsolute: Function, makeLinkHrefAbsolute: Function, addBaseUrl: Function, getPosition: Function, getSize: Function, setSize: Function, setStyle: Function}}
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/DOM/DOM
+        */
        var Dom = {
 
                /***************************************************
index f202ed2..88278d1 100644 (file)
  *
  * The TYPO3 project - inspiring people to share!
  */
-/***************************************************
- *  HTMLArea.DOM.Node: Node object
- ***************************************************/
+/**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/DOM/Node
+ * HTMLArea.DOM.Node: Node object
+ */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        'TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Util',
        'TYPO3/CMS/Rtehtmlarea/HTMLArea/DOM/DOM'],
@@ -21,9 +22,9 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        /**
         * Constructor method
         *
-        * @param object config: an object with property "editor" giving reference to the parent object
-        *
-        * @return void
+        * @param {Object} config: an object with property "editor" giving reference to the parent object
+        * @constructor
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/DOM/Node
         */
        var Node = function (config) {
 
index 60bb714..43d8953 100644 (file)
@@ -10,8 +10,9 @@
  *
  * The TYPO3 project - inspiring people to share!
  */
-/***************************************************
- *  HTMLArea.DOM.Selection: Selection object
+/**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/DOM/Selection
+ * HTMLArea.DOM.Selection: Selection object
  ***************************************************/
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        'TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Util',
@@ -22,9 +23,8 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        /**
         * Constructor method
         *
-        * @param object config: an object with property "editor" giving reference to the parent object
-        *
-        * @return void
+        * @param {Object} config: an object with property "editor" giving reference to the parent object
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/DOM/Selection
         */
        var Selection = function (config) {
 
index 44d79ef..666c6db 100644 (file)
@@ -10,8 +10,9 @@
  *
  * The TYPO3 project - inspiring people to share!
  */
-/***************************************************
- *  HTMLArea.DOM.Walker: DOM tree walk
+/**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/DOM/Walker
+ * HTMLArea.DOM.Walker: DOM tree walk
  ***************************************************/
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        'TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Util',
@@ -21,9 +22,8 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        /**
         * Constructor method
         *
-        * @param object config: an object with property "editor" giving reference to the parent object
-        *
-        * @return void
+        * @param {Object} config: an object with property "editor" giving reference to the parent object
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/DOM/Walker
         */
        var Walker = function (config) {
                // Configuration defaults
index d687987..57ac6b9 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Editor/Editor
  * Editor extends Ext.util.Observable
  */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
@@ -33,7 +34,9 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        /**
         * Editor constructor method
         *
-        * @param object config: editor configuration object
+        * @param {Object} config: editor configuration object
+        * @constructor
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Editor/Editor
         */
        var Editor = function (config) {
                // Save the config
index fdd0b60..07bb064 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Editor/Framework
  * Framework is the visual component of the Editor and contains the tool bar, the iframe, the textarea and the status bar
  */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
@@ -24,6 +25,9 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
 
        /**
         * Framework constructor
+        * @param {Object} config
+        * @constructor
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Editor/Framework
         */
        var Framework = function (config) {
                Util.apply(this, config);
index 7d77945..bfb5e12 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Editor/Iframe
  * The editor iframe
  */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
@@ -25,6 +26,10 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
 
        /**
         * Editor iframe constructor
+        *
+        * @param {Object} config
+        * @constructor
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Editor/Iframe
         */
        var Iframe = function (config) {
                Util.apply(this, config);
index 691ff84..2b90f1e 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Editor/StatusBar
  * The optional status bar at the bottom of the editor framework
  */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
@@ -22,6 +23,10 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
 
        /**
         * Status bar constructor
+        *
+        * @param {Object} config
+        * @constructor
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Editor/StatusBar
         */
        var StatusBar = function (config) {
                Util.apply(this, config);
index 0dd07d4..cc5c962 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Editor/TextAreaContainer
  * The container of the textarea within the editor framework
  */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Util',
@@ -21,6 +22,10 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Util',
 
        /**
         * Status bar constructor
+        *
+        * @param {Object} config
+        * @constructor
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Editor/TextAreaContainer
         */
        var TextAreaContainer = function (config) {
                Util.apply(this, config);
index ea3984c..43584f4 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Editor/Toolbar
  * The editor toolbar
  */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Util',
@@ -24,6 +25,10 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Util',
 
        /**
         * Editor toolbar constructor
+        *
+        * @param {Object} config
+        * @constructor
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Editor/Toolbar
         */
        var Toolbar = function (config) {
                Util.apply(this, config);
index 5e08742..5f0572c 100644 (file)
  *
  * The TYPO3 project - inspiring people to share!
  */
-/*****************************************************************
+/**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Event/Event
  * HTMLArea.Event: Utility functions for dealing with events     *
- *****************************************************************/
+ */
 define(['jquery',
        'TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        'TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Util'],
        function ($, UserAgent, Util) {
 
+       /**
+        *
+        * @type {{NAMESPACE: string, BACKSPACE: number, TAB: number, ENTER: number, ESC: number, SPACE: number, LEFT: number, UP: number, RIGHT: number, DOWN: number, DELETE: number, F11: number, NON_BREAKING_SPACE: number, domLevel3Keys: {Backspace: number, Tab: number, Enter: number, Esc: number, Escape: number, Spacebar: number,  : number, Left: number, ArrowLeft: number, Up: number, ArrowUp: number, Right: number, ArrowRight: number, Down: number, ArrowDown: number, Del: number, Delete: number, 0: number, 1: number, 2: number, 3: number, 4: number, 5: number, 6: number, 7: number, 8: number, 9: number, F11: number}, safariKeys: {3: number, 63234: number, 63235: number, 63232: number, 63233: number, 63276: number, 63277: number, 63272: number, 63273: number, 63275: number}, on: Function, one: Function, off: Function, stopEvent: Function, trigger: Function, getKey: Function, normalizeKey: Function, getBrowserEvent: Function}}
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Event/Event
+        */
        var Event = {
 
                NAMESPACE: '.htmlarea',
index ba84df2..c469d9f 100644 (file)
  *
  * The TYPO3 project - inspiring people to share!
  */
-/********************************************************************
+/**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Event/KeyMap
  * HTMLArea.KeyMap: Utility functions for dealing with key events   *
- ********************************************************************/
+ */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/Event/Event'],
        function (Event) {
 
        /**
         * Constructor method
         *
-        * @param object element: the element to which the key map is attached
-        * @param string eventName: the event name
-        * @return void
+        * @param {Object} element: the element to which the key map is attached
+        * @param {String} eventName: the event name
+        * @constructor
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Event/KeyMap
         */
        var KeyMap = function (element, eventName) {
 
@@ -36,7 +38,7 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/Event/Event'],
        /**
         * Add an event handler to the keymap for a given combination of keys
         *
-        * @param object options: options for the binding; possible keys:
+        * @param {Object} options: options for the binding; possible keys:
         *      key: a key or an array of keys
         *      ctrl: boolean,
         *      shift: boolean,
@@ -70,7 +72,7 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/Event/Event'],
 
        /**
         * Key map handler
-        * @return boolean false if the event was handled
+        * @return {Boolean} false if the event was handled
         */
        KeyMap.prototype.handler = function (event) {
                var key = Event.getKey(event);
index 5d5928c..1014269 100644 (file)
@@ -12,7 +12,9 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Extjs/ColorPalette
  * Intercept Ext.ColorPalette.prototype.select
+ * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Extjs/ColorPalette
  */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Color'],
        function (Color) {
index dbc5b29..542bbfa 100644 (file)
@@ -12,7 +12,9 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Extjs/ColorPalette/ColorMenu
  * Color menu
+ * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Extjs/ColorPalette/ColorMenu
  */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/Extjs/ColorPalette'],
        function (ColorPalette) {
index 63a08a6..cc59160 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Extjs/ColorPalette/ColorPaletteField
  * Color palette trigger field
  * Based on http://www.extjs.com/forum/showthread.php?t=89312
+ * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Extjs/ColorPalette/ColorPaletteField
  */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/Extjs/ux/ColorMenu'],
        function (ColorMenu) {
index 3654150..76c2567 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/HtmlArea
  * Initialization script of TYPO3 htmlArea RTE
  */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
@@ -20,6 +21,11 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        'TYPO3/CMS/Rtehtmlarea/HTMLArea/Editor/Editor'],
        function (UserAgent, Util, Config, Editor) {
 
+               /**
+                *
+                * @type {{RE_htmlTag: RegExp, RE_tagName: RegExp, RE_head: RegExp, RE_body: RegExp, reservedClassNames: RegExp, RE_email: RegExp, RE_url: RegExp, RE_numberOrPunctuation: RegExp, init: Function, initEditor: Function, localize: Function, appendToLog: Function}}
+                * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/HtmlArea
+                */
                var HtmlArea = {
 
                        /***************************************************
index fadc1f4..2d696c7 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * @AMD-Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Plugin/Plugin
  * HTMLArea.plugin class
  *
  * Every plugin should be a subclass of this class
@@ -25,10 +26,10 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        /**
         * Constructor method
         *
-        * @param object editor: a reference to the parent object, instance of RTE
-        * @param string pluginName: the name of the plugin
-        *
-        * @return boolean true if the plugin was configured
+        * @param {Object} editor: a reference to the parent object, instance of RTE
+        * @param {String} pluginName: the name of the plugin
+        * @constructor
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Plugin/Plugin
         */
        var Plugin = function (editor, pluginName) {
                this.editor = editor;
index bcfc3e4..767530e 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Toolbar/Button
  * A button in the toolbar
  */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
@@ -22,6 +23,10 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
 
        /**
         * Button constructor
+        *
+        * @param config
+        * @constructor
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Toolbar/Button
         */
        var Button = function (config) {
                Util.apply(this, config);               
index 3ae0be1..26f6e4a 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Toolbar/Select
  * A select field in the toolbar
  */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
@@ -23,6 +24,10 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
 
        /**
         * Select constructor
+        *
+        * @param {Object} config
+        * @constructor
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Toolbar/Select
         */
        var Select = function (config) {
                Util.apply(this, config);
index ad4ac5a..156ca48 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Toolbar/ToolbarText
  * A text item in the toolbar
  */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/DOM/DOM',
@@ -21,6 +22,10 @@ define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/DOM/DOM',
 
        /**
         * Toolbar text item constructor
+        *
+        * @param {Object} config
+        * @constructor
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Toolbar/ToolbarText
         */
        var ToolbarText = function (config) {
                Util.apply(this, config);
index fc7e5b6..0ef0d88 100644 (file)
@@ -12,7 +12,9 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent
  * Identify the current user agent
+ * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent
  */
 define([], function () {
 
index 058ee69..0bce6fc 100644 (file)
  *
  * The TYPO3 project - inspiring people to share!
  */
-/***************************************************
- *  Color utilities
- ***************************************************/
+/**
+ * AND-Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Color
+ * Color utilities
+ * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Color
+ */
 define([], function () {
 
        return {
index 7b3932a..865fc80 100644 (file)
  *
  * The TYPO3 project - inspiring people to share!
  */
-/***************************************************
- *  Make resizable
- ***************************************************/
+/**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Resizable
+ * Make resizable
+ */
 define(['jquery',
        'jquery-ui/resizable'],
        function ($, Resizable) {
 
+       /**
+        *
+        * @type {{makeResizable: Function, destroy: Function}}
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Resizable
+        */
        var Resizable = {
 
                /**
index 03c0940..807c8d4 100644 (file)
  *
  * The TYPO3 project - inspiring people to share!
  */
-/***************************************************
- *  Color utilities
- ***************************************************/
+/**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/String
+ * String utilities
+ * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/String
+ */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent'],
        function (UserAgent) {
 
index 6095b1b..c7631fb 100644 (file)
  *
  * The TYPO3 project - inspiring people to share!
  */
-/***************************************************
+/**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/TYPO3
  * HTMLArea.util.TYPO3: Utility functions for dealing with tabs and inline elements in TYPO3 forms
- ***************************************************/
+ * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/TYPO3
+ */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent',
        'TYPO3/CMS/Rtehtmlarea/HTMLArea/DOM/DOM'],
        function (UserAgent, Dom) {
index fb8c1c6..471f84e 100644 (file)
@@ -5,9 +5,17 @@
  * Intercept Ext.form.Field.afterRender in order to provide tips on form fields and menu items
  * Adapted from: http://www.extjs.com/forum/showthread.php?t=36642
  */
+/**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Tips
+ */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent'],
        function (UserAgent) {
 
+       /**
+        *
+        * @type {{tipsOnFormFields: Function, tipsOnMenuItems: Function}}
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Tips
+        */
        Tips = {
                tipsOnFormFields: function () {
                        if (this.helpText || this.helpTitle) {
index f606de4..b283a50 100644 (file)
  *
  * The TYPO3 project - inspiring people to share!
  */
-/***************************************************
- *  UTILITY FUNCTIONS
- ***************************************************/
+/**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Util
+ * UTILITY FUNCTIONS
+ */
 define(['TYPO3/CMS/Rtehtmlarea/HTMLArea/UserAgent/UserAgent'],
        function (UserAgent) {
 
+       /**
+        *
+        * @type {{htmlDecode: Function, htmlEncode: Function, emptyFunction: Function, apply: Function, applyIf: Function, inherit: Function, scrollBarWidth: null, getScrollBarWidth: Function, testCssPropertySupport: Function}}
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Util/Util
+        */
        var Util = {
 
                /**
index ea95368..640bd1a 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/HTMLArea/Modules/SelectImage
  * This module is used by the RTE SelectImage module
  */
 define(function () {
        'use strict';
 
+       /**
+        *
+        * @type {{editorNo: string, act: string, sys_language_content: string, RTEtsConfigParams: string, bparams: string, classesImage: boolean, labels: {}, initEventListeners: Function, jumpToUrl: Function}}
+        * @exports TYPO3/CMS/Rtehtmlarea/HTMLArea/Modules/SelectImage
+        */
        var SelectImage = {
                // The id of the current editor
                editorNo: '',
@@ -223,7 +229,7 @@ define(function () {
                /**
                 * Build the form and append it to the body of the document
                 *
-                * @param {string} classesImageJSOptions options of the class selector
+                * @param {String} classesImageJSOptions options of the class selector
                 * @param {array} removedProperties array of properties configured to be rmoved
                 * @param {bool} lockPlainWidth true if the plain image width is locked
                 * @param {bool} lockPlainHeight true if the plain image height is locked
index 6fe6067..d31d507 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Rtehtmlarea/RteLinkBrowser
  * LinkBrowser communication with parent window
  */
 define(['jquery', 'TYPO3/CMS/Recordlist/LinkBrowser'], function($, LinkBrowser) {
        'use strict';
 
+       /**
+        *
+        * @type {{plugin: null, HTMLArea: null}}
+        * @exports TYPO3/CMS/Rtehtmlarea/RteLinkBrowser
+        */
        var RteLinkBrowser = {
                plugin: null,
                HTMLArea: null
        };
 
+       /**
+        *
+        */
        RteLinkBrowser.initialize = function() {
                RteLinkBrowser.plugin = window.parent.RTEarea[LinkBrowser.urlParameters.editorNo].editor.getPlugin("TYPO3Link");
                RteLinkBrowser.HTMLArea = window.parent.HTMLArea;
index 76c7eb7..c18bbf2 100644 (file)
  * The TYPO3 project - inspiring people to share!
  */
 
+/**
+ * Module: TYPO3/CMS/Scheduler/Scheduler
+ */
 define(['jquery'], function($) {
 
+       /**
+        *
+        * @type {{}}
+        * @exports TYPO3/CMS/Scheduler/Scheduler
+        */
        var Scheduler = {};
 
        var allCheckedStatus = false;
@@ -20,6 +28,8 @@ define(['jquery'], function($) {
        /**
         * This method reacts on changes to the task class
         * It switches on or off the relevant extra fields
+        *
+        * @param {Object} theSelector
         */
        Scheduler.actOnChangedTaskClass = function(theSelector) {
                var taskClass = theSelector.val();
@@ -34,6 +44,8 @@ define(['jquery'], function($) {
        /**
         * This method reacts on changes to the type of a task, i.e. single or recurring,
         * by showing or hiding the relevant form fields
+        *
+        * @param {Object} theSelector
         */
        Scheduler.actOnChangedTaskType = function(theSelector) {
                // Get task type from selected value, or set default value
@@ -46,6 +58,8 @@ define(['jquery'], function($) {
 
        /**
         * This method reacts on field changes of all table field for table garbage collection task
+        *
+        * @param {Object} theCheckbox
         */
        Scheduler.actOnChangeSchedulerTableGarbageCollectionAllTables = function(theCheckbox) {
                var $numberOfDays = $('#task_tableGarbageCollection_numberOfDays');
@@ -73,6 +87,8 @@ define(['jquery'], function($) {
        /**
         * This methods set the 'number of days' field to the default expire period
         * of the selected table
+        *
+        * @param {Object} theSelector
         */
        Scheduler.actOnChangeSchedulerTableGarbageCollectionTable = function(theSelector) {
                var $numberOfDays = $('#task_tableGarbageCollection_numberOfDays');
@@ -87,6 +103,9 @@ define(['jquery'], function($) {
 
        /**
         * Check or uncheck all checkboxes
+        *
+        * @param {Object} theSelector
+        * @returns {Boolean}
         */
        Scheduler.checkOrUncheckAllCheckboxes = function(theSelector) {
                theSelector.parents('.tx_scheduler_mod1').find(':checkbox').prop('checked', !allCheckedStatus);
index f3eab53..a679c57 100644 (file)
@@ -12,7 +12,9 @@
  */
 
 /**
+ * Module: TYPO3/CMS/SysAction/ActionTask
  * JavaScript to handle confirm windows in the task center module
+ * @exports TYPO3/CMS/SysAction/ActionTask
  */
 define(['jquery', 'TYPO3/CMS/Backend/Modal'], function ($, Modal) {
        $(function() {
index d82a2e7..7ef510a 100644 (file)
@@ -12,7 +12,9 @@
  */
 
 /**
+ * Module: TYPO3/CMS/T3editor/FileEdit
  * File edit for ext:t3editor
+ * @exports TYPO3/CMS/T3editor/FileEdit
  */
 define(['jquery', 'TYPO3/CMS/T3editor/T3editor'], function ($, T3editor) {
        'use strict';
index 4cb0d09..3770111 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/T3editor/CodeCompletion/CompletionResult
  * Contains the CompletionResult class
  */
 define(['jquery'], function ($) {
+       /**
+        *
+        * @type {{tsRef: null, tsTreeNode: null}}
+        * @exports TYPO3/CMS/T3editor/CodeCompletion/CompletionResult
+        */
        var CompletionResult = {
                tsRef: null,
                tsTreeNode: null
        };
 
+       /**
+        *
+        * @param {Object} config
+        * @returns {{tsRef: null, tsTreeNode: null}}
+        */
        CompletionResult.init = function(config) {
                CompletionResult.tsRef = config.tsRef;
                CompletionResult.tsTreeNode = config.tsTreeNode;
@@ -29,6 +40,8 @@ define(['jquery'], function ($) {
 
        /**
         * returns the type of the currentTsTreeNode
+        *
+        * @returns {*}
         */
        CompletionResult.getType = function() {
                var val = CompletionResult.tsTreeNode.getValue();
index 5e3c18c..6e59d98 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/T3editor/CodeCompletion/DescriptionPlugin
  * Descriptionbox plugin for the t3editor-codecompletion which displays the datatype
  * and the desciption for each property displayed in the completionbox
  **/
@@ -20,12 +21,21 @@ define([
        'TYPO3/CMS/T3editor/Plugins/CodeCompletion/TsRef',
        'TYPO3/CMS/T3editor/Plugins/CodeCompletion/TsParser'
 ], function ($, TsRef, TsParser) {
+       /**
+        *
+        * @type {{codeCompleteBox: null, codemirror: null, $descriptionBox: (*|jQuery)}}
+        * @exports TYPO3/CMS/T3editor/CodeCompletion/DescriptionPlugin
+        */
        var DescriptionPlugin = {
                codeCompleteBox: null,
                codemirror: null,
                $descriptionBox: $('<div />', {class: 't3e_descriptionBox'}).hide()
        };
 
+       /**
+        *
+        * @param pluginContext
+        */
        DescriptionPlugin.init = function(pluginContext) {
                DescriptionPlugin.codeCompleteBox = pluginContext.codeCompleteBox;
                DescriptionPlugin.codemirror = pluginContext.codemirror;
@@ -35,30 +45,62 @@ define([
                }
        };
 
+       /**
+        *
+        * @param {Object} currWordObj
+        * @param {Object} compResult
+        */
        DescriptionPlugin.afterMouseOver = function(currWordObj, compResult) {
                DescriptionPlugin.refreshBox(currWordObj, compResult);
        };
 
+       /**
+        *
+        * @param {Object} currWordObj
+        * @param {Object} compResult
+        */
        DescriptionPlugin.afterKeyDown = function(currWordObj, compResult) {
                DescriptionPlugin.refreshBox(currWordObj, compResult);
        };
 
+       /**
+        *
+        * @param {Object} currWordObj
+        * @param {Object} compResult
+        */
        DescriptionPlugin.afterKeyUp = function(currWordObj, compResult) {
                DescriptionPlugin.refreshBox(currWordObj, compResult);
        };
 
+       /**
+        *
+        * @param {Object} currWordObj
+        * @param {Object} compResult
+        */
        DescriptionPlugin.afterCCRefresh = function(currWordObj, compResult) {
                DescriptionPlugin.refreshBox(currWordObj, compResult);
        };
 
+       /**
+        *
+        * @param {String} desc
+        */
        DescriptionPlugin.descriptionLoaded = function(desc) {
                $('#TSREF_description').html(desc);
        };
 
+       /**
+        *
+        */
        DescriptionPlugin.endCodeCompletion = function() {
                DescriptionPlugin.$descriptionBox.hide();
        };
 
+       /**
+        *
+        * @param {Object} proposalObj
+        * @param {Object} compResult
+        */
        DescriptionPlugin.refreshBox = function(proposalObj, compResult) {
                var type = compResult.getType();
 
index 24ffb8a..0a6ee17 100644 (file)
@@ -12,6 +12,7 @@
  */
 
 /**
+ * Module: TYPO3/CMS/T3editor/CodeCompletion/TsCodeCompletion
  * Contains the TsCodeCompletion class
  */
 define([
@@ -20,6 +21,11 @@ define([
        'TYPO3/CMS/T3editor/Plugins/CodeCompletion/TsParser',
        'TYPO3/CMS/T3editor/Plugins/CodeCompletion/CompletionResult'
 ], function ($, TsRef, TsParser, CompletionResult) {
+       /**
+        *
+        * @type {{tsRef: *, outerDiv: null, options: {ccWords: number}, index: number, currWord: number, cc_up: null, cc_down: null, mousePos: {x: number, y: number}, proposals: null, compResult: null, cc: number, linefeedsPrepared: boolean, currentCursorPosition: null, extTsObjTree: {}, latestCursorNode: null, codemirror: null, parser: null, plugins: string[], $codeCompleteBox: (*|jQuery)}}
+        * @exports TYPO3/CMS/T3editor/CodeCompletion/TsCodeCompletion
+        */
        var TsCodeCompletion = {
                tsRef: TsRef,
                outerDiv: null,
@@ -108,7 +114,7 @@ define([
        /**
         * Get the value of a given GET parameter
         *
-        * @param name
+        * @param {String} name
         * @return {String}
         */
        TsCodeCompletion.getGetVar = function(name) {
@@ -148,6 +154,8 @@ define([
        /**
         * Since the references are not resolved server side we have to do it client-side
         * Benefit: less loading time due to less data which has to be transmitted
+        *
+        * @param {Array} childNodes
         */
        TsCodeCompletion.resolveExtReferencesRec = function(childNodes) {
                for (var key in childNodes) {
@@ -175,7 +183,7 @@ define([
        /**
         * Get the child node of given path
         *
-        * @param path
+        * @param {String} path
         * @returns {Object}
         */
        TsCodeCompletion.getExtChildNode = function(path) {
@@ -214,10 +222,18 @@ define([
                TsCodeCompletion.linefeedsPrepared = true;
        };
 
+       /**
+        *
+        */
        TsCodeCompletion.click = function() {
                TsCodeCompletion.endAutoCompletion();
        };
 
+       /**
+        *
+        * @param cursorNode
+        * @returns {*}
+        */
        TsCodeCompletion.getFilter = function(cursorNode) {
                if (cursorNode.currentText) {
                        var filter = cursorNode.currentText.replace('.', '');
@@ -226,6 +242,9 @@ define([
                return '';
        };
 
+       /**
+        * @returns {*}
+        */
        TsCodeCompletion.getCursorNode = function() {
                var cursorNode = TsCodeCompletion.codemirror.win.select.selectionTopNode(TsCodeCompletion.codemirror.win.document.body, false);
                // cursorNode is null if the cursor is positioned at the beginning of the first line
@@ -238,6 +257,11 @@ define([
                return cursorNode;
        };
 
+       /**
+        *
+        * @param {Object} cursor
+        * @returns {String}
+        */
        TsCodeCompletion.getCurrentLine = function(cursor) {
                var line = '',
                        currentNode = cursor.start.node.parentNode;
@@ -262,7 +286,7 @@ define([
         * Eventhandler function executed after keystroke release
         * triggers CC on pressed dot and typing on
         *
-        * @param e fired prototype event object
+        * @param {Event} e fired prototype event object
         * @type void
         */
        TsCodeCompletion.keyUp = function(e) {
@@ -290,7 +314,7 @@ define([
        /**
         * Highlights entry in codecomplete box by id
         *
-        * @param {Integer} id
+        * @param {Number} id
         */
        TsCodeCompletion.mouseOver = function(id) {
                TsCodeCompletion.highlightCurrWord(id);
@@ -316,7 +340,7 @@ define([
         * Eventhandler function executed after keystroke release
         * triggers CC on pressed dot and typing on
         *
-        * @param e fired prototype event object
+        * @param {Event} e fired prototype event object
         */
        TsCodeCompletion.keyDown = function(e) {
                if (!TsCodeCompletion.linefeedsPrepared) {
@@ -540,7 +564,7 @@ define([
        /**
         * Highlight the active word in the code completion list
         *
-        * @param {Integer} id
+        * @param {Number} id
         */
        TsCodeCompletion.highlightCurrWord = function(id) {
                if (TsCodeCompletion.currWord !== -1) {
index b66803d..ea800d8 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/T3editor/CodeCompletion/TsParser
  * Contains the TsCodeCompletion class
  */
 define([
        'jquery', 'TYPO3/CMS/T3editor/Plugins/CodeCompletion/TsRef'
 ], function ($) {
+       /**
+        *
+        * @type {{typeId: null, properties: null, typeTree: Array, doc: null, tsRef: null, extTsObjTree: Array, tsTree: null}}
+        * @exports TYPO3/CMS/T3editor/CodeCompletion/TsParser
+        */
        var TsParser = {
                typeId: null,
                properties: null,
@@ -27,6 +33,12 @@ define([
                tsTree: null
        };
 
+       /**
+        *
+        * @param {Object} tsRef
+        * @param {Object} extTsObjTree
+        * @returns {{typeId: null, properties: null, typeTree: Array, doc: null, tsRef: null, extTsObjTree: Array, tsTree: null}}
+        */
        TsParser.init = function(tsRef, extTsObjTree) {
                TsParser.tsRef = tsRef;
                TsParser.extTsObjTree = extTsObjTree;
@@ -35,6 +47,10 @@ define([
                return TsParser;
        };
 
+       /**
+        *
+        * @param {String} nodeName
+        */
        TsParser.treeNode = function(nodeName) {
                this.name = nodeName;
                this.childNodes = [];
@@ -373,7 +389,8 @@ define([
         * Iterates through the object tree, and creates treenodes
         * along the path, if necessary
         *
-        * @return {Object}
+        * @param {String} path
+        * @returns {Object}
         */
        TsParser.getTreeNode = function(path) {
                path = $.trim(path);
@@ -414,6 +431,9 @@ define([
        /**
         * Navigates to the respecting treenode,
         * create nodes in the path, if necessary, and sets the value
+        *
+        * @param {String} path
+        * @param {String} value
         */
        TsParser.setTreeNodeValue = function(path, value) {
                var treeNode = TsParser.getTreeNode(path);
@@ -434,6 +454,8 @@ define([
        /**
         * Navigates to the respecting treenode,
         * creates nodes if necessary, empties the value and childNodes-Array
+        *
+        * @param {String} path
         */
        TsParser.deleteTreeNodeValue = function(path) {
                var treeNode = TsParser.getTreeNode(path);
@@ -446,6 +468,9 @@ define([
        /**
         * Copies a reference of the treeNode specified by path2
         * to the location specified by path1
+        *
+        * @param {String} path1
+        * @param {String} path2
         */
        TsParser.setReference = function(path1, path2) {
                var path1arr = path1.split('.'),
@@ -463,6 +488,9 @@ define([
        /**
         * copies a treeNode specified by path2
         * to the location specified by path1
+        *
+        * @param {String} path1
+        * @param {String} path2
         */
        TsParser.setCopy = function(path1, path2) {
                this.clone = function(myObj) {
index 2801bbf..18dfc3b 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/T3editor/CodeCompletion/TsRef
  * Contains the TsCodeCompletion class
  */
 define(['jquery'], function ($) {
+       /**
+        *
+        * @type {{typeId: null, properties: null, typeTree: Array, doc: null}}
+        * @exports TYPO3/CMS/T3editor/CodeCompletion/TsRef
+        */
        var TsRef = {
                typeId: null,
                properties: null,
@@ -39,9 +45,10 @@ define(['jquery'], function ($) {
        /**
         * Prototypes a TS reference property object
         *
-        * @param {String} typeId
+        * @param {String} parentType
         * @param {String} name
         * @param {String} value
+        * @constructor
         */
        TsRef.TsRefProperty = function(parentType, name, value) {
                this.parentType = parentType;
index 6870ba6..11de224 100644 (file)
  * The TYPO3 project - inspiring people to share!
  */
 
+/**
+ * Module: TYPO3/CMS/T3editor/T3editor
+ */
 define(['jquery', 'TYPO3/CMS/Backend/SplitButtons'], function ($, SplitButtons) {
        'use strict';
 
+       /**
+        *
+        * @type {{instances: {}}}
+        * @exports TYPO3/CMS/T3editor/T3editor
+        */
        var T3editor = {
                instances: {}
        };
@@ -29,6 +37,9 @@ define(['jquery', 'TYPO3/CMS/Backend/SplitButtons'], function ($, SplitButtons)
 
        /**
         * Initialize an editor
+        *
+        * @param {Object} $editor
+        * @param {Number} index
         */
        T3editor.initializeEditor = function($editor, index) {
                var $textarea = $editor.find('textarea'),
@@ -66,6 +77,8 @@ define(['jquery', 'TYPO3/CMS/Backend/SplitButtons'], function ($, SplitButtons)
 
        /**
         * Initializes editor events
+        *
+        * @param {Object} codemirror
         */
        T3editor.initializeEditorEvents = function(codemirror) {
                SplitButtons.addPreSubmitCallback(function() {
@@ -82,6 +95,8 @@ define(['jquery', 'TYPO3/CMS/Backend/SplitButtons'], function ($, SplitButtons)
 
        /**
         * Set the ajax save callback
+        *
+        * @param {Object} codemirror
         */
        T3editor.setAjaxSavetypeCallback = function(codemirror) {
                if (codemirror.options.ajaxSaveType !== '') {
@@ -111,6 +126,8 @@ define(['jquery', 'TYPO3/CMS/Backend/SplitButtons'], function ($, SplitButtons)
 
        /**
         * Save method called upon saving
+        *
+        * @param {Object} codemirror
         */
        T3editor.saveFunction = function(codemirror) {
                if (!codemirror.options.ajaxSaveType || codemirror.options.ajaxSaveType === '') {
@@ -126,6 +143,10 @@ define(['jquery', 'TYPO3/CMS/Backend/SplitButtons'], function ($, SplitButtons)
 
        /**
         * Method invoked by saveFunction() on completion
+        *
+        * @param {Object} codemirror
+        * @param {Boolean} wasSuccessful
+        * @param {Object} returnedData
         */
        T3editor.saveFunctionComplete = function(codemirror, wasSuccessful, returnedData) {
                if (wasSuccessful) {
@@ -141,6 +162,8 @@ define(['jquery', 'TYPO3/CMS/Backend/SplitButtons'], function ($, SplitButtons)
 
        /**
         * Updates the textarea
+        *
+        * @param {Object} codemirror
         */
        T3editor.updateTextarea = function(codemirror) {
                codemirror.options.originalTextarea.val(codemirror.editor.getCode());
@@ -148,6 +171,10 @@ define(['jquery', 'TYPO3/CMS/Backend/SplitButtons'], function ($, SplitButtons)
 
        /**
         * Resize the editor
+        *
+        * @param {Object} codemirror
+        * @param {Number} w
+        * @param {Number} h
         */
        T3editor.resize = function(codemirror, w, h) {
                var width = (w + 11),
@@ -161,6 +188,8 @@ define(['jquery', 'TYPO3/CMS/Backend/SplitButtons'], function ($, SplitButtons)
 
        /**
         * Toggle fullscreen mode of editor
+        *
+        * @param {Object} codemirror
         */
        T3editor.toggleFullscreen = function(codemirror) {
                var $outerDiv = codemirror.options.originalTextarea.prev('.t3e_wrap'),
index 9e41970..3cc6419 100644 (file)
  * The TYPO3 project - inspiring people to share!
  */
 
+/**
+ * Module: TYPO3/CMS/Taskcenter/Taskcenter
+ */
 define(['jquery', 'jquery-ui/sortable'], function($) {
        'use strict';
 
+       /**
+        *
+        * @type {{}}
+        * @exports  TYPO3/CMS/Taskcenter/Taskcenter
+        */
        var Taskcenter = {};
 
+       /**
+        *
+        */
        Taskcenter.resizeIframe = function() {
                var $listFrame = $('#list_frame');
                if ($listFrame.length > 0) {
@@ -32,6 +43,10 @@ define(['jquery', 'jquery-ui/sortable'], function($) {
                }
        };
 
+       /**
+        *
+        * @param {Object} element
+        */
        Taskcenter.doCollapseOrExpand = function(element) {
                var itemParent = element.parent();
                var item = element.next('div').next('div').next('div').next('div');
@@ -56,6 +71,9 @@ define(['jquery', 'jquery-ui/sortable'], function($) {
                });
        };
 
+       /**
+        *
+        */
        Taskcenter.initializeSorting = function() {
                $('#task-list').sortable({
                        update: function(event, ui) {
index 488ffb9..ee64ee6 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Tstemplate/ConstantEditor
  * Various functions related to the Constant Editor
  * e.g. updating the field and working with colors
  */
 define(['jquery'], function($) {
        'use strict';
 
+       /**
+        *
+        * @type {{options: {editIconSelector: string, colorSelectSelector: string, colorInputSelector: string}}}
+        * @exports TYPO3/CMS/Tstemplate/ConstantEditor
+        */
        var ConstantEditor = {
                options: {
                        editIconSelector: '.typo3-tstemplate-ceditor-control',
@@ -28,6 +34,8 @@ define(['jquery'], function($) {
 
        /**
         * initially register event listeners
+        *
+        * @param {Object} $editIcon
         */
        ConstantEditor.changeProperty = function($editIcon) {
                var constantName = $editIcon.attr('rel');
@@ -50,6 +58,8 @@ define(['jquery'], function($) {
 
        /**
         * updates the color from a dropdown
+        *
+        * @param {Object} $colorSelect
         */
        ConstantEditor.updateColorFromSelect = function($colorSelect) {
                var constantName = $colorSelect.attr('rel');
@@ -61,6 +71,8 @@ define(['jquery'], function($) {
 
        /**
         * updates the color from an input field
+        *
+        * @param {Object} $colorInput
         */
        ConstantEditor.updateColorFromInput = function($colorInput) {
                var constantName = $colorInput.attr('rel');
index 2acd62e..e3dd9d3 100644 (file)
@@ -12,7 +12,9 @@
  */
 
 /**
+ * Module: TYPO3/CMS/Tstemplate/TypoScriptObjectBrowser
  * JavaScript for TypoScript Object Browser
+ * @exports TYPO3/CMS/Tstemplate/TypoScriptObjectBrowser
  */
 define(['jquery', 'TYPO3/CMS/Backend/jquery.clearable'], function($) {
 
index 18dc24d..e9ac32a 100644 (file)
  * The TYPO3 project - inspiring people to share!
  */
 /**
+ * Module: TYPO3/CMS/Viewpage/Main
  * Main logic for resizing the view of the frame
  */
 define(['jquery', 'TYPO3/CMS/Backend/Storage', 'jquery-ui/resizable'], function($, Storage) {
        'use strict';
 
+       /**
+        *
+        * @type {{resizableContainerIdentifier: string, widthSelectorIdentifier: string, moduleBodySelector: string, storagePrefix: string, $iframe: null, $languageSelector: null, $resizableContainer: null, $widthSelector: null}}
+        * @exports TYPO3/CMS/Viewpage/Main
+        */
        var ViewPage = {
                resizableContainerIdentifier: '#resizeable',
                widthSelectorIdentifier: '#width',
@@ -27,6 +33,9 @@ define(['jquery', 'TYPO3/CMS/Backend/Storage', 'jquery-ui/resizable'], function(
                $widthSelector: null
        };
 
+       /**
+        *
+        */
        ViewPage.initialize = function() {
                ViewPage.$iframe = $('#tx_viewpage_iframe');
                ViewPage.$languageSelector = $('#language');
@@ -123,6 +132,10 @@ define(['jquery', 'TYPO3/CMS/Backend/Storage', 'jquery-ui/resizable'], function(
                });
        };
 
+       /**
+        *
+        * @returns {Number}
+        */
        ViewPage.calculateContainerMaxHeight = function() {
                ViewPage.$resizableContainer.hide();
                var $moduleBody = $(ViewPage.moduleBodySelector);
@@ -133,15 +146,29 @@ define(['jquery', 'TYPO3/CMS/Backend/Storage', 'jquery-ui/resizable'], function(
                return documentHeight - (controlsHeight + padding);
        };
 
+       /**
+        *
+        * @param {String} value
+        */
        ViewPage.addCustomWidthOption = function(value) {
                ViewPage.$widthSelector.prepend('<option id="customOption" value="' + value + '">' + ViewPage.getOptionLabel(value) + '</option>');
        };
 
+       /**
+        *
+        * @param {String} data
+        * @returns {String}
+        */
        ViewPage.getOptionLabel = function(data) {
                data = data.split('|');
                return data[0] + 'px ' + (data[1] ? '× ' + data[1] + 'px ' : '') + TYPO3.lang['customWidth'];
        };
 
+       /**
+        *
+        * @param {String} url
+        * @returns {{}}
+        */
        ViewPage.getUrlVars = function(url) {
                var vars = {};
                var hash;
index bf28688..42187c5 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/WizardCrpages/WizardCreatePages
  * JavaScript functions for creating multiple pages
  */
 define(['jquery'], function($) {
        'use strict';
 
+       /**
+        *
+        * @type {{lineCounter: number, containerSelector: string, addMoreFieldsButtonSelector: string, doktypeSelector: string}}
+        * @exports TYPO3/CMS/WizardCrpages/WizardCreatePages
+        */
        var WizardCreatePages = {
                lineCounter: 5,
                containerSelector: '.t3js-wizardcrpages-container',
@@ -24,6 +30,9 @@ define(['jquery'], function($) {
                doktypeSelector: '.t3js-wizardcrpages-select-doktype'
        };
 
+       /**
+        *
+        */
        WizardCreatePages.createNewFormFields = function() {
                for (var i = 0; i < 5; i++) {
                        var label = WizardCreatePages.lineCounter + i + 1;
@@ -36,6 +45,10 @@ define(['jquery'], function($) {
                WizardCreatePages.lineCounter += 5;
        };
 
+       /**
+        *
+        * @param {Object} $selectElement
+        */
        WizardCreatePages.actOnTypeSelectChange = function($selectElement) {
                var $optionElement = $selectElement.find(':selected');
                var $target = $($selectElement.data('target'));
index 0b34c72..184c85e 100644 (file)
  */
 
 /**
+ * Module: TYPO3/CMS/Workspaces/Toolbar/WorkspacesMenu
  * toolbar menu for the workspaces functionality to switch between the workspaces
  * and jump to the workspaces module
  */
 define(['jquery'], function($) {
        'use strict';
 
+       /**
+        *
+        * @type {{options: {containerSelector: string, menuItemSelector: string, activeMenuItemSelector: string, toolbarItemSelector: string, workspaceBodyClass: string, workspacesTitleInToolbarClass: string, workspaceModuleLinkSelector: string}}}
+        * @exports TYPO3/CMS/Workspaces/Toolbar/WorkspacesMenu
+        */
        var WorkspacesMenu = {
                options: {
                        containerSelector: '#typo3-cms-workspaces-backend-toolbaritems-workspaceselectortoolbaritem',
@@ -51,6 +57,8 @@ define(['jquery'], function($) {
        /**
         * switches the workspace via AJAX (which returns the new data, as JSON),
         * then reloads the module menu, and the content frame
+        *
+        * @param {String} workspaceId
         */
        WorkspacesMenu.switchWorkspace = function(workspaceId) {
                $.ajax({
@@ -96,8 +104,8 @@ define(['jquery'], function($) {
        /**
         * changes the data in the module menu and the updates the backend context
         *
-        * @param id the workspace ID
-        * @param title the workspace title
+        * @param {String} id the workspace ID
+        * @param {String} title the workspace title
         */
        WorkspacesMenu.performWorkspaceSwitch = function(id, title) {
                top.TYPO3.Workspaces.workspaceTitle = title;
@@ -122,6 +130,8 @@ define(['jquery'], function($) {
        /**
         * checks if the TYPO3 backend is within a backend context and adds a class
         * also updates the workspaces title
+        *
+        * @param {String} title
         */
        WorkspacesMenu.updateBackendContext = function(title) {
 
@@ -137,7