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/functions/anonymization.php

    r56971 r57099  
    4242     * @return array {
    4343     *     @type array {
    44      *         @string string $raw_ip          Raw IP address.
    45      *         @string string $expected_result Expected result.
     44     *         @type string $raw_ip          Raw IP address.
     45     *         @type string $expected_result Expected result.
    4646     *     }
    4747     * }
     
    196196     * @return array {
    197197     *     @type array {
    198      *         @string string $raw_ip          Raw IP address.
    199      *         @string string $expected_result Expected result.
     198     *         @type string $raw_ip          Raw IP address.
     199     *         @type string $expected_result Expected result.
    200200     *     }
    201201     * }
Note: See TracChangeset for help on using the changeset viewer.