Changeset 53317

Timestamp:

04/29/2022 07:22:56 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Formatting corrections for various docblocks.

See #54729

Location:

trunk/src/wp-includes

Files:

• class-wp-image-editor-gd.php (modified) (1 diff)
• class-wp-image-editor-imagick.php (modified) (1 diff)
• class-wp-image-editor.php (modified) (1 diff)
• functions.php (modified) (1 diff)
• option.php (modified) (2 diffs)
• rest-api/endpoints/class-wp-rest-url-details-controller.php (modified) (4 diffs)

trunk/src/wp-includes/class-wp-image-editor-gd.php

@@ -234 +234 @@
          *     maintain aspect ratio according to the source image.
          *
-         *     @type array $size {
+         *     @type array ...$0 {
          *         Array of height, width values, and whether to crop.
          *

trunk/src/wp-includes/class-wp-image-editor-imagick.php

@@ -445 +445 @@
          *     maintain aspect ratio according to the provided dimension.
          *
-         *     @type array $size {
+         *     @type array ...$0 {
          *         Array of height, width values, and whether to crop.
          *

trunk/src/wp-includes/class-wp-image-editor.php

@@ -110 +110 @@
          *     An array of image size arrays. Default sizes are 'small', 'medium', 'large'.
          *
-         *     @type array $size {
+         *     @type array ...$0 {
          *         @type int  $width  Image width.
          *         @type int  $height Image height.

trunk/src/wp-includes/functions.php

@@ -4516 +4516 @@
  *     Optional. Options to be used with `json_decode()`.
  *
- *     @type bool associative Optional. When `true`, JSON objects will be returned as associative arrays.
- *                            When `false`, JSON objects will be returned as objects.
+ *     @type bool $associative Optional. When `true`, JSON objects will be returned as associative arrays.
+ *                             When `false`, JSON objects will be returned as objects.
  * }
  *

trunk/src/wp-includes/option.php

@@ -29 +29 @@
  *
  * Exceptions:
+ *
  * 1. When the option has not been saved in the database, the `$default` value
  *    is returned if provided. If not, boolean `false` is returned.
- * 2. When one of the Options API filters is used: {@see 'pre_option_{$option}'},
- *    {@see 'default_option_{$option}'}, or {@see 'option_{$option}'}, the returned
+ * 2. When one of the Options API filters is used: {@see 'pre_option_$option'},
+ *    {@see 'default_option_$option'}, or {@see 'option_$option'}, the returned
  *    value may not match the expected type.
  * 3. When the option has just been saved in the database, and get_option()
@@ -40 +41 @@
  * Examples:
  *
- * When adding options like this: `add_option( 'my_option_name', 'value' );`
- * and then retrieving them with `get_option( 'my_option_name' );`, the returned
+ * When adding options like this: `add_option( 'my_option_name', 'value' )`
+ * and then retrieving them with `get_option( 'my_option_name' )`, the returned
  * values will be:
  *
- * `false` returns `string(0) ""`
- * `true`  returns `string(1) "1"`
- * `0`     returns `string(1) "0"`
- * `1`     returns `string(1) "1"`
- * `'0'`   returns `string(1) "0"`
- * `'1'`   returns `string(1) "1"`
- * `null`  returns `string(0) ""`
+ *   - `false` returns `string(0) ""`
+ *   - `true`  returns `string(1) "1"`
+ *   - `0`     returns `string(1) "0"`
+ *   - `1`     returns `string(1) "1"`
+ *   - `'0'`   returns `string(1) "0"`
+ *   - `'1'`   returns `string(1) "1"`
+ *   - `null`  returns `string(0) ""`
  *
  * When adding options with non-scalar values like
- * `add_option( 'my_array', array( false, 'str', null ) );`, the returned value
+ * `add_option( 'my_array', array( false, 'str', null ) )`, the returned value
  * will be identical to the original as it is serialized before saving
  * it in the database:
  *
- *    array(3) {
- *        [0] => bool(false)
- *        [1] => string(3) "str"
- *        [2] => NULL
- *    }
+ *     array(3) {
+ *         [0] => bool(false)
+ *         [1] => string(3) "str"
+ *         [2] => NULL
+ *     }
  *
  * @since 1.5.0

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php

@@ -350 +350 @@
          *     A multi-dimensional indexed array on success, else empty array.
          *
-         *     @type string[] 0 Meta elements with a content attribute.
-         *     @type string[] 1 Content attribute's opening quotation mark.
-         *     @type string[] 2 Content attribute's value for each meta element.
+         *     @type string[] $0 Meta elements with a content attribute.
+         *     @type string[] $1 Content attribute's opening quotation mark.
+         *     @type string[] $2 Content attribute's value for each meta element.
          * }
          * @return string The meta description contents on success. Empty string if not found.
@@ -386 +386 @@
          *     A multi-dimensional indexed array on success, else empty array.
          *
-         *     @type string[] 0 Meta elements with a content attribute.
-         *     @type string[] 1 Content attribute's opening quotation mark.
-         *     @type string[] 2 Content attribute's value for each meta element.
+         *     @type string[] $0 Meta elements with a content attribute.
+         *     @type string[] $1 Content attribute's opening quotation mark.
+         *     @type string[] $2 Content attribute's value for each meta element.
          * }
          * @param string $url The target website URL.
@@ -528 +528 @@
          *     A multi-dimensional indexed array on success, else empty array.
          *
-         *     @type string[] 0 Meta elements with a content attribute.
-         *     @type string[] 1 Content attribute's opening quotation mark.
-         *     @type string[] 2 Content attribute's value for each meta element.
+         *     @type string[] $0 Meta elements with a content attribute.
+         *     @type string[] $1 Content attribute's opening quotation mark.
+         *     @type string[] $2 Content attribute's value for each meta element.
          * }
          */
@@ -608 +608 @@
          *     A multi-dimensional indexed array on success, else empty array.
          *
-         *     @type string[] 0 Meta elements with a content attribute.
-         *     @type string[] 1 Content attribute's opening quotation mark.
-         *     @type string[] 2 Content attribute's value for each meta element.
+         *     @type string[] $0 Meta elements with a content attribute.
+         *     @type string[] $1 Content attribute's opening quotation mark.
+         *     @type string[] $2 Content attribute's value for each meta element.
          * }
          * @param string $attr       Attribute that identifies the element with the target metadata.