<!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>[27126] trunk/src/wp-includes/js/media-views.js: Add some inline docs to `media-views.js` and remove some unnecessary comments from a few `super` calls.</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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/27126">27126</a></dd>
<dt>Author</dt> <dd>wonderboymusic</dd>
<dt>Date</dt> <dd>2014-02-07 20:20:38 +0000 (Fri, 07 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add some inline docs to `media-views.js` and remove some unnecessary comments from a few `super` calls.
Props gcorne.
See <a href="http://core.trac.wordpress.org/ticket/26870">#26870</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesjsmediaviewsjs">trunk/src/wp-includes/js/media-views.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesjsmediaviewsjs"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/js/media-views.js (27125 => 27126)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/js/media-views.js 2014-02-07 19:53:01 UTC (rev 27125)
+++ trunk/src/wp-includes/js/media-views.js 2014-02-07 20:20:38 UTC (rev 27126)
</span><span class="lines">@@ -297,6 +297,11 @@
</span><span class="cx"> /**
</span><span class="cx"> * wp.media.controller.State
</span><span class="cx"> *
</span><ins>+ * A state is a step in a workflow that when set will trigger
+ * the controllers for the regions to be updated as specified. This
+ * class is the base class that the various states used in the media
+ * modals extend.
+ *
</ins><span class="cx"> * @constructor
</span><span class="cx"> * @augments Backbone.Model
</span><span class="cx"> */
</span><span class="lines">@@ -792,9 +797,7 @@
</span><span class="cx"> if ( ! this.get('AttachmentView') ) {
</span><span class="cx"> this.set( 'AttachmentView', media.view.Attachment.EditLibrary );
</span><span class="cx"> }
</span><del>- /**
- * call 'initialize' directly on the parent class
- */
</del><ins>+
</ins><span class="cx"> media.controller.Library.prototype.initialize.apply( this, arguments );
</span><span class="cx"> },
</span><span class="cx">
</span><span class="lines">@@ -808,9 +811,7 @@
</span><span class="cx"> this.get('library').observe( wp.Uploader.queue );
</span><span class="cx">
</span><span class="cx"> this.frame.on( 'content:render:browse', this.gallerySettings, this );
</span><del>- /**
- * call 'activate' directly on the parent class
- */
</del><ins>+
</ins><span class="cx"> media.controller.Library.prototype.activate.apply( this, arguments );
</span><span class="cx"> },
</span><span class="cx">
</span><span class="lines">@@ -819,9 +820,7 @@
</span><span class="cx"> this.get('library').unobserve( wp.Uploader.queue );
</span><span class="cx">
</span><span class="cx"> this.frame.off( 'content:render:browse', this.gallerySettings, this );
</span><del>- /**
- * call 'deactivate' directly on the parent class
- */
</del><ins>+
</ins><span class="cx"> media.controller.Library.prototype.deactivate.apply( this, arguments );
</span><span class="cx"> },
</span><span class="cx">
</span><span class="lines">@@ -886,9 +885,6 @@
</span><span class="cx"> if ( ! this.get('library') ) {
</span><span class="cx"> this.set( 'library', media.query({ type: 'image' }) );
</span><span class="cx"> }
</span><del>- /**
- * call 'initialize' directly on the parent class
- */
</del><span class="cx"> media.controller.Library.prototype.initialize.apply( this, arguments );
</span><span class="cx"> },
</span><span class="cx">
</span><span class="lines">@@ -903,12 +899,8 @@
</span><span class="cx"> // Accepts attachments that exist in the original library and
</span><span class="cx"> // that do not exist in gallery's library.
</span><span class="cx"> library.validator = function( attachment ) {
</span><del>- return !! this.mirroring.get( attachment.cid )
- && ! edit.get( attachment.cid )
- /**
- * call 'validator' directly on wp.media.model.Selection
- */
- && media.model.Selection.prototype.validator.apply( this, arguments );
</del><ins>+ return !! this.mirroring.get( attachment.cid ) && ! edit.get( attachment.cid ) &&
+ media.model.Selection.prototype.validator.apply( this, arguments );
</ins><span class="cx"> };
</span><span class="cx">
</span><span class="cx"> // Reset the library to ensure that all attachments are re-added
</span><span class="lines">@@ -917,9 +909,7 @@
</span><span class="cx"> library.reset( library.mirroring.models, { silent: true });
</span><span class="cx"> library.observe( edit );
</span><span class="cx"> this.editLibrary = edit;
</span><del>- /**
- * call 'activate' directly on the parent class
- */
</del><ins>+
</ins><span class="cx"> media.controller.Library.prototype.activate.apply( this, arguments );
</span><span class="cx"> }
</span><span class="cx"> });
</span><span class="lines">@@ -950,9 +940,7 @@
</span><span class="cx"> if ( ! this.get('library') ) {
</span><span class="cx"> this.set( 'library', media.query({ type: 'image' }) );
</span><span class="cx"> }
</span><del>- /**
- * call 'initialize' directly on the parent class
- */
</del><ins>+
</ins><span class="cx"> media.controller.Library.prototype.initialize.apply( this, arguments );
</span><span class="cx">
</span><span class="cx"> library = this.get('library');
</span><span class="lines">@@ -981,17 +969,13 @@
</span><span class="cx"> activate: function() {
</span><span class="cx"> this.updateSelection();
</span><span class="cx"> this.frame.on( 'open', this.updateSelection, this );
</span><del>- /**
- * call 'activate' directly on the parent class
- */
</del><ins>+
</ins><span class="cx"> media.controller.Library.prototype.activate.apply( this, arguments );
</span><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> deactivate: function() {
</span><span class="cx"> this.frame.off( 'open', this.updateSelection, this );
</span><del>- /**
- * call 'deactivate' directly on the parent class
- */
</del><ins>+
</ins><span class="cx"> media.controller.Library.prototype.deactivate.apply( this, arguments );
</span><span class="cx"> },
</span><span class="cx">
</span><span class="lines">@@ -1038,9 +1022,7 @@
</span><span class="cx"> if ( ! this.get('library') ) {
</span><span class="cx"> this.set( 'library', media.query({ type: 'image' }) );
</span><span class="cx"> }
</span><del>- /**
- * call 'initialize' directly on the parent class
- */
</del><ins>+
</ins><span class="cx"> media.controller.Library.prototype.initialize.apply( this, arguments );
</span><span class="cx">
</span><span class="cx"> library = this.get('library');
</span><span class="lines">@@ -1068,19 +1050,9 @@
</span><span class="cx">
</span><span class="cx"> activate: function() {
</span><span class="cx"> this.updateSelection();
</span><del>- /**
- * call 'activate' directly on the parent class
- */
</del><span class="cx"> media.controller.Library.prototype.activate.apply( this, arguments );
</span><span class="cx"> },
</span><span class="cx">
</span><del>- deactivate: function() {
- /**
- * call 'deactivate' directly on the parent class
- */
- media.controller.Library.prototype.deactivate.apply( this, arguments );
- },
-
</del><span class="cx"> updateSelection: function() {
</span><span class="cx"> var selection = this.get('selection'),
</span><span class="cx"> attachment = this.image.attachment;
</span><span class="lines">@@ -1268,6 +1240,9 @@
</span><span class="cx"> /**
</span><span class="cx"> * wp.media.view.Frame
</span><span class="cx"> *
</span><ins>+ * A frame is a composite view consisting of one or more regions and one or more
+ * states. Only one state can be active at any given moment.
+ *
</ins><span class="cx"> * @constructor
</span><span class="cx"> * @augments wp.media.View
</span><span class="cx"> * @augments wp.Backbone.View
</span><span class="lines">@@ -1327,6 +1302,8 @@
</span><span class="cx"> /**
</span><span class="cx"> * wp.media.view.MediaFrame
</span><span class="cx"> *
</span><ins>+ * Type of frame used to create the media modal.
+ *
</ins><span class="cx"> * @constructor
</span><span class="cx"> * @augments wp.media.view.Frame
</span><span class="cx"> * @augments wp.media.View
</span><span class="lines">@@ -1343,9 +1320,7 @@
</span><span class="cx"> * @global wp.Uploader
</span><span class="cx"> */
</span><span class="cx"> initialize: function() {
</span><del>- /**
- * call 'initialize' directly on the parent class
- */
</del><ins>+
</ins><span class="cx"> media.view.Frame.prototype.initialize.apply( this, arguments );
</span><span class="cx">
</span><span class="cx"> _.defaults( this.options, {
</span><span class="lines">@@ -1550,6 +1525,8 @@
</span><span class="cx"> /**
</span><span class="cx"> * wp.media.view.MediaFrame.Select
</span><span class="cx"> *
</span><ins>+ * Type of media frame that is used to select an item or items from the media library
+ *
</ins><span class="cx"> * @constructor
</span><span class="cx"> * @augments wp.media.view.MediaFrame
</span><span class="cx"> * @augments wp.media.view.Frame
</span></span></pre>
</div>
</div>
</body>
</html>