Changeset 57099

Timestamp:

11/09/2023 09:49:41 AM (17 months 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.

Location:

trunk/tests/phpunit/tests

Files:

• ajax/wpCustomizeNavMenus.php (modified) (4 diffs)
• functions/anonymization.php (modified) (2 diffs)
• kses.php (modified) (2 diffs)
• privacy/wpPrivacyProcessPersonalDataExportPage.php (modified) (1 diff)

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.
      *     }
      * }

trunk/tests/phpunit/tests/functions/anonymization.php

@@ -42 +42 @@
      * @return array {
      *     @type array {
-     *         @string string $raw_ip          Raw IP address.
-     *         @string string $expected_result Expected result.
+     *         @type string $raw_ip          Raw IP address.
+     *         @type string $expected_result Expected result.
      *     }
      * }
@@ -196 +196 @@
      * @return array {
      *     @type array {
-     *         @string string $raw_ip          Raw IP address.
-     *         @string string $expected_result Expected result.
+     *         @type string $raw_ip          Raw IP address.
+     *         @type string $expected_result Expected result.
      *     }
      * }

trunk/tests/phpunit/tests/kses.php

@@ -953 +953 @@
      * @return array {
      *     @type array {
-     *         @string string $css      A string of CSS rules.
-     *         @string string $expected Expected string of CSS rules.
+     *         @type string $css      A string of CSS rules.
+     *         @type string $expected Expected string of CSS rules.
      *     }
      * }
@@ -1615 +1615 @@
      * @return array {
      *     @type array {
-     *         @string string $css      A string of CSS rules.
-     *         @string string $expected Expected string of CSS rules.
+     *         @type string $css      A string of CSS rules.
+     *         @type string $expected Expected string of CSS rules.
      *     }
      * }

trunk/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php

@@ -627 +627 @@
      * @return array {
      *     @type array {
-     *         @string string $expected_status The expected post status after calling the function.
-     *         @string string $response_page   The exporter page to pass. Options are 'first' and 'last'. Default 'first'.
-     *         @string string $exporter_index  The exporter index to pass. Options are 'first' and 'last'. Default 'first'.
-     *         @string string $page_index      The page index to pass. Options are 'first' and 'last'. Default 'first'.
-     *         @bool   bool   $send_as_email   If the response should be sent as an email.
-     *         @string string $exporter_key    The slug (key) of the exporter to pass.
+     *         @type string $expected_status The expected post status after calling the function.
+     *         @type string $response_page   The exporter page to pass. Options are 'first' and 'last'. Default 'first'.
+     *         @type string $exporter_index  The exporter index to pass. Options are 'first' and 'last'. Default 'first'.
+     *         @type string $page_index      The page index to pass. Options are 'first' and 'last'. Default 'first'.
+     *         @type bool   $send_as_email   If the response should be sent as an email.
+     *         @type string $exporter_key    The slug (key) of the exporter to pass.
      *     }
      * }