Changeset 27321

Timestamp:

02/27/2014 09:50:40 PM (12 years ago)

Author:

wonderboymusic

Message:

Restore / re-tools some docs after [27313].

See #26631.

File:

• trunk/src/wp-includes/js/media-editor.js (modified) (4 diffs)

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

@@ -279 +279 @@
 
                 return _.extend( attributes, {
+                        /**
+                         * A helper function to avoid truthy and falsey values being
+                         *   passed as an input that expects booleans. If key is undefined in the map,
+                         *   but has a default value, set it.
+                         *
+                         * @param {object} attrs Map of props from a shortcode or settings.
+                         * @param {string} key The key within the passed map to check for a value.
+                         * @returns {mixed|undefined} The original or coerced value of key within attrs
+                         */
                         coerce: function ( attrs, key ) {
                                 if ( _.isUndefined( attrs[ key ] ) && ! _.isUndefined( this.defaults[ key ] ) ) {
@@ -289 +298 @@
                                 return attrs[ key ];
                         },
-
+                        /**
+                         * Retrieve attachments based on the properties of the passed shortcode
+                         *
+                         * @global wp.media.query
+                         *
+                         * @param {wp.shortcode} shortcode An instance of wp.shortcode().
+                         * @returns {wp.media.model.Attachments} A Backbone.Collection containing
+                         *      the media items belonging to a collection.
+                         *      The query[ this.tag ] property is a Backbone.Model
+                         *          containing the 'props' for the collection.
+                         */
                         attachments: function( shortcode ) {
                                 var shortcodeString = shortcode.string(),
@@ -347 +366 @@
                                 return query;
                         },
-
+                        /**
+                         * Triggered when clicking 'Insert {label}' or 'Update {label}'
+                         *
+                         * @global wp.shortcode
+                         * @global wp.media.model.Attachments
+                         *
+                         * @param {wp.media.model.Attachments} attachments A Backbone.Collection containing
+                         *      the media items belonging to a collection.
+                         *      The query[ this.tag ] property is a Backbone.Model
+                         *          containing the 'props' for the collection.
+                         * @returns {wp.shortcode}
+                         */
                         shortcode: function( attachments ) {
                                 var props = attachments.props.toJSON(),
@@ -406 +436 @@
                                 return shortcode;
                         },
-
+                        /**
+                         * Triggered when double-clicking a collection shortcode placeholder
+                         *   in the editor
+                         *
+                         * @global wp.shortcode
+                         * @global wp.media.model.Selection
+                         * @global wp.media.view.l10n
+                         *
+                         * @param {string} content Content that is searched for possible
+                         *    shortcode markup matching the passed tag name,
+                         *
+                         * @this wp.media.{prop}
+                         *
+                         * @returns {wp.media.view.MediaFrame.Select} A media workflow.
+                         */
                         edit: function( content ) {
                                 var shortcode = wp.shortcode.next( this.tag, content ),