Changeset 42675

Timestamp:

02/09/2018 02:31:18 PM (7 years ago)

Author:

atimmer

Message:

Docs: Improve JSDoc for media/views/spinner.js.

Props avillegasn.
Fixes #43230.

File:

• trunk/src/wp-includes/js/media/views/spinner.js (modified) (3 diffs)

trunk/src/wp-includes/js/media/views/spinner.js

@@ -1 +1 @@
 /**
  * wp.media.view.Spinner
+ *
+ * Represents a spinner in the Media Library.
+ *
+ * @since 3.9.0
  *
  * @memberOf wp.media.view
@@ -15 +19 @@
     delay: 400,
 
+    /**
+     * Shows the spinner. Delays the visibility by the configured amount.
+     *
+     * @since 3.9.0
+     *
+     * @return {wp.media.view.Spinner} The spinner.
+     */
     show: function() {
         if ( ! this.spinnerTimeout ) {
@@ -25 +36 @@
     },
 
+    /**
+     * Hides the spinner.
+     *
+     * @since 3.9.0
+     *
+     * @return {wp.media.view.Spinner} The spinner.
+     */
     hide: function() {
         this.$el.removeClass( 'is-active' );