Changeset 57099 for trunk/tests/phpunit/tests/ajax/wpCustomizeNavMenus.php

Timestamp:

11/09/2023 09:49:41 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Fix various incorrect WP-flavored array specifications.

Tags like @string or @array do not exist and are not supported. The way these were used here, also meant duplicate information being documented.

Fixed now by using the @type tag as per the WP flavor of array documentation.

Includes some fixes to the documentation formatting.

Reference: ​PHP Documentation Standards: Parameters That Are Arrays.

Follow-up to [33322], [42880], [42971], [44786].

Props jrf.
See #59651.

File:

• trunk/tests/phpunit/tests/ajax/wpCustomizeNavMenus.php (modified) (4 diffs)

trunk/tests/phpunit/tests/ajax/wpCustomizeNavMenus.php

@@ -120 +120 @@
          * @return array {
          *     @type array {
-         *         @string string $role             The role that will test caps for.
-         *         @array  array  $expected_results The expected results from the Ajax call.
+         *         @type string $role             The role that will test caps for.
+         *         @type array  $expected_results The expected results from the Ajax call.
          *     }
          * }
@@ -192 +192 @@
          * @return array {
          *     @type array {
-         * @array array $post_args        The arguments that will merged with the $_POST array.
-         * @array array $expected_results The expected results from the Ajax call.
+         *         @type array $post_args        The arguments that will merged with the $_POST array.
+         *         @type array $expected_results The expected results from the Ajax call.
          *     }
          * }
@@ -516 +516 @@
          * @return array {
          *     @type array {
-         * @string string $role             The role that will test caps for.
-         * @array  array  $expected_results The expected results from the Ajax call.
+         *         @type string $role             The role that will test caps for.
+         *         @type array  $expected_results The expected results from the Ajax call.
          *     }
          * }
@@ -611 +611 @@
          * @return array {
          *     @type array {
-         * @string string $post_args        The args that will be passed to Ajax.
-         * @array  array  $expected_results The expected results from the Ajax call.
+         *         @type string $post_args        The args that will be passed to Ajax.
+         *         @type array  $expected_results The expected results from the Ajax call.
          *     }
          * }