Make WordPress Core


Ignore:
Timestamp:
11/09/2023 09:49:41 AM (4 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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php

    r55337 r57099  
    627627     * @return array {
    628628     *     @type array {
    629      *         @string string $expected_status The expected post status after calling the function.
    630      *         @string string $response_page   The exporter page to pass. Options are 'first' and 'last'. Default 'first'.
    631      *         @string string $exporter_index  The exporter index to pass. Options are 'first' and 'last'. Default 'first'.
    632      *         @string string $page_index      The page index to pass. Options are 'first' and 'last'. Default 'first'.
    633      *         @bool  bool   $send_as_email   If the response should be sent as an email.
    634      *         @string string $exporter_key    The slug (key) of the exporter to pass.
     629     *         @type string $expected_status The expected post status after calling the function.
     630     *         @type string $response_page   The exporter page to pass. Options are 'first' and 'last'. Default 'first'.
     631     *         @type string $exporter_index  The exporter index to pass. Options are 'first' and 'last'. Default 'first'.
     632     *         @type string $page_index      The page index to pass. Options are 'first' and 'last'. Default 'first'.
     633     *         @type bool   $send_as_email   If the response should be sent as an email.
     634     *         @type string $exporter_key    The slug (key) of the exporter to pass.
    635635     *     }
    636636     * }
Note: See TracChangeset for help on using the changeset viewer.