Changeset 27000

Timestamp:

01/22/2014 05:16:56 PM (13 years ago)

Author:

wonderboymusic

Message:

Add the @namespace annotation where appropriate in media-editor.js. Also indicate the default value of a few params via the [options={}] syntax.

See #26870.

File:

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

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

@@ -13 +13 @@
         /**
          * wp.media.string
+         * @namespace
          */
         wp.media.string = {
@@ -20 +21 @@
                  * attachment's type.
                  *
-                 * @global wp.media.view.settings.defaultProps
-                 *
-                 * @param {Object} props Attachment details (align, link, size, etc).
+                 * @global wp.media.view.settings
+                 *
+                 * @param {Object} [props={}] Attachment details (align, link, size, etc).
                  * @param {Object} attachment The attachment object, media version of Post.
                  * @returns {Object} Joined props
@@ -275 +276 @@
         /**
          * wp.media.gallery
-         *
-         * @type {Object}
+         * @namespace
          */
         wp.media.gallery = (function() {
@@ -502 +502 @@
         /**
          * wp.media.featuredImage
+         * @namespace
          */
         wp.media.featuredImage = {
@@ -611 +612 @@
         /**
          * wp.media.editor
+         * @namespace
          */
         wp.media.editor = {
@@ -884 +886 @@
                 /**
                  * @param {string} id
-                 * @param {Object} options
+                 * @param {Object} [options={}]
                  *
                  * @this wp.media.editor