Changeset 41239

Timestamp:

08/11/2017 08:36:19 PM (9 years ago)

Author:

adamsilverstein

Message:

Docs: Improve JavaScript documentation in audiovideo.manifest.js.

Add and improve JSDOC blocks.

Props nicollle, manuelaugustin.
Fixes #41602.

File:

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

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

@@ -4 +4 @@
 
 /**
+ *
+ * @summary Defines the wp.media.mixin object.
+ *
  * @mixin
+ *
+ * @since 4.2.0
  */
 wp.media.mixin = {
         mejsSettings: baseSettings,
 
+        /**
+         * @summary Pauses and removes all players.
+         *
+         * @since 4.2.0
+         *
+         * @return {void}
+         */
         removeAllPlayers: function() {
                 var p;
@@ -21 +33 @@
 
         /**
+         * @summary Removes the player.
+         *
          * Override the MediaElement method for removing a player.
-         *      MediaElement tries to pull the audio/video tag out of
-         *      its container and re-add it to the DOM.
+         * MediaElement tries to pull the audio/video tag out of
+         * its container and re-add it to the DOM.
+         *
+         * @since 4.2.0
+         *
+         * @return {void}
          */
         removePlayer: function(t) {
@@ -58 +76 @@
 
         /**
+         *
+         * @summary Removes and resets all players.
+         *
          * Allows any class that has set 'player' to a MediaElementPlayer
-         *  instance to remove the player when listening to events.
-         *
-         *  Examples: modal closes, shortcode properties are removed, etc.
+         * instance to remove the player when listening to events.
+         *
+         * Examples: modal closes, shortcode properties are removed, etc.
+         *
+         * @since 4.2.0
          */
         unsetPlayers : function() {
@@ -75 +98 @@
 
 /**
- * Autowire "collection"-type shortcodes
+ * @summary Shortcode modeling for playlists.
+ *
+ * @since 4.2.0
  */
 wp.media.playlist = new wp.media.collection({
@@ -92 +117 @@
 
 /**
- * Shortcode modeling for audio
- *  `edit()` prepares the shortcode for the media modal
- *  `shortcode()` builds the new shortcode after update
+ * @summary Shortcode modeling for audio.
+ *
+ * `edit()` prepares the shortcode for the media modal.
+ * `shortcode()` builds the new shortcode after an update.
  *
  * @namespace
+ *
+ * @since 4.2.0
  */
 wp.media.audio = {
@@ -110 +138 @@
         },
 
+        /**
+         * @summary Instantiates a new media object with the next matching shortcode.
+         *
+         * @since 4.2.0
+         *
+         * @param {string} data The text to apply the shortcode on.
+         * @returns {wp.media} The media object.
+         */
         edit : function( data ) {
                 var frame, shortcode = wp.shortcode.next( 'audio', data ).shortcode;
@@ -122 +158 @@
         },
 
+        /**
+         * @summary Generates an audio shortcode.
+         *
+         * @since 4.2.0
+         *
+         * @param {Array} model Array with attributes for the shortcode.
+         * @returns {wp.shortcode} The audio shortcode object.
+         */
         shortcode : function( model ) {
                 var content;
@@ -145 +189 @@
 
 /**
- * Shortcode modeling for video
- *  `edit()` prepares the shortcode for the media modal
- *  `shortcode()` builds the new shortcode after update
+ * @summary Shortcode modeling for video.
+ *
+ *  `edit()` prepares the shortcode for the media modal.
+ *  `shortcode()` builds the new shortcode after update.
+ *
+ * @since 4.2.0
  *
  * @namespace
@@ -166 +213 @@
         },
 
+        /**
+         * @summary Instantiates a new media object with the next matching shortcode.
+         *
+         * @since 4.2.0
+         *
+         * @param {string} data The text to apply the shortcode on.
+         * @returns {wp.media} The media object.
+         */
         edit : function( data ) {
                 var frame,
@@ -183 +238 @@
         },
 
+        /**
+         * @summary Generates an video shortcode.
+         *
+         * @since 4.2.0
+         *
+         * @param {Array} model Array with attributes for the shortcode.
+         * @returns {wp.shortcode} The video shortcode object.
+         */
         shortcode : function( model ) {
                 var content;