Docs: Remove @access notations from method DocBlocks in wp-includes/* classes.

Prior to about 2013, many class methods lacked even access modifiers which made the `@access` notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.

See #41452.


git-svn-id: https://develop.svn.wordpress.org/trunk@41162 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes
2017-07-27 00:40:27 +00:00
parent 829139ba1a
commit b4d81bd654
135 changed files with 2 additions and 1906 deletions

View File

@@ -22,7 +22,6 @@ class WP_oEmbed {
* A list of oEmbed providers.
*
* @since 2.9.0
* @access public
* @var array
*/
public $providers = array();
@@ -31,7 +30,6 @@ class WP_oEmbed {
* A list of an early oEmbed providers.
*
* @since 4.0.0
* @access public
* @static
* @var array
*/
@@ -41,7 +39,6 @@ class WP_oEmbed {
* A list of private/protected methods, used for backward compatibility.
*
* @since 4.2.0
* @access private
* @var array
*/
private $compat_methods = array( '_fetch_with_format', '_parse_json', '_parse_xml', '_parse_xml_body' );
@@ -50,7 +47,6 @@ class WP_oEmbed {
* Constructor.
*
* @since 2.9.0
* @access public
*/
public function __construct() {
$host = urlencode( home_url() );
@@ -211,7 +207,6 @@ class WP_oEmbed {
* Exposes private/protected methods for backward compatibility.
*
* @since 4.0.0
* @access public
*
* @param callable $name Method to call.
* @param array $arguments Arguments to pass when calling.
@@ -228,7 +223,6 @@ class WP_oEmbed {
* Takes a URL and returns the corresponding oEmbed provider's URL, if there is one.
*
* @since 4.0.0
* @access public
*
* @see WP_oEmbed::discover()
*
@@ -275,7 +269,6 @@ class WP_oEmbed {
*
* @static
* @since 4.0.0
* @access public
*
* @see wp_oembed_add_provider()
*
@@ -302,7 +295,6 @@ class WP_oEmbed {
* The just-in-time removal is for the benefit of the {@see 'oembed_providers'} filter.
*
* @since 4.0.0
* @access public
* @static
*
* @see wp_oembed_remove_provider()
@@ -324,7 +316,6 @@ class WP_oEmbed {
* @see WP_oEmbed::fetch()
*
* @since 4.8.0
* @access public
*
* @param string $url The URL to the content that should be attempted to be embedded.
* @param array|string $args Optional. Arguments, usually passed from a shortcode. Default empty.
@@ -355,7 +346,6 @@ class WP_oEmbed {
* @see WP_oEmbed::data2html()
*
* @since 2.9.0
* @access public
*
* @param string $url The URL to the content that should be attempted to be embedded.
* @param array|string $args Optional. Arguments, usually passed from a shortcode. Default empty.
@@ -405,7 +395,6 @@ class WP_oEmbed {
* Attempts to discover link tags at the given URL for an oEmbed provider.
*
* @since 2.9.0
* @access public
*
* @param string $url The URL that should be inspected for discovery `<link>` tags.
* @return false|string False on failure, otherwise the oEmbed provider URL.
@@ -489,7 +478,6 @@ class WP_oEmbed {
* Connects to a oEmbed provider and returns the result.
*
* @since 2.9.0
* @access public
*
* @param string $provider The URL to the oEmbed provider.
* @param string $url The URL to the content that is desired to be embedded.
@@ -527,7 +515,6 @@ class WP_oEmbed {
* Fetches result from an oEmbed provider for a specific format and complete provider URL
*
* @since 3.0.0
* @access private
*
* @param string $provider_url_with_args URL to the provider with full arguments list (url, maxheight, etc.)
* @param string $format Format to use
@@ -552,7 +539,6 @@ class WP_oEmbed {
* Parses a json response body.
*
* @since 3.0.0
* @access private
*
* @param string $response_body
* @return object|false
@@ -566,7 +552,6 @@ class WP_oEmbed {
* Parses an XML response body.
*
* @since 3.0.0
* @access private
*
* @param string $response_body
* @return object|false
@@ -590,7 +575,6 @@ class WP_oEmbed {
* Serves as a helper function for parsing an XML response body.
*
* @since 3.6.0
* @access private
*
* @param string $response_body
* @return stdClass|false
@@ -628,7 +612,6 @@ class WP_oEmbed {
* Converts a data object from WP_oEmbed::fetch() and returns the HTML.
*
* @since 2.9.0
* @access public
*
* @param object $data A data object result from an oEmbed provider.
* @param string $url The URL to the content that is desired to be embedded.
@@ -685,7 +668,6 @@ class WP_oEmbed {
*
* @since 2.9.0 as strip_scribd_newlines()
* @since 3.0.0
* @access public
*
* @param string $html Existing HTML.
* @param object $data Data object from WP_oEmbed::data2html()