Changeset 46610

Timestamp:

10/28/2019 07:46:13 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Miscellaneous docblock corrections.

See #48303

Location:

trunk/src

Files:

• wp-admin/includes/class-core-upgrader.php (modified) (1 diff)
• wp-admin/includes/class-wp-list-table.php (modified) (4 diffs)
• wp-includes/functions.php (modified) (3 diffs)
• wp-includes/post-template.php (modified) (1 diff)
• wp-includes/script-loader.php (modified) (4 diffs)

trunk/src/wp-admin/includes/class-core-upgrader.php

@@ -128 +128 @@
         if ( is_wp_error( $download ) && $download->get_error_data( 'softfail-filename' ) ) {
             // Outout the failure error as a normal feedback, and not as an error:
+            /** This filter is documented in wp-admin/includes/update-core.php */
             apply_filters( 'update_feedback', $download->get_error_message() );
 

trunk/src/wp-admin/includes/class-wp-list-table.php

@@ -502 +502 @@
 
     /**
-     * Generate row actions div
+     * Generates the required HTML for a list of row action links.
      *
      * @since 3.1.0
@@ -508 +508 @@
      * @param string[] $actions        An array of action links.
      * @param bool     $always_visible Whether the actions should be always visible.
-     * @return string
+     * @return string The HTML for the row actions.
      */
     protected function row_actions( $actions, $always_visible = false ) {
@@ -532 +532 @@
 
     /**
-     * Display a monthly dropdown for filtering items
+     * Displays a dropdown for filtering items in the list table by month.
      *
      * @since 3.1.0
@@ -539 +539 @@
      * @global WP_Locale $wp_locale WordPress date and time locale object.
      *
-     * @param string $post_type
+     * @param string $post_type The post type.
      */
     protected function months_dropdown( $post_type ) {

trunk/src/wp-includes/functions.php

@@ -2619 +2619 @@
  *     Values for the extension and mime type.
  *
- *     @type string|false $0 File extension, or false if the file doesn't match a mime type.
- *     @type string|false $1 File mime type, or false if the file doesn't match a mime type.
+ *     @type string|false $ext  File extension, or false if the file doesn't match a mime type.
+ *     @type string|false $type File mime type, or false if the file doesn't match a mime type.
  * }
  */
@@ -2661 +2661 @@
  *     Values for the extension, mime type, and corrected filename.
  *
- *     @type string|false $0 File extension, or false if the file doesn't match a mime type.
- *     @type string|false $1 File mime type, or false if the file doesn't match a mime type.
- *     @type string|false $2 File name with its correct extension, or false if it cannot be determined.
+ *     @type string|false $ext             File extension, or false if the file doesn't match a mime type.
+ *     @type string|false $type            File mime type, or false if the file doesn't match a mime type.
+ *     @type string|false $proper_filename File name with its correct extension, or false if it cannot be determined.
  * }
  */
@@ -2823 +2823 @@
      *     Values for the extension, mime type, and corrected filename.
      *
-     *     @type string|false $0 File extension, or false if the file doesn't match a mime type.
-     *     @type string|false $1 File mime type, or false if the file doesn't match a mime type.
-     *     @type string|false $2 File name with its correct extension, or false if it cannot be determined.
+     *     @type string|false $ext             File extension, or false if the file doesn't match a mime type.
+     *     @type string|false $type            File mime type, or false if the file doesn't match a mime type.
+     *     @type string|false $proper_filename File name with its correct extension, or false if it cannot be determined.
      * }
      * @param string      $file                      Full path to the file.

trunk/src/wp-includes/post-template.php

@@ -420 +420 @@
      * @since 4.5.0 Introduced the `$post` parameter.
      *
-     * @param string $post_excerpt The post excerpt.
-     * @param WP_Post $post Post object.
+     * @param string  $post_excerpt The post excerpt.
+     * @param WP_Post $post         Post object.
      */
     return apply_filters( 'get_the_excerpt', $post->post_excerpt, $post );

trunk/src/wp-includes/script-loader.php

@@ -779 +779 @@
     );
 
-    /* This filter is documented in wp-includes/class-wp-editor.php */
+    /** This filter is documented in wp-includes/class-wp-editor.php */
     $tinymce_plugins = apply_filters( 'tiny_mce_plugins', $tinymce_plugins, 'classic-block' );
     $tinymce_plugins = array_unique( $tinymce_plugins );
@@ -808 +808 @@
     );
 
-    /* This filter is documented in wp-includes/class-wp-editor.php */
+    /** This filter is documented in wp-includes/class-wp-editor.php */
     $toolbar1 = apply_filters( 'mce_buttons', $toolbar1, 'classic-block' );
 
@@ -825 +825 @@
     );
 
-    /* This filter is documented in wp-includes/class-wp-editor.php */
+    /** This filter is documented in wp-includes/class-wp-editor.php */
     $toolbar2 = apply_filters( 'mce_buttons_2', $toolbar2, 'classic-block' );
-    /* This filter is documented in wp-includes/class-wp-editor.php */
+    /** This filter is documented in wp-includes/class-wp-editor.php */
     $toolbar3 = apply_filters( 'mce_buttons_3', array(), 'classic-block' );
-    /* This filter is documented in wp-includes/class-wp-editor.php */
+    /** This filter is documented in wp-includes/class-wp-editor.php */
     $toolbar4 = apply_filters( 'mce_buttons_4', array(), 'classic-block' );
-    /* This filter is documented in wp-includes/class-wp-editor.php */
+    /** This filter is documented in wp-includes/class-wp-editor.php */
     $external_plugins = apply_filters( 'mce_external_plugins', array(), 'classic-block' );
 
@@ -852 +852 @@
     }
 
-    /* This filter is documented in wp-includes/class-wp-editor.php */
+    /** This filter is documented in wp-includes/class-wp-editor.php */
     $tinymce_settings = apply_filters( 'tiny_mce_before_init', $tinymce_settings, 'classic-block' );