Changeset 48573

Timestamp:

07/23/2020 12:46:56 AM (4 years ago)

Author:

johnbillion

Message:

Docs: Various corrections to inline docblocks.

See #49572

Location:

trunk/src

Files:

• wp-admin/includes/taxonomy.php (modified) (1 diff)
• wp-admin/includes/template.php (modified) (1 diff)
• wp-includes/blocks.php (modified) (2 diffs)
• wp-includes/class-wp-customize-manager.php (modified) (1 diff)
• wp-includes/class-wp-customize-setting.php (modified) (4 diffs)
• wp-includes/class-wp-dependency.php (modified) (1 diff)
• wp-includes/functions.php (modified) (1 diff)
• wp-includes/general-template.php (modified) (1 diff)
• wp-includes/kses.php (modified) (2 diffs)
• wp-includes/pomo/po.php (modified) (1 diff)
• wp-includes/post-template.php (modified) (1 diff)
• wp-includes/script-loader.php (modified) (1 diff)
• wp-includes/theme.php (modified) (1 diff)

trunk/src/wp-admin/includes/taxonomy.php

@@ -301 +301 @@
  * @since 2.8.0
  *
- * @param int|string $tag_name
- * @param string $taxonomy Optional. The taxonomy for which to retrieve terms. Default 'post_tag'.
+ * @param string $tag_name The term name.
+ * @param string $taxonomy Optional. The taxonomy within which to create the term. Default 'post_tag'.
  * @return array|WP_Error
  */

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

@@ -2222 +2222 @@
 
 /**
- * Function to echo the attachment media states as HTML.
+ * Outputs the attachment media states as HTML.
  *
  * @since 3.2.0
  *
  * @param WP_Post $post The attachment post to retrieve states for.
- * @return string Media states string.
  */
 function _media_states( $post ) {

trunk/src/wp-includes/blocks.php

@@ -360 +360 @@
  * @since 5.3.1
  *
- * @param array $attributes Attributes object.
+ * @param array $block_attributes Attributes object.
  * @return string Serialized attributes.
  */
@@ -397 +397 @@
  * @since 5.3.1
  *
- * @param string $block_name Block name.
- * @param array  $attributes Block attributes.
- * @param string $content    Block save content.
+ * @param string $block_name       Block name.
+ * @param array  $block_attributes Block attributes.
+ * @param string $block_content    Block save content.
  * @return string Comment-delimited block content.
  */

trunk/src/wp-includes/class-wp-customize-manager.php

@@ -2293 +2293 @@
      * @since 3.4.0
      *
-     * @param $current_theme {@internal Parameter is not used}
+     * @param mixed $current_theme {@internal Parameter is not used}
      * @return string Theme name.
      */

trunk/src/wp-includes/class-wp-customize-setting.php

@@ -847 +847 @@
      * @since 3.4.0
      *
-     * @param $root
-     * @param $keys
+     * @param array $root
+     * @param array $keys
      * @param bool $create Default false.
      * @return array|void Keys are 'root', 'node', and 'key'.
@@ -902 +902 @@
      * @since 3.4.0
      *
-     * @param $root
-     * @param $keys
+     * @param array $root
+     * @param array $keys
      * @param mixed $value The value to update.
      * @return mixed
@@ -928 +928 @@
      * @since 3.4.0
      *
-     * @param $root
-     * @param $keys
+     * @param array $root
+     * @param array $keys
      * @param mixed $default A default value which is used as a fallback. Default null.
      * @return mixed The requested value or the default value.
@@ -947 +947 @@
      * @since 3.4.0
      *
-     * @param $root
-     * @param $keys
+     * @param array $root
+     * @param array $keys
      * @return bool True if value is set, false if not.
      */

trunk/src/wp-includes/class-wp-dependency.php

@@ -91 +91 @@
      *              to the function signature.
      *
-     * @param ...$args Dependency information.
+     * @param mixed ...$args Dependency information.
      */
     public function __construct( ...$args ) {

trunk/src/wp-includes/functions.php

@@ -2598 +2598 @@
  *
  * @param string $filename The file name to check.
- * $param array  $files    An array of existing files in the directory.
- * $return bool True if the tested file name could match an existing file, false otherwise.
+ * @param array  $files    An array of existing files in the directory.
+ * @return bool True if the tested file name could match an existing file, false otherwise.
  */
 function _wp_check_existing_file_names( $filename, $files ) {

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

@@ -2163 +2163 @@
  *
  * @param bool $initial Optional. Whether to use initial calendar names. Default true.
- * @param bool $display Optional. Whether to display or return the calendar. Default true.
+ * @param bool $echo    Optional. Whether to display the calendar output. Default true.
  * @return void|string Void if `$echo` argument is true, calendar HTML if `$echo` is false.
  */

trunk/src/wp-includes/kses.php

@@ -1035 +1035 @@
  * @global string[]       $pass_allowed_protocols Array of allowed URL protocols.
  *
+ * @param array $matches preg_replace regexp matches
  * @return string
  */
@@ -1713 +1714 @@
  * @param string   $string            Content to check for bad protocols.
  * @param string[] $allowed_protocols Array of allowed URL protocols.
+ * @param int      $count             Depth of call recursion to this function.
  * @return string Sanitized content.
  */

trunk/src/wp-includes/pomo/po.php

@@ -93 +93 @@
          *
          * Doesn't need to include # in the beginning of lines, these are added automatically
+         *
+         * @param string $text Text to include as a comment.
          */
         function set_comment_before_headers( $text ) {

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

@@ -1545 +1545 @@
  * @see Walker_PageDropdown::walk() for parameters and return description.
  *
+ * @param mixed ...$args Elements array, maximum hierarchical depth and optional additional arguments.
  * @return string
  */

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

@@ -40 +40 @@
  * @since 5.0.0
  *
- * @param WP_Scripts $scripts WP_Scripts object.
+ * @param WP_Scripts $scripts            WP_Scripts object.
+ * @param bool       $force_uncompressed Whether to forcibly prevent gzip compression. Default false.
  */
 function wp_register_tinymce_scripts( $scripts, $force_uncompressed = false ) {

trunk/src/wp-includes/theme.php

@@ -2472 +2472 @@
  * @since 5.3.0 Formalized the existing and already documented `...$args` parameter
  *              by adding it to the function signature.
+ * @since 5.5.0 The `core-block-patterns` feature was added and is enabled by default.
  *
  * @global array $_wp_theme_features