<!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>[27032] trunk/src/wp-includes/js/media-models.js: Add some inline docs to methods in `media-models.js` - particularly around `@param` and `@returns`.</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/27032">27032</a></dd>
<dt>Author</dt> <dd>wonderboymusic</dd>
<dt>Date</dt> <dd>2014-01-25 08:55:47 +0000 (Sat, 25 Jan 2014)</dd>
</dl>

<h3>Log Message</h3>
<pre>Add some inline docs to methods in `media-models.js` - particularly around `@param` and `@returns`.

See <a href="http://core.trac.wordpress.org/ticket/26870">#26870</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesjsmediamodelsjs">trunk/src/wp-includes/js/media-models.js</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesjsmediamodelsjs"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/js/media-models.js (27031 => 27032)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/js/media-models.js 2014-01-25 07:38:12 UTC (rev 27031)
+++ trunk/src/wp-includes/js/media-models.js    2014-01-25 08:55:47 UTC (rev 27032)
</span><span class="lines">@@ -152,7 +152,7 @@
</span><span class="cx">           * @param {String} string
</span><span class="cx">           * @param {Number} [length=30]
</span><span class="cx">           * @param {String} [replacement=&hellip;]
</span><del>-                * @returns {String}
</del><ins>+                 * @returns {String} The string, unless length is greater than string.length.
</ins><span class="cx">            */
</span><span class="cx">          truncate: function( string, length, replacement ) {
</span><span class="cx">                  length = length || 30;
</span><span class="lines">@@ -175,7 +175,7 @@
</span><span class="cx">   * wp.media.attachment
</span><span class="cx">   *
</span><span class="cx">   * @static
</span><del>-        * @param {String} id
</del><ins>+         * @param {String} id A string used to identify a model.
</ins><span class="cx">    * @returns {wp.media.model.Attachment}
</span><span class="cx">   */
</span><span class="cx">  media.attachment = function( id ) {
</span><span class="lines">@@ -317,6 +317,8 @@
</span><span class="cx">          }
</span><span class="cx">  }, {
</span><span class="cx">          /**
</span><ins>+                * Add a model to the end of the static 'all' collection and return it.
+                *
</ins><span class="cx">            * @static
</span><span class="cx">           * @param {Object} attrs
</span><span class="cx">           * @returns {wp.media.model.Attachment}
</span><span class="lines">@@ -325,8 +327,10 @@
</span><span class="cx">                  return Attachments.all.push( attrs );
</span><span class="cx">          },
</span><span class="cx">          /**
</span><ins>+                * Retrieve a model, or add it to the end of the static 'all' collection before returning it.
+                *
</ins><span class="cx">            * @static
</span><del>-                * @param {string} id
</del><ins>+                 * @param {string} id A string used to identify a model.
</ins><span class="cx">            * @param {Backbone.Model|undefined} attachment
</span><span class="cx">           * @returns {wp.media.model.Attachment}
</span><span class="cx">           */
</span><span class="lines">@@ -347,7 +351,7 @@
</span><span class="cx">           */
</span><span class="cx">          model: Attachment,
</span><span class="cx">          /**
</span><del>-                * @param {Array|Object} models
</del><ins>+                 * @param {Array} [models=[]] Array of models used to populate the collection.
</ins><span class="cx">            * @param {Object} [options={}]
</span><span class="cx">           */
</span><span class="cx">          initialize: function( models, options ) {
</span><span class="lines">@@ -498,6 +502,9 @@
</span><span class="cx">          /**
</span><span class="cx">           * @param {wp.media.model.Attachments} attachments
</span><span class="cx">           * @param {object} [options={}]
</span><ins>+                *
+                * @fires wp.media.model.Attachments#reset
+                *
</ins><span class="cx">            * @returns {wp.media.model.Attachments} Returns itself to allow chaining
</span><span class="cx">           */
</span><span class="cx">          validateAll: function( attachments, options ) {
</span><span class="lines">@@ -703,10 +710,14 @@
</span><span class="cx">  }, {
</span><span class="cx">          /**
</span><span class="cx">           * @static
</span><ins>+                * Overrides Backbone.Collection.comparator
+                *
</ins><span class="cx">            * @param {Backbone.Model} a
</span><span class="cx">           * @param {Backbone.Model} b
</span><span class="cx">           * @param {Object} options
</span><del>-                * @returns {Number}
</del><ins>+                 * @returns {Number} -1 if the first model should come before the second,
+                *    0 if they are of the same rank and
+                *    1 if the first model should come after.
</ins><span class="cx">            */
</span><span class="cx">          comparator: function( a, b, options ) {
</span><span class="cx">                  var key   = this.props.get('orderby'),
</span><span class="lines">@@ -820,7 +831,7 @@
</span><span class="cx">          /**
</span><span class="cx">           * @global wp.Uploader
</span><span class="cx">           *
</span><del>-                * @param {Array} models
</del><ins>+                 * @param {Array} [models=[]] Array of models used to populate the collection.
</ins><span class="cx">            * @param {Object} [options={}]
</span><span class="cx">           */
</span><span class="cx">          initialize: function( models, options ) {
</span><span class="lines">@@ -982,6 +993,9 @@
</span><span class="cx">          },
</span><span class="cx">          /**
</span><span class="cx">           * @static
</span><ins>+                * @method
+                *
+                * @returns {wp.media.model.Query} A new query.
</ins><span class="cx">            */
</span><span class="cx">          // Caches query objects so queries can be easily reused.
</span><span class="cx">          get: (function(){
</span><span class="lines">@@ -1071,8 +1085,8 @@
</span><span class="cx">           * Binds `single` instead of using the context argument to ensure
</span><span class="cx">           * it receives no parameters.
</span><span class="cx">           *
</span><del>-                * @param {Array} models
-                * @param {Object} options
</del><ins>+                 * @param {Array} [models=[]] Array of models used to populate the collection.
+                * @param {Object} [options={}]
</ins><span class="cx">            */
</span><span class="cx">          initialize: function( models, options ) {
</span><span class="cx">                  /**
</span></span></pre>
</div>
</div>

</body>
</html>