WordPress.org

Make WordPress Core

Changeset 31170


Ignore:
Timestamp:
01/13/2015 12:50:32 AM (7 years ago)
Author:
DrewAPicture
Message:

Ensure we're using the correct @ignore phpDocumentor tag to mark elements that should be skipped when parsing.

Up to this point, various core elements' DocBlocks incorrectly included an @internal tag as a means for skipping the parsing process. When paired with a description (inline or otherwise), @internal is a valid tag meant to provide internal-only context, but not necessarily to skip parsing the entire element.

See #30987.

Location:
trunk/src
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/admin.php

    r31121 r31170  
    217217         * Used to call the registered callback for a plugin screen.
    218218         *
    219          * @internal
     219         * @ignore
    220220         * @since 1.5.0
    221221         */
  • trunk/src/wp-cron.php

    r28380 r31170  
    9595             * Fires scheduled events.
    9696             *
    97              * @internal
     97             * @ignore
    9898             * @since 2.1.0
    9999             *
  • trunk/src/wp-includes/functions.php

    r31120 r31170  
    26852685 * Perform sanity checks on data that shall be encoded to JSON.
    26862686 *
    2687  * @see wp_json_encode()
    2688  *
     2687 * @ignore
    26892688 * @since 4.1.0
    26902689 * @access private
    2691  * @internal
     2690 *
     2691 * @see wp_json_encode()
    26922692 *
    26932693 * @param mixed $data  Variable (usually an array or object) to encode as JSON.
     
    27482748 * Convert a string to UTF-8, so that it can be safely encoded to JSON.
    27492749 *
    2750  * @see _wp_json_sanity_check()
    2751  *
     2750 * @ignore
    27522751 * @since 4.1.0
    27532752 * @access private
    2754  * @internal
     2753 *
     2754 * @see _wp_json_sanity_check()
    27552755 *
    27562756 * @param string $string The string which is to be converted.
     
    43214321 * Return a MySQL expression for selecting the week number based on the start_of_week option.
    43224322 *
    4323  * @internal
     4323 * @ignore
    43244324 * @since 3.0.0
    43254325 *
  • trunk/src/wp-includes/general-template.php

    r31168 r31170  
    717717 * Display title tag with contents.
    718718 *
     719 * @ignore
    719720 * @since 4.1.0
    720721 * @access private
    721  * @internal
    722722 *
    723723 * @see wp_title()
  • trunk/src/wp-includes/script-loader.php

    r31168 r31170  
    832832
    833833/**
    834  * @internal use
     834 * Print scripts (internal use only)
     835 *
     836 * @ignore
    835837 */
    836838function _print_scripts() {
     
    9981000
    9991001/**
    1000  * @internal use
     1002 * Print styles (internal use only)
     1003 *
     1004 * @ignore
    10011005 */
    10021006function _print_styles() {
Note: See TracChangeset for help on using the changeset viewer.