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.

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


git-svn-id: http://core.svn.wordpress.org/trunk@41002 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
2017-07-27 00:41:44 +00:00
parent 1a28ec87e1
commit 0860bb2771
136 changed files with 3 additions and 1907 deletions

View File

@@ -24,7 +24,6 @@ class wp_xmlrpc_server extends IXR_Server {
/**
* Methods.
*
* @access public
* @var array
*/
public $methods;
@@ -32,7 +31,6 @@ class wp_xmlrpc_server extends IXR_Server {
/**
* Blog options.
*
* @access public
* @var array
*/
public $blog_options;
@@ -40,7 +38,6 @@ class wp_xmlrpc_server extends IXR_Server {
/**
* IXR_Error instance.
*
* @access public
* @var IXR_Error
*/
public $error;
@@ -48,7 +45,6 @@ class wp_xmlrpc_server extends IXR_Server {
/**
* Flags that the user authentication has failed in this instance of wp_xmlrpc_server.
*
* @access protected
* @var bool
*/
protected $auth_failed = false;
@@ -174,7 +170,6 @@ class wp_xmlrpc_server extends IXR_Server {
* Make private/protected methods readable for backward compatibility.
*
* @since 4.0.0
* @access public
*
* @param callable $name Method to call.
* @param array $arguments Arguments to pass when calling.
@@ -191,7 +186,6 @@ class wp_xmlrpc_server extends IXR_Server {
* Serves the XML-RPC request.
*
* @since 2.9.0
* @access public
*/
public function serve_request() {
$this->IXR_Server($this->methods);
@@ -724,7 +718,6 @@ class wp_xmlrpc_server extends IXR_Server {
* Checks if the method received at least the minimum number of arguments.
*
* @since 3.4.0
* @access protected
*
* @param string|array $args Sanitize single string or array of strings.
* @param int $count Minimum number of arguments.
@@ -742,7 +735,6 @@ class wp_xmlrpc_server extends IXR_Server {
/**
* Prepares taxonomy data for return in an XML-RPC object.
*
* @access protected
*
* @param object $taxonomy The unprepared taxonomy data.
* @param array $fields The subset of taxonomy fields to return.
@@ -785,7 +777,6 @@ class wp_xmlrpc_server extends IXR_Server {
/**
* Prepares term data for return in an XML-RPC object.
*
* @access protected
*
* @param array|object $term The unprepared term data.
* @return array The prepared term data.
@@ -821,7 +812,6 @@ class wp_xmlrpc_server extends IXR_Server {
/**
* Convert a WordPress date string to an IXR_Date object.
*
* @access protected
*
* @param string $date Date string to convert.
* @return IXR_Date IXR_Date object.
@@ -836,7 +826,6 @@ class wp_xmlrpc_server extends IXR_Server {
/**
* Convert a WordPress GMT date string to an IXR_Date object.
*
* @access protected
*
* @param string $date_gmt WordPress GMT date string.
* @param string $date Date string.
@@ -852,7 +841,6 @@ class wp_xmlrpc_server extends IXR_Server {
/**
* Prepares post data for return in an XML-RPC object.
*
* @access protected
*
* @param array $post The unprepared post data.
* @param array $fields The subset of post type fields to return.
@@ -953,7 +941,6 @@ class wp_xmlrpc_server extends IXR_Server {
*
* @since 3.4.0
* @since 4.6.0 Converted the `$post_type` parameter to accept a WP_Post_Type object.
* @access protected
*
* @param WP_Post_Type $post_type Post type object.
* @param array $fields The subset of post fields to return.
@@ -1004,7 +991,6 @@ class wp_xmlrpc_server extends IXR_Server {
/**
* Prepares media item data for return in an XML-RPC object.
*
* @access protected
*
* @param object $media_item The unprepared media item data.
* @param string $thumbnail_size The image size to use for the thumbnail URL.
@@ -1044,7 +1030,6 @@ class wp_xmlrpc_server extends IXR_Server {
/**
* Prepares page data for return in an XML-RPC object.
*
* @access protected
*
* @param object $page The unprepared page data.
* @return array The prepared page data.
@@ -1125,7 +1110,6 @@ class wp_xmlrpc_server extends IXR_Server {
/**
* Prepares comment data for return in an XML-RPC object.
*
* @access protected
*
* @param object $comment The unprepared comment data.
* @return array The prepared comment data.
@@ -1174,7 +1158,6 @@ class wp_xmlrpc_server extends IXR_Server {
/**
* Prepares user data for return in an XML-RPC object.
*
* @access protected
*
* @param WP_User $user The unprepared user object.
* @param array $fields The subset of user fields to return.
@@ -1319,7 +1302,6 @@ class wp_xmlrpc_server extends IXR_Server {
* and determining if the user has permission to do so
*
* @since 4.3.0
* @access private
*
* @param array $post_data
* @param bool $update
@@ -1356,7 +1338,6 @@ class wp_xmlrpc_server extends IXR_Server {
* Helper method for wp_newPost() and wp_editPost(), containing shared logic.
*
* @since 3.4.0
* @access protected
*
* @see wp_insert_post()
*
@@ -4469,7 +4450,6 @@ class wp_xmlrpc_server extends IXR_Server {
* Private function for retrieving a users blogs for multisite setups
*
* @since 3.0.0
* @access protected
*
* @param array $args {
* Method arguments. Note: arguments must be ordered as documented.