Changeset 27642

Timestamp:

03/20/2014 10:22:25 PM (12 years ago)

Author:

wonderboymusic

Message:

Add JSDoc blocks to media-audiovideo.js.

See #27016.

File:

• trunk/src/wp-includes/js/media-audiovideo.js (modified) (20 diffs)

trunk/src/wp-includes/js/media-audiovideo.js

@@ -821 +821 @@
         },
 
+        /**
+         * Remove a setting's UI when the model unsets it
+         *
+         * @fires wp.media.view.MediaDetails#media:setting:remove
+         *
+         * @param {Event} e
+         */
         removeSetting : function (e) {
             var wrap = $( e.currentTarget ).parent(), setting;
@@ -834 +841 @@
         },
 
+        /**
+         *
+         * @fires wp.media.view.MediaDetails#media:setting:remove
+         */
         setTracks : function () {
             var tracks = '';
@@ -845 +856 @@
         },
 
+        /**
+         * @global MediaElementPlayer
+         */
         setPlayer : function () {
             if ( ! this.player && this.media ) {
@@ -870 +884 @@
         },
 
+        /**
+         * @global _wpmejsSettings
+         *
+         * @returns {media.view.MediaDetails} Returns itself to allow chaining
+         */
         render: function() {
             var self = this, settings = {
@@ -986 +1005 @@
         /**
          * Determine how many audio and video files the user has uploaded
+         *
+         * @global wp.media.view.settings
+         *
+         * @param {Object} settings
+         * @returns {Object}
          */
         counts : (function (settings) {
@@ -1108 +1132 @@
     } );
 
+    /**
+     * Tiny MCE Views
+     *
+     */
+
+    /**
+     * These are base methods that are shared by each shortcode's MCE controller
+     *
+     * @mixin
+     */
     wp.mce.media = {
+        /**
+         * @global wp.shortcode
+         *
+         * @param {string} content
+         * @returns {Object}
+         */
         toView:  function( content ) {
             var match = wp.shortcode.next( this.shortcode, content );
@@ -1125 +1165 @@
         },
 
+        /**
+         * Called when a TinyMCE view is clicked for editing.
+         * - Parses the shortcode out of the element's data attribute
+         * - Calls the `edit` method on the shortcode model
+         * - Launches the model window
+         * - Bind's an `update` callback which updates the element's data attribute
+         *   re-renders the view
+         *
+         * @param {HTMLElement} node
+         */
         edit: function( node ) {
             var media = wp.media[ this.shortcode ],
@@ -1147 +1197 @@
     };
 
+    /**
+     * Base View class for audio and video shortcodes
+     *
+     * @constructor
+     * @augments wp.mce.View
+     * @mixes wp.media.mixin
+     */
     wp.mce.media.View = wp.mce.View.extend({
         initialize: function( options ) {
@@ -1154 +1211 @@
         },
 
+        /**
+         * Creates the player instance for the current node
+         *
+         * @global MediaElementPlayer
+         * @global _wpmejsSettings
+         *
+         * @param {Event} e
+         * @param {HTMLElement} node
+         */
         setPlayer: function (e, node) {
             // if the ready event fires on an empty node
@@ -1199 +1265 @@
         },
 
+        /**
+         * Pass data to the View's Underscore template and return the compiled output
+         *
+         * @returns {string}
+         */
         getHtml: function() {
             var attrs = this.shortcode.attrs.named;
@@ -1206 +1277 @@
     _.extend( wp.mce.media.View.prototype, wp.media.mixin );
 
+    /**
+     * TinyMCE handler for the video shortcode
+     *
+     * @mixes wp.mce.media
+     */
     wp.mce.video = _.extend( {}, wp.mce.media, {
         shortcode: 'video',
@@ -1214 +1290 @@
         })
     } );
-
     wp.mce.views.register( 'video', wp.mce.video );
 
+    /**
+     * TinyMCE handler for the audio shortcode
+     *
+     * @mixes wp.mce.media
+     */
     wp.mce.audio = _.extend( {}, wp.mce.media, {
         shortcode: 'audio',
@@ -1225 +1305 @@
         })
     } );
-
     wp.mce.views.register( 'audio', wp.mce.audio );
 
+    /**
+     * Base View class for playlist shortcodes
+     *
+     * @constructor
+     * @augments wp.mce.View
+     * @mixes wp.media.mixin
+     */
     wp.mce.media.PlaylistView = wp.mce.View.extend({
         className: 'editor-playlist',
@@ -1240 +1326 @@
         },
 
+        /**
+         * Set the element context for the view, and then fetch the playlist's
+         *   associated attachments.
+         *
+         * @param {Event} e
+         * @param {HTMLElement} node
+         */
         setNode: function (e, node) {
             this.node = node;
@@ -1245 +1338 @@
         },
 
+        /**
+         * Asynchronously fetch the shortcode's attachments
+         */
         fetch: function() {
             this.attachments = wp.media[ this.shortcode.tag ].attachments( this.shortcode );
@@ -1250 +1346 @@
         },
 
+        /**
+         * Get the HTML for the view (which also set's the data), replace the
+         *   current HTML, and then invoke the WPPlaylistView instance to render
+         *   the playlist in the editor
+         *
+         * @global WPPlaylistView
+         * @global tinymce.editors
+         */
         setPlayer: function () {
             var p,
@@ -1278 +1382 @@
         },
 
+        /**
+         * Set the data that will be used to compile the Underscore template,
+         *  compile the template, and then return it.
+         *
+         * @returns {string}
+         */
         getHtml: function() {
             var data = this.shortcode.attrs.named,
@@ -1344 +1454 @@
     _.extend( wp.mce.media.PlaylistView.prototype, wp.media.mixin );
 
+    /**
+     * TinyMCE handler for the playlist shortcode
+     *
+     * @mixes wp.mce.media
+     */
     wp.mce.playlist = _.extend( {}, wp.mce.media, {
         shortcode: 'playlist',
@@ -1349 +1464 @@
         View: wp.mce.media.PlaylistView
     } );
-
     wp.mce.views.register( 'playlist', wp.mce.playlist );
 
+    /**
+     * TinyMCE handler for the video-playlist shortcode
+     *
+     * @mixes wp.mce.media
+     */
     wp.mce['video-playlist'] = _.extend( {}, wp.mce.media, {
         shortcode: 'video-playlist',
@@ -1357 +1476 @@
         View: wp.mce.media.PlaylistView
     } );
-
     wp.mce.views.register( 'video-playlist', wp.mce['video-playlist'] );
 
+    /**
+     * Event binding
+     */
     function init() {
         $(document.body)