diff --git Gruntfile.js Gruntfile.js index 2c213492a..0dba145a7 100644 --- Gruntfile.js +++ Gruntfile.js @@ -420,6 +420,14 @@ module.exports = function(grunt) { } } }, + jsdoc : { + dist : { + dest: "jsdoc", + options: { + configure : "jsdoc.conf.json" + } + } + }, qunit: { files: [ 'tests/qunit/**/*.html', diff --git jsdoc.conf.json jsdoc.conf.json new file mode 100644 index 000000000..2ffd6660a --- /dev/null +++ jsdoc.conf.json @@ -0,0 +1,40 @@ +{ + "plugins": [], + "recurseDepth": 10, + "source": { + "include": ["src/wp-includes/js"], + "exclude": [ + "src/wp-includes/js/tinymce", + "src/wp-includes/js/crop", + "src/wp-includes/js/imgareaselect", + "src/wp-includes/js/jcrop", + "src/wp-includes/js/jquery", + "src/wp-includes/js/mediaelement", + "src/wp-includes/js/swfupload", + "src/wp-includes/js/thickbox", + "src/wp-includes/js/media-audiovideo.js", + "src/wp-includes/js/media-grid.js", + "src/wp-includes/js/media-models.js", + "src/wp-includes/js/media-views.js" + ], + "includePattern": ".+\\.js(doc|x)?$", + "excludePattern": "(^|\\/|\\\\)_" + }, + "sourceType": "module", + "tags": { + "allowUnknownTags": true, + "dictionaries": ["jsdoc","closure"] + }, + "templates": { + "cleverLinks": false, + "monospaceLinks": false, + "theme": "united", + "outputSourceFiles": true, + "outputSourcePath": true, + "linenums": true + }, + "opts": { + "template": "./node_modules/ink-docstrap/template", + "recurse": true + } +} diff --git package.json package.json index 0fda642c4..536eb6060 100644 --- package.json +++ package.json @@ -26,6 +26,7 @@ "grunt-contrib-uglify": "~2.0.0", "grunt-contrib-watch": "~1.0.0", "grunt-includes": "~0.5.1", + "grunt-jsdoc": "^2.1.0", "grunt-jsvalidate": "~0.2.2", "grunt-legacy-util": "^0.2.0", "grunt-patch-wordpress": "~0.4.2", @@ -33,6 +34,7 @@ "grunt-replace": "~1.0.1", "grunt-rtlcss": "~2.0.1", "grunt-sass": "~1.2.1", + "ink-docstrap": "^1.3.0", "matchdep": "~1.0.0" } } diff --git src/wp-includes/js/api-request.js src/wp-includes/js/api-request.js index 2ec605bf3..f0a84ef48 100644 --- src/wp-includes/js/api-request.js +++ src/wp-includes/js/api-request.js @@ -8,7 +8,6 @@ * - Sends the REST API nonce as a request header. * - Allows specifying only an endpoint namespace/path instead of a full URL. * - * @namespace wp.apiRequest * @since 4.9.0 */ @@ -82,6 +81,7 @@ apiRequest.transport = $.ajax; + /** @namespace wp */ window.wp = window.wp || {}; window.wp.apiRequest = apiRequest; } )( jQuery ); diff --git src/wp-includes/js/autosave.js src/wp-includes/js/autosave.js index e88943d6d..75196d955 100644 --- src/wp-includes/js/autosave.js +++ src/wp-includes/js/autosave.js @@ -597,6 +597,7 @@ window.autosave = function() { }; } + /** @namespace wp */ window.wp = window.wp || {}; window.wp.autosave = autosave(); diff --git src/wp-includes/js/customize-base.js src/wp-includes/js/customize-base.js index 3fdb92423..4fc848cb3 100644 --- src/wp-includes/js/customize-base.js +++ src/wp-includes/js/customize-base.js @@ -1,3 +1,4 @@ +/** @namespace wp */ window.wp = window.wp || {}; (function( exports, $ ){ @@ -165,9 +166,12 @@ window.wp = window.wp || {}; /** * Observable values that support two-way binding. * + * @memberOf wp.customize + * @alias wp.customize.Value + * * @constructor */ - api.Value = api.Class.extend({ + api.Value = api.Class.extend(/** @lends wp.customize.Value.prototype */{ /** * @param {mixed} initial The initial value. * @param {object} options @@ -304,11 +308,14 @@ window.wp = window.wp || {}; /** * A collection of observable values. * + * @memberOf wp.customize + * @alias wp.customize.Values + * * @constructor * @augments wp.customize.Class * @mixes wp.customize.Events */ - api.Values = api.Class.extend({ + api.Values = api.Class.extend(/** @lends wp.customize.Values.prototype */{ /** * The default constructor for items of the collection. @@ -520,11 +527,14 @@ window.wp = window.wp || {}; * * Handles inputs, selects, and textareas by default. * + * @memberOf wp.customize + * @alias wp.customize.Element + * * @constructor * @augments wp.customize.Value * @augments wp.customize.Class */ - api.Element = api.Value.extend({ + api.Element = api.Value.extend(/** @lends wp.customize.Element */{ initialize: function( element, options ) { var self = this, synchronizer = api.Element.synchronizer.html, @@ -617,11 +627,14 @@ window.wp = window.wp || {}; /** * A communicator for sending data from one window to another over postMessage. * + * @memberOf wp.customize + * @alias wp.customize.Messenger + * * @constructor * @augments wp.customize.Class * @mixes wp.customize.Events */ - api.Messenger = api.Class.extend({ + api.Messenger = api.Class.extend(/** @lends wp.customize.Messenger.prototype */{ /** * Create a new Value. * @@ -765,6 +778,9 @@ window.wp = window.wp || {}; * @augments wp.customize.Class * @since 4.6.0 * + * @memberOf wp.customize + * @alias wp.customize.Notification + * * @param {string} code - The error code. * @param {object} params - Params. * @param {string} params.message=null - The error message. @@ -773,7 +789,7 @@ window.wp = window.wp || {}; * @param {string} [params.setting=null] - The setting ID that the notification is related to. * @param {*} [params.data=null] - Any additional data. */ - api.Notification = api.Class.extend({ + api.Notification = api.Class.extend(/** @lends wp.customize.Notification.prototype */{ initialize: function( code, params ) { var _params; this.code = code; @@ -798,6 +814,8 @@ window.wp = window.wp || {}; /** * Get all customize settings. * + * @memberOf wp.customize + * * @return {object} */ api.get = function() { @@ -810,9 +828,7 @@ window.wp = window.wp || {}; return result; }; - /** - * Utility function namespace - */ + /** @namespace wp.customize.utils */ api.utils = {}; /** @@ -820,6 +836,7 @@ window.wp = window.wp || {}; * * @since 4.7.0 * @access public + * @memberOf wp.customize.utils * * @param {string} queryString Query string. * @returns {object} Parsed query string. @@ -844,6 +861,6 @@ window.wp = window.wp || {}; return queryParams; }; - // Expose the API publicly on window.wp.customize + /** @namespace wp.customize */ exports.customize = api; })( wp, jQuery ); diff --git src/wp-includes/js/customize-loader.js src/wp-includes/js/customize-loader.js index 1990d1a24..c1cd81582 100644 --- src/wp-includes/js/customize-loader.js +++ src/wp-includes/js/customize-loader.js @@ -1,8 +1,5 @@ /* global _wpCustomizeLoaderSettings, confirm */ -/* - * Expose a public API that allows the customizer to be - * loaded on any page. - */ +/** @namespace wp */ window.wp = window.wp || {}; (function( exports, $ ){ @@ -22,9 +19,12 @@ window.wp = window.wp || {}; * * e.g. Open Customizer * + * @memberOf wp.customize + * + * @class * @augments wp.customize.Events */ - Loader = $.extend( {}, api.Events, { + Loader = $.extend( {}, api.Events,/** @lends wp.customize.Loader.prototype */{ /** * Setup the Loader; triggered on document#ready. */ diff --git src/wp-includes/js/customize-models.js src/wp-includes/js/customize-models.js index 9d6e088c5..372cad627 100644 --- src/wp-includes/js/customize-models.js +++ src/wp-includes/js/customize-models.js @@ -1,6 +1,7 @@ /* global _wpCustomizeHeader */ (function( $, wp ) { var api = wp.customize; + /** @namespace wp.customize.HeaderTool */ api.HeaderTool = {}; @@ -13,10 +14,13 @@ * These calls are made regardless of whether the user actually saves new * Customizer settings. * + * @memberOf wp.customize.HeaderTool + * @alias wp.customize.HeaderTool.ImageModel + * * @constructor * @augments Backbone.Model */ - api.HeaderTool.ImageModel = Backbone.Model.extend({ + api.HeaderTool.ImageModel = Backbone.Model.extend(/** @lends wp.customize.HeaderTool.ImageModel.prototype */{ defaults: function() { return { header: { @@ -125,6 +129,9 @@ /** * wp.customize.HeaderTool.ChoiceList * + * @memberOf wp.customize.HeaderTool + * @alias wp.customize.HeaderTool.ChoiceList + * * @constructor * @augments Backbone.Collection */ @@ -232,6 +239,9 @@ /** * wp.customize.HeaderTool.DefaultsList * + * @memberOf wp.customize.HeaderTool + * @alias wp.customize.HeaderTool.DefaultsList + * * @constructor * @augments wp.customize.HeaderTool.ChoiceList * @augments Backbone.Collection diff --git src/wp-includes/js/customize-preview-nav-menus.js src/wp-includes/js/customize-preview-nav-menus.js index 6745b41be..b328e67e9 100644 --- src/wp-includes/js/customize-preview-nav-menus.js +++ src/wp-includes/js/customize-preview-nav-menus.js @@ -1,4 +1,6 @@ /* global _wpCustomizePreviewNavMenusExports */ + +/** @namespace wp.customize.navMenusPreview */ wp.customize.navMenusPreview = wp.customize.MenusCustomizerPreview = ( function( $, _, wp, api ) { 'use strict'; @@ -72,11 +74,14 @@ wp.customize.navMenusPreview = wp.customize.MenusCustomizerPreview = ( function( /** * Partial representing an invocation of wp_nav_menu(). * + * @memberOf wp.customize.navMenusPreview + * @alias wp.customize.navMenusPreview.NavMenuInstancePartial + * * @class * @augments wp.customize.selectiveRefresh.Partial * @since 4.5.0 */ - self.NavMenuInstancePartial = api.selectiveRefresh.Partial.extend({ + self.NavMenuInstancePartial = api.selectiveRefresh.Partial.extend(/** @lends wp.customize.navMenusPreview.NavMenuInstancePartial.prototype */{ /** * Constructor. diff --git src/wp-includes/js/customize-preview-widgets.js src/wp-includes/js/customize-preview-widgets.js index 6c05e8943..b981788ed 100644 --- src/wp-includes/js/customize-preview-widgets.js +++ src/wp-includes/js/customize-preview-widgets.js @@ -1,4 +1,6 @@ /* global _wpWidgetCustomizerPreviewSettings */ + +/** @namespace wp.customize.widgetsPreview */ wp.customize.widgetsPreview = wp.customize.WidgetCustomizerPreview = (function( $, _, wp, api ) { var self; @@ -42,11 +44,14 @@ wp.customize.widgetsPreview = wp.customize.WidgetCustomizerPreview = (function( /** * Partial representing a widget instance. * + * @memberOf wp.customize.widgetsPreview + * @alias wp.customize.widgetsPreview.WidgetPartial + * * @class * @augments wp.customize.selectiveRefresh.Partial * @since 4.5.0 */ - self.WidgetPartial = api.selectiveRefresh.Partial.extend({ + self.WidgetPartial = api.selectiveRefresh.Partial.extend(/** @lends wp.customize.widgetsPreview.WidgetPartial.prototype */{ /** * Constructor. @@ -112,11 +117,14 @@ wp.customize.widgetsPreview = wp.customize.WidgetCustomizerPreview = (function( /** * Partial representing a widget area. * + * @memberOf wp.customize.widgetsPreview + * @alias wp.customize.widgetsPreview.SidebarPartial + * * @class * @augments wp.customize.selectiveRefresh.Partial * @since 4.5.0 */ - self.SidebarPartial = api.selectiveRefresh.Partial.extend({ + self.SidebarPartial = api.selectiveRefresh.Partial.extend(/** @lends wp.customize.widgetsPreview.SidebarPartial.prototype */{ /** * Constructor. @@ -510,6 +518,8 @@ wp.customize.widgetsPreview = wp.customize.WidgetCustomizerPreview = (function( /** * Calculate the selector for the sidebar's widgets based on the registered sidebar's info. * + * @memberOf wp.customize.widgetsPreview + * * @since 3.9.0 */ self.buildWidgetSelectors = function() { @@ -548,6 +558,8 @@ wp.customize.widgetsPreview = wp.customize.WidgetCustomizerPreview = (function( /** * Highlight the widget on widget updates or widget control mouse overs. * + * @memberOf wp.customize.widgetsPreview + * * @since 3.9.0 * @param {string} widgetId ID of the widget. */ @@ -567,6 +579,8 @@ wp.customize.widgetsPreview = wp.customize.WidgetCustomizerPreview = (function( * Show a title and highlight widgets on hover. On shift+clicking * focus the widget control. * + * @memberOf wp.customize.widgetsPreview + * * @since 3.9.0 */ self.highlightControls = function() { @@ -598,6 +612,8 @@ wp.customize.widgetsPreview = wp.customize.WidgetCustomizerPreview = (function( /** * Parse a widget ID. * + * @memberOf wp.customize.widgetsPreview + * * @since 4.5.0 * * @param {string} widgetId Widget ID. @@ -623,6 +639,8 @@ wp.customize.widgetsPreview = wp.customize.WidgetCustomizerPreview = (function( /** * Parse a widget setting ID. * + * @memberOf wp.customize.widgetsPreview + * * @since 4.5.0 * * @param {string} settingId Widget setting ID. @@ -648,6 +666,8 @@ wp.customize.widgetsPreview = wp.customize.WidgetCustomizerPreview = (function( /** * Convert a widget ID into a Customizer setting ID. * + * @memberOf wp.customize.widgetsPreview + * * @since 4.5.0 * * @param {string} widgetId Widget ID. diff --git src/wp-includes/js/customize-preview.js src/wp-includes/js/customize-preview.js index adb9f0384..12a9da121 100644 --- src/wp-includes/js/customize-preview.js +++ src/wp-includes/js/customize-preview.js @@ -87,12 +87,15 @@ }; /** + * @memberOf wp.customize + * @alias wp.customize.Preview + * * @constructor * @augments wp.customize.Messenger * @augments wp.customize.Class * @mixes wp.customize.Events */ - api.Preview = api.Messenger.extend({ + api.Preview = api.Messenger.extend(/** @lends wp.customize.Preview.prototype */{ /** * @param {object} params - Parameters to configure the messenger. * @param {object} options - Extend any instance parameter or method with this object. diff --git src/wp-includes/js/customize-selective-refresh.js src/wp-includes/js/customize-selective-refresh.js index 4c4fa0d9c..5bc17ed73 100644 --- src/wp-includes/js/customize-selective-refresh.js +++ src/wp-includes/js/customize-selective-refresh.js @@ -1,5 +1,6 @@ /* global jQuery, JSON, _customizePartialRefreshExports, console */ +/** @namespace wp.customize.selectiveRefresh */ wp.customize.selectiveRefresh = ( function( $, api ) { 'use strict'; var self, Partial, Placement; @@ -24,6 +25,8 @@ wp.customize.selectiveRefresh = ( function( $, api ) { * * A partial provides a rendering of one or more settings according to a template. * + * @memberOf wp.customize.selectiveRefresh + * * @see PHP class WP_Customize_Partial. * * @class @@ -39,7 +42,7 @@ wp.customize.selectiveRefresh = ( function( $, api ) { * @param {string} options.params.primarySetting The ID for the primary setting the partial renders. * @param {bool} options.params.fallbackRefresh Whether to refresh the entire preview in case of a partial refresh failure. */ - Partial = self.Partial = api.Class.extend({ + Partial = self.Partial = api.Class.extend(/** @lends wp.customize.SelectiveRefresh.Partial.prototype */{ id: null, @@ -508,11 +511,13 @@ wp.customize.selectiveRefresh = ( function( $, api ) { * It also may have information in relation to how a placement may have just changed. * The placement is conceptually similar to a DOM Range or MutationRecord. * - * @class + * @memberOf wp.customize.selectiveRefresh + * + * @class Placement * @augments wp.customize.Class * @since 4.5.0 */ - self.Placement = Placement = api.Class.extend({ + self.Placement = Placement = api.Class.extend(/** @lends wp.customize.selectiveRefresh.prototype */{ /** * The partial with which the container is associated. diff --git src/wp-includes/js/customize-views.js src/wp-includes/js/customize-views.js index 29de08adc..786739f37 100644 --- src/wp-includes/js/customize-views.js +++ src/wp-includes/js/customize-views.js @@ -11,10 +11,13 @@ * * Instantiate with model wp.customize.HeaderTool.currentHeader. * + * @memberOf wp.customize.HeaderTool + * @alias wp.customize.HeaderTool.CurrentView + * * @constructor * @augments wp.Backbone.View */ - api.HeaderTool.CurrentView = wp.Backbone.View.extend({ + api.HeaderTool.CurrentView = wp.Backbone.View.extend(/** @lends wp.customize.HeaderTool.CurrentView.prototype */{ template: wp.template('header-current'), initialize: function() { @@ -50,10 +53,13 @@ * Manually changes model wp.customize.HeaderTool.currentHeader via the * `select` method. * + * @memberOf wp.customize.HeaderTool + * @alias wp.customize.HeaderTool.ChoiceView + * * @constructor * @augments wp.Backbone.View */ - api.HeaderTool.ChoiceView = wp.Backbone.View.extend({ + api.HeaderTool.ChoiceView = wp.Backbone.View.extend(/** @lends wp.customize.HeaderTool.ChoiceView.prototype */{ template: wp.template('header-choice'), className: 'header-view', @@ -125,10 +131,13 @@ * * Takes a wp.customize.HeaderTool.ChoiceList. * + * @memberOf wp.customize.HeaderTool + * @alias wp.customize.HeaderTool.ChoiceListView + * * @constructor * @augments wp.Backbone.View */ - api.HeaderTool.ChoiceListView = wp.Backbone.View.extend({ + api.HeaderTool.ChoiceListView = wp.Backbone.View.extend(/** @lends wp.customize.HeaderTool.ChoiceListView.prototype */{ initialize: function() { this.listenTo(this.collection, 'add', this.addOne); this.listenTo(this.collection, 'remove', this.render); @@ -168,10 +177,13 @@ * Aggregates wp.customize.HeaderTool.ChoiceList collections (or any * Backbone object, really) and acts as a bus to feed them events. * + * @memberOf wp.customize.HeaderTool + * @alias wp.customize.HeaderTool.CombinedList + * * @constructor * @augments wp.Backbone.View */ - api.HeaderTool.CombinedList = wp.Backbone.View.extend({ + api.HeaderTool.CombinedList = wp.Backbone.View.extend(/** @lends wp.customize.HeaderTool.CombinedList.prototype */{ initialize: function(collections) { this.collections = collections; this.on('all', this.propagate, this); diff --git src/wp-includes/js/heartbeat.js src/wp-includes/js/heartbeat.js index 6c5e8d151..66902f892 100644 --- src/wp-includes/js/heartbeat.js +++ src/wp-includes/js/heartbeat.js @@ -742,7 +742,7 @@ }; }; - // Ensure the global `wp` object exists. + /** @namespace wp */ window.wp = window.wp || {}; window.wp.heartbeat = new Heartbeat(); diff --git src/wp-includes/js/mce-view.js src/wp-includes/js/mce-view.js index 397af6386..3100ab6e5 100644 --- src/wp-includes/js/mce-view.js +++ src/wp-includes/js/mce-view.js @@ -280,7 +280,7 @@ wp.mce.View.extend = Backbone.View.extend; - _.extend( wp.mce.View.prototype, { + _.extend( wp.mce.View.prototype, /** @lends wp.mce.View.prototype */{ /** * The content. diff --git src/wp-includes/js/media-audiovideo.js src/wp-includes/js/media-audiovideo.js index c71a478e0..dfddc03e6 100644 --- src/wp-includes/js/media-audiovideo.js +++ src/wp-includes/js/media-audiovideo.js @@ -216,20 +216,22 @@ media.view.AudioDetails = require( './views/audio-details.js' ); media.view.VideoDetails = require( './views/video-details.js' ); },{"./controllers/audio-details.js":2,"./controllers/video-details.js":3,"./models/post-media.js":4,"./views/audio-details.js":5,"./views/frame/audio-details.js":6,"./views/frame/media-details.js":7,"./views/frame/video-details.js":8,"./views/media-details.js":9,"./views/video-details.js":10}],2:[function(require,module,exports){ +var State = wp.media.controller.State, + l10n = wp.media.view.l10n, + AudioDetails; + /** * wp.media.controller.AudioDetails * * The controller for the Audio Details state * + * @memberOf wp.media.controller + * * @class * @augments wp.media.controller.State * @augments Backbone.Model */ -var State = wp.media.controller.State, - l10n = wp.media.view.l10n, - AudioDetails; - -AudioDetails = State.extend({ +AudioDetails = State.extend(/** @lends wp.media.controller.AudioDetails.prototype */{ defaults: { id: 'audio-details', toolbar: 'audio-details', @@ -254,6 +256,8 @@ module.exports = AudioDetails; * * The controller for the Video Details state * + * @memberOf wp.media.controller + * * @class * @augments wp.media.controller.State * @augments Backbone.Model @@ -262,7 +266,7 @@ var State = wp.media.controller.State, l10n = wp.media.view.l10n, VideoDetails; -VideoDetails = State.extend({ +VideoDetails = State.extend(/** @lends wp.media.controller.VideoDetails.prototype */{ defaults: { id: 'video-details', toolbar: 'video-details', @@ -288,10 +292,12 @@ module.exports = VideoDetails; * Shared model class for audio and video. Updates the model after * "Add Audio|Video Source" and "Replace Audio|Video" states return * + * @memberOf wp.media.model + * * @class * @augments Backbone.Model */ -var PostMedia = Backbone.Model.extend({ +var PostMedia = Backbone.Model.extend(/** @lends wp.media.model.PostMedia.prototype */{ initialize: function() { this.attachment = false; }, @@ -324,9 +330,14 @@ var PostMedia = Backbone.Model.extend({ module.exports = PostMedia; },{}],5:[function(require,module,exports){ +var MediaDetails = wp.media.view.MediaDetails, + AudioDetails; + /** * wp.media.view.AudioDetails * + * @memberOf wp.media.view + * * @class * @augments wp.media.view.MediaDetails * @augments wp.media.view.Settings.AttachmentDisplay @@ -335,10 +346,7 @@ module.exports = PostMedia; * @augments wp.Backbone.View * @augments Backbone.View */ -var MediaDetails = wp.media.view.MediaDetails, - AudioDetails; - -AudioDetails = MediaDetails.extend({ +AudioDetails = MediaDetails.extend(/** @lends wp.media.view.AudioDetails.prototype */{ className: 'audio-details', template: wp.template('audio-details'), @@ -362,9 +370,17 @@ AudioDetails = MediaDetails.extend({ module.exports = AudioDetails; },{}],6:[function(require,module,exports){ +var MediaDetails = wp.media.view.MediaFrame.MediaDetails, + MediaLibrary = wp.media.controller.MediaLibrary, + + l10n = wp.media.view.l10n, + AudioDetails; + /** * wp.media.view.MediaFrame.AudioDetails * + * @memberOf wp.media.view.MediaFrame + * * @class * @augments wp.media.view.MediaFrame.MediaDetails * @augments wp.media.view.MediaFrame.Select @@ -375,13 +391,7 @@ module.exports = AudioDetails; * @augments Backbone.View * @mixes wp.media.controller.StateMachine */ -var MediaDetails = wp.media.view.MediaFrame.MediaDetails, - MediaLibrary = wp.media.controller.MediaLibrary, - - l10n = wp.media.view.l10n, - AudioDetails; - -AudioDetails = MediaDetails.extend({ +AudioDetails = MediaDetails.extend(/** @lends wp.media.view.MediaFrame.AudioDetails.prototype */{ defaults: { id: 'audio', url: '', @@ -438,9 +448,15 @@ AudioDetails = MediaDetails.extend({ module.exports = AudioDetails; },{}],7:[function(require,module,exports){ +var Select = wp.media.view.MediaFrame.Select, + l10n = wp.media.view.l10n, + MediaDetails; + /** * wp.media.view.MediaFrame.MediaDetails * + * @memberOf wp.media.view.MediaFrame + * * @class * @augments wp.media.view.MediaFrame.Select * @augments wp.media.view.MediaFrame @@ -450,11 +466,7 @@ module.exports = AudioDetails; * @augments Backbone.View * @mixes wp.media.controller.StateMachine */ -var Select = wp.media.view.MediaFrame.Select, - l10n = wp.media.view.l10n, - MediaDetails; - -MediaDetails = Select.extend({ +MediaDetails = Select.extend(/** @lends wp.media.view.MediaFrame.MediaDetails.prototype */{ defaults: { id: 'media', url: '', @@ -568,9 +580,16 @@ MediaDetails = Select.extend({ module.exports = MediaDetails; },{}],8:[function(require,module,exports){ +var MediaDetails = wp.media.view.MediaFrame.MediaDetails, + MediaLibrary = wp.media.controller.MediaLibrary, + l10n = wp.media.view.l10n, + VideoDetails; + /** * wp.media.view.MediaFrame.VideoDetails * + * @memberOf wp.media.view.MediaFrame + * * @class * @augments wp.media.view.MediaFrame.MediaDetails * @augments wp.media.view.MediaFrame.Select @@ -581,12 +600,7 @@ module.exports = MediaDetails; * @augments Backbone.View * @mixes wp.media.controller.StateMachine */ -var MediaDetails = wp.media.view.MediaFrame.MediaDetails, - MediaLibrary = wp.media.controller.MediaLibrary, - l10n = wp.media.view.l10n, - VideoDetails; - -VideoDetails = MediaDetails.extend({ +VideoDetails = MediaDetails.extend(/** @lends wp.media.view.MediaFrame.VideoDetails.prototype */{ defaults: { id: 'video', url: '', @@ -704,10 +718,15 @@ module.exports = VideoDetails; },{}],9:[function(require,module,exports){ /* global MediaElementPlayer */ +var AttachmentDisplay = wp.media.view.Settings.AttachmentDisplay, + $ = jQuery, + MediaDetails; /** * wp.media.view.MediaDetails * + * @memberOf wp.media.view + * * @class * @augments wp.media.view.Settings.AttachmentDisplay * @augments wp.media.view.Settings @@ -715,11 +734,7 @@ module.exports = VideoDetails; * @augments wp.Backbone.View * @augments Backbone.View */ -var AttachmentDisplay = wp.media.view.Settings.AttachmentDisplay, - $ = jQuery, - MediaDetails; - -MediaDetails = AttachmentDisplay.extend({ +MediaDetails = AttachmentDisplay.extend(/** @lends wp.media.view.MediaDetails.prototype */{ initialize: function() { _.bindAll(this, 'success'); this.players = []; @@ -791,9 +806,6 @@ MediaDetails = AttachmentDisplay.extend({ this.scriptXhr = false; }, - /** - * @global MediaElementPlayer - */ setPlayer : function() { var src; @@ -849,7 +861,7 @@ MediaDetails = AttachmentDisplay.extend({ resetFocus: function() { this.$( '.embed-media-settings' ).scrollTop( 0 ); } -}, { +},/** @lends wp.media.view.MediaDetails */{ instances : 0, /** * When multiple players in the DOM contain the same src, things get weird. @@ -875,9 +887,14 @@ MediaDetails = AttachmentDisplay.extend({ module.exports = MediaDetails; },{}],10:[function(require,module,exports){ +var MediaDetails = wp.media.view.MediaDetails, + VideoDetails; + /** * wp.media.view.VideoDetails * + * @memberOf wp.media.view + * * @class * @augments wp.media.view.MediaDetails * @augments wp.media.view.Settings.AttachmentDisplay @@ -886,10 +903,7 @@ module.exports = MediaDetails; * @augments wp.Backbone.View * @augments Backbone.View */ -var MediaDetails = wp.media.view.MediaDetails, - VideoDetails; - -VideoDetails = MediaDetails.extend({ +VideoDetails = MediaDetails.extend(/** @lends wp.media.view.VideoDetails.prototype */{ className: 'video-details', template: wp.template('video-details'), diff --git src/wp-includes/js/media-editor.js src/wp-includes/js/media-editor.js index 3852543aa..c18180bdb 100644 --- src/wp-includes/js/media-editor.js +++ src/wp-includes/js/media-editor.js @@ -30,19 +30,13 @@ return attrs[ key ]; }; - /** - * wp.media.string - * @namespace - */ + /** @namespace wp.media.string */ wp.media.string = { /** * Joins the `props` and `attachment` objects, * outputting the proper object format based on the * attachment's type. * - * @global wp.media.view.settings - * @global getUserSetting() - * * @param {Object} [props={}] Attachment details (align, link, size, etc). * @param {Object} attachment The attachment object, media version of Post. * @returns {Object} Joined props @@ -109,8 +103,6 @@ /** * Create link markup that is suitable for passing to the editor * - * @global wp.html.string - * * @param {Object} props Attachment details (align, link, size, etc). * @param {Object} attachment The attachment object, media version of Post. * @returns {string} The link markup @@ -159,9 +151,6 @@ * * @access private * - * @global wp.shortcode - * @global wp.media.view.settings - * * @param {string} type The shortcode tag name: 'audio' or 'video'. * @param {Object} props Attachment details (align, link, size, etc). * @param {Object} attachment The attachment object, media version of Post. @@ -210,9 +199,6 @@ * Create image markup, optionally with a link and/or wrapped in a caption shortcode, * that is suitable for passing to the editor * - * @global wp.html - * @global wp.shortcode - * * @param {Object} props Attachment details (align, link, size, etc). * @param {Object} attachment The attachment object, media version of Post. * @returns {string} @@ -341,16 +327,19 @@ } }; + /** + * @class wp.media.collection + * + * @param attributes + */ wp.media.collection = function(attributes) { var collections = {}; - return _.extend( { + return _.extend(/** @lends wp.media.collection.prototype */{ coerce : wp.media.coerce, /** * Retrieve attachments based on the properties of the passed shortcode * - * @global wp.media.query - * * @param {wp.shortcode} shortcode An instance of wp.shortcode(). * @returns {wp.media.model.Attachments} A Backbone.Collection containing * the media items belonging to a collection. @@ -417,9 +406,6 @@ /** * Triggered when clicking 'Insert {label}' or 'Update {label}' * - * @global wp.shortcode - * @global wp.media.model.Attachments - * * @param {wp.media.model.Attachments} attachments A Backbone.Collection containing * the media items belonging to a collection. * The query[ this.tag ] property is a Backbone.Model @@ -488,10 +474,6 @@ * Triggered when double-clicking a collection shortcode placeholder * in the editor * - * @global wp.shortcode - * @global wp.media.model.Selection - * @global wp.media.view.l10n - * * @param {string} content Content that is searched for possible * shortcode markup matching the passed tag name, * @@ -609,16 +591,10 @@ } }); - /** - * wp.media.featuredImage - * @namespace - */ wp.media.featuredImage = { /** * Get the featured image post ID * - * @global wp.media.view.settings - * * @returns {wp.media.view.settings.post.featuredImageId|number} */ get: function() { @@ -628,9 +604,6 @@ * Set the featured image id, save the post thumbnail data and * set the HTML in the post meta box to the new featured image. * - * @global wp.media.view.settings - * @global wp.media.post - * * @param {number} id The post ID of the featured image, or -1 to unset it. */ set: function( id ) { @@ -660,9 +633,6 @@ /** * The Featured Image workflow * - * @global wp.media.controller.FeaturedImage - * @global wp.media.view.l10n - * * @this wp.media.featuredImage * * @returns {wp.media.view.MediaFrame.Select} A media workflow. @@ -705,8 +675,6 @@ * 'select' callback for Featured Image workflow, triggered when * the 'Set Featured Image' button is clicked in the media modal. * - * @global wp.media.view.settings - * * @this wp.media.controller.FeaturedImage */ select: function() { @@ -723,8 +691,6 @@ * the post thumbnail is clicked. * * Update the featured image id when the 'remove' link is clicked. - * - * @global wp.media.view.settings */ init: function() { $('#postimagediv').on( 'click', '#set-post-thumbnail', function( event ) { @@ -742,19 +708,11 @@ $( wp.media.featuredImage.init ); - /** - * wp.media.editor - * @namespace - */ + /** @namespace wp.media.editor */ wp.media.editor = { /** * Send content to the editor * - * @global tinymce - * @global QTags - * @global wpActiveEditor - * @global tb_remove() - Possibly overloaded by legacy plugins - * * @param {string} html Content to send to the editor */ insert: function( html ) { @@ -805,8 +763,6 @@ * Setup 'workflow' and add to the 'workflows' cache. 'open' can * subsequently be called upon it. * - * @global wp.media.view.l10n - * * @param {string} id A slug used to identify the workflow. * @param {Object} [options={}] * @@ -914,9 +870,6 @@ /** * Determines the proper current workflow id * - * @global wpActiveEditor - * @global tinymce - * * @param {string} [id=''] A slug used to identify the workflow. * * @returns {wpActiveEditor|string|tinymce.activeEditor.id} @@ -962,17 +915,12 @@ id = this.id( id ); delete workflows[ id ]; }, - /** - * @namespace - */ + /** @namespace wp.media.editor.send */ send: { /** * Called when sending an attachment to the editor * from the medial modal. * - * @global wp.media.view.settings - * @global wp.media.post - * * @param {Object} props Attachment details (align, link, size, etc). * @param {Object} attachment The attachment object, media version of Post. * @returns {Promise} @@ -1028,8 +976,6 @@ /** * Called when 'Insert From URL' source is not an image. Example: YouTube url. * - * @global wp.media.view.settings - * * @param {Object} embed * @returns {Promise} */ @@ -1075,8 +1021,6 @@ /** * Bind click event for .insert-media using event delegation - * - * @global wp.media.view.l10n */ init: function() { $(document.body) diff --git src/wp-includes/js/media-grid.js src/wp-includes/js/media-grid.js index b6128a375..6e35fb52a 100644 --- src/wp-includes/js/media-grid.js +++ src/wp-includes/js/media-grid.js @@ -1,17 +1,19 @@ (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o