<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[41239] trunk/src/wp-includes/js/media/audiovideo.manifest.js: Docs: Improve JavaScript documentation in audiovideo.manifest.js.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/41239">41239</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/41239","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>adamsilverstein</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-08-11 20:36:19 +0000 (Fri, 11 Aug 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Improve JavaScript documentation in audiovideo.manifest.js.
Add and improve JSDOC blocks.
Props nicollle, manuelaugustin.
Fixes <a href="https://core.trac.wordpress.org/ticket/41602">#41602</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesjsmediaaudiovideomanifestjs">trunk/src/wp-includes/js/media/audiovideo.manifest.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesjsmediaaudiovideomanifestjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/js/media/audiovideo.manifest.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/media/audiovideo.manifest.js 2017-08-10 01:37:30 UTC (rev 41238)
+++ trunk/src/wp-includes/js/media/audiovideo.manifest.js 2017-08-11 20:36:19 UTC (rev 41239)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3,11 +3,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> l10n = window._wpMediaViewsL10n || {};
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @summary Defines the wp.media.mixin object.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @mixin
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @since 4.2.0
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> wp.media.mixin = {
</span><span class="cx" style="display: block; padding: 0 10px"> mejsSettings: baseSettings,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @summary Pauses and removes all players.
+ *
+ * @since 4.2.0
+ *
+ * @return {void}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> removeAllPlayers: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var p;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,9 +32,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @summary Removes the player.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * Override the MediaElement method for removing a player.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * MediaElement tries to pull the audio/video tag out of
- * its container and re-add it to the DOM.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> removePlayer: function(t) {
</span><span class="cx" style="display: block; padding: 0 10px"> var featureIndex, feature;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -57,10 +75,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @summary Removes and resets all players.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * Allows any class that has set 'player' to a MediaElementPlayer
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * instance to remove the player when listening to events.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * instance to remove the player when listening to events.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Examples: modal closes, shortcode properties are removed, etc.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Examples: modal closes, shortcode properties are removed, etc.
+ *
+ * @since 4.2.0
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> unsetPlayers : function() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( this.players && this.players.length ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -74,7 +97,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Autowire "collection"-type shortcodes
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @summary Shortcode modeling for playlists.
+ *
+ * @since 4.2.0
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> wp.media.playlist = new wp.media.collection({
</span><span class="cx" style="display: block; padding: 0 10px"> tag: 'playlist',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -91,11 +116,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Shortcode modeling for audio
- * `edit()` prepares the shortcode for the media modal
- * `shortcode()` builds the new shortcode after update
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @summary Shortcode modeling for audio.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * `edit()` prepares the shortcode for the media modal.
+ * `shortcode()` builds the new shortcode after an update.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @namespace
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @since 4.2.0
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> wp.media.audio = {
</span><span class="cx" style="display: block; padding: 0 10px"> coerce : wp.media.coerce,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -109,6 +137,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> width : 400
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> edit : function( data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var frame, shortcode = wp.shortcode.next( 'audio', data ).shortcode;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -121,6 +157,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return frame;
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> shortcode : function( model ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var content;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -144,10 +188,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Shortcode modeling for video
- * `edit()` prepares the shortcode for the media modal
- * `shortcode()` builds the new shortcode after update
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @summary Shortcode modeling for video.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * `edit()` prepares the shortcode for the media modal.
+ * `shortcode()` builds the new shortcode after update.
+ *
+ * @since 4.2.0
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @namespace
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> wp.media.video = {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -165,6 +212,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> height : 360
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> edit : function( data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var frame,
</span><span class="cx" style="display: block; padding: 0 10px"> shortcode = wp.shortcode.next( 'video', data ).shortcode,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -182,6 +237,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return frame;
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> shortcode : function( model ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var content;
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>