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.

Built from https://develop.svn.wordpress.org/trunk@37068


git-svn-id: http://core.svn.wordpress.org/trunk@37035 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-03-23 16:58:26 +00:00
parent d6a45b15f3
commit d78762c1ef
2 changed files with 17 additions and 13 deletions

View File

@ -192,7 +192,7 @@ class WP_oEmbed {
} }
/** /**
* Make private/protected methods readable for backwards compatibility. * Exposes private/protected methods for backwards compatibility.
* *
* @since 4.0.0 * @since 4.0.0
* @access public * @access public
@ -249,14 +249,16 @@ class WP_oEmbed {
} }
/** /**
* Add an oEmbed provider just-in-time when wp_oembed_add_provider() is called * Adds an oEmbed provider.
* before the 'plugins_loaded' hook.
* *
* The just-in-time addition is for the benefit of the 'oembed_providers' filter. * The provider is removed just-in-time when wp_oembed_add_provider() is called before
* the {@see 'plugins_loaded'} hook.
* *
* The just-in-time addition is for the benefit of the {@see 'oembed_providers'} filter.
*
* @static
* @since 4.0.0 * @since 4.0.0
* @access public * @access public
* @static
* *
* @see wp_oembed_add_provider() * @see wp_oembed_add_provider()
* *
@ -275,10 +277,12 @@ class WP_oEmbed {
} }
/** /**
* Remove an oEmbed provider just-in-time when wp_oembed_remove_provider() is called * Removes an oEmbed provider.
* before the 'plugins_loaded' hook.
* *
* The just-in-time removal is for the benefit of the 'oembed_providers' filter. * The provider is removed just-in-time when wp_oembed_remove_provider() is called before
* the {@see 'plugins_loaded'} hook.
*
* The just-in-time removal is for the benefit of the {@see 'oembed_providers'} filter.
* *
* @since 4.0.0 * @since 4.0.0
* @access public * @access public
@ -514,7 +518,7 @@ class WP_oEmbed {
} }
/** /**
* Helper function for parsing an XML response body. * Serves as a helper function for parsing an XML response body.
* *
* @since 3.6.0 * @since 3.6.0
* @access private * @access private
@ -552,7 +556,7 @@ class WP_oEmbed {
} }
/** /**
* Converts a data object from {@link WP_oEmbed::fetch()} and returns the HTML. * Converts a data object from WP_oEmbed::fetch() and returns the HTML.
* *
* @since 2.9.0 * @since 2.9.0
* @access public * @access public
@ -608,7 +612,7 @@ class WP_oEmbed {
} }
/** /**
* Strip any new lines from the HTML. * Strips any new lines from the HTML.
* *
* @since 2.9.0 as strip_scribd_newlines() * @since 2.9.0 as strip_scribd_newlines()
* @since 3.0.0 * @since 3.0.0
@ -650,7 +654,7 @@ class WP_oEmbed {
} }
/** /**
* Returns the initialized {@link WP_oEmbed} object * Returns the initialized WP_oEmbed object.
* *
* @since 2.9.0 * @since 2.9.0
* @access private * @access private

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.5-beta4-37067'; $wp_version = '4.5-beta4-37068';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.