WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
03/23/2016 04:57:08 PM (9 years ago)
Author:
DrewAPicture
Message:

Docs: Use third-person singular verbs for summary DocBlocks in WP_oEmbed.

Also fixes inline @see formatting in appropriate places (summaries should not contain tags or markdown).

Props ramiy.
See #36296.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/class-oembed.php

    r37067 r37068  
    193193
    194194    /**
    195      * Make private/protected methods readable for backwards compatibility.
     195     * Exposes private/protected methods for backwards compatibility.
    196196     *
    197197     * @since 4.0.0
    … …  
    250250
    251251    /**
    252      * Add an oEmbed provider just-in-time when wp_oembed_add_provider() is called
    253      * before the 'plugins_loaded' hook.
    254      *
    255      * The just-in-time addition is for the benefit of the 'oembed_providers' filter.
    256      *
     252     * Adds an oEmbed provider.
     253     *
     254     * The provider is removed just-in-time when wp_oembed_add_provider() is called before
     255     * the {@see 'plugins_loaded'} hook.
     256     *
     257     * The just-in-time addition is for the benefit of the {@see 'oembed_providers'} filter.
     258     *
     259     * @static
    257260     * @since 4.0.0
    258261     * @access public
    259      * @static
    260262     *
    261263     * @see wp_oembed_add_provider()
    … …  
    276278
    277279    /**
    278      * Remove an oEmbed provider just-in-time when wp_oembed_remove_provider() is called
    279      * before the 'plugins_loaded' hook.
    280      *
    281      * The just-in-time removal is for the benefit of the 'oembed_providers' filter.
     280     * Removes an oEmbed provider.
     281     *
     282     * The provider is removed just-in-time when wp_oembed_remove_provider() is called before
     283     * the {@see 'plugins_loaded'} hook.
     284     *
     285     * The just-in-time removal is for the benefit of the {@see 'oembed_providers'} filter.
    282286     *
    283287     * @since 4.0.0
    … …  
    515519
    516520    /**
    517      * Helper function for parsing an XML response body.
     521     * Serves as a helper function for parsing an XML response body.
    518522     *
    519523     * @since 3.6.0
    … …  
    553557
    554558    /**
    555      * Converts a data object from {@link WP_oEmbed::fetch()} and returns the HTML.
     559     * Converts a data object from WP_oEmbed::fetch() and returns the HTML.
    556560     *
    557561     * @since 2.9.0
    … …  
    609613
    610614    /**
    611      * Strip any new lines from the HTML.
     615     * Strips any new lines from the HTML.
    612616     *
    613617     * @since 2.9.0 as strip_scribd_newlines()
    … …  
    651655
    652656/**
    653  * Returns the initialized {@link WP_oEmbed} object
     657 * Returns the initialized WP_oEmbed object.
    654658 *
    655659 * @since 2.9.0
Note: See TracChangeset for help on using the changeset viewer.