Changeset 58073

Timestamp:

05/01/2024 11:59:03 PM (9 months ago)

Author:

johnbillion

Message:

Docs: Various docblock corrections.

See #60699

Location:

trunk

Files:

• src/wp-admin/includes/plugin-install.php (modified) (1 diff)
• src/wp-includes/block-bindings.php (modified) (1 diff)
• src/wp-includes/class-wp-block-bindings-registry.php (modified) (1 diff)
• src/wp-includes/class-wp-block-type.php (modified) (3 diffs)
• src/wp-includes/class-wp-plugin-dependencies.php (modified) (1 diff)
• src/wp-includes/fonts.php (modified) (1 diff)
• src/wp-includes/fonts/class-wp-font-utils.php (modified) (1 diff)
• tests/phpunit/tests/user/capabilities.php (modified) (1 diff)

trunk/src/wp-admin/includes/plugin-install.php

@@ -918 +918 @@
  * @param bool         $compatible_php   The result of a PHP compatibility check.
  * @param bool         $compatible_wp    The result of a WP compatibility check.
- * @return string $button The markup for the dependency row button.
+ * @return string The markup for the dependency row button.
  */
 function wp_get_plugin_action_button( $name, $data, $compatible_php, $compatible_wp ) {

trunk/src/wp-includes/block-bindings.php

@@ -77 +77 @@
  *
  *     @type string   $label                   The label of the source.
- *     @type callback $get_value_callback      A callback executed when the source is processed during block rendering.
+ *     @type callable $get_value_callback      A callback executed when the source is processed during block rendering.
  *                                             The callback should have the following signature:
  *

trunk/src/wp-includes/class-wp-block-bindings-registry.php

@@ -80 +80 @@
      *
      *     @type string   $label                   The label of the source.
-     *     @type callback $get_value_callback      A callback executed when the source is processed during block rendering.
+     *     @type callable $get_value_callback      A callback executed when the source is processed during block rendering.
      *                                             The callback should have the following signature:
      *

trunk/src/wp-includes/class-wp-block-type.php

@@ -303 +303 @@
      * @since 6.3.0 Added the `selectors` property.
      * @since 6.4.0 Added the `block_hooks` property.
-     * @since 6.5.0 Added the `view_style_handles` property.
+     * @since 6.5.0 Added the `allowed_blocks`, `variation_callback`, and `view_style_handles` properties.
      *
      * @see register_block_type()
@@ -622 +622 @@
      * @since 6.5.0
      *
-     * @return array[]
+     * @return string[]
      */
     public function get_uses_context() {
@@ -630 +630 @@
          * @since 6.5.0
          *
-         * @param array         $uses_context Array of registered uses context for a block type.
+         * @param string[]      $uses_context Array of registered uses context for a block type.
          * @param WP_Block_Type $block_type   The full block type object.
          */

trunk/src/wp-includes/class-wp-plugin-dependencies.php

@@ -554 +554 @@
      *
      * @since 6.5.0
-     *
-     * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
      */
     protected static function read_dependencies_from_plugin_headers() {

trunk/src/wp-includes/fonts.php

@@ -16 +16 @@
  *     Optional. The font-families and their font faces. Default empty array.
  *
- *     @type array {
+ *     @type array ...$0 {
  *         An indexed or associative (keyed by font-family) array of font variations for this font-family.
  *         Each font face has the following structure.
  *
- *         @type array {
+ *         @type array ...$0 {
+ *             The font face properties.
+ *
  *             @type string          $font-family             The font-family property.
  *             @type string|string[] $src                     The URL(s) to each resource containing the font data.

trunk/src/wp-includes/fonts/class-wp-font-utils.php

@@ -222 +222 @@
      * @since 6.5.0
      *
-     * @param mixed $value     The value to sanitize.
-     * @param mixed $sanitizer The sanitizer function to apply.
+     * @param mixed    $value     The value to sanitize.
+     * @param callable $sanitizer The sanitizer function to apply.
      * @return mixed The sanitized value.
      */

trunk/tests/phpunit/tests/user/capabilities.php

@@ -455 +455 @@
     /**
      * Test the tests. The administrator role has all primitive capabilities, therefore the
-     * primitive capabilitity tests can be tested by checking that the list of tested
+     * primitive capability tests can be tested by checking that the list of tested
      * capabilities matches those of the administrator role.
      *