mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-04-01 19:24:34 +00:00
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:
@@ -291,7 +291,6 @@ class WP_Object_Cache {
|
||||
* Holds the cached objects.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access private
|
||||
* @var array
|
||||
*/
|
||||
private $cache = array();
|
||||
@@ -300,7 +299,6 @@ class WP_Object_Cache {
|
||||
* The amount of times the cache data was already stored in the cache.
|
||||
*
|
||||
* @since 2.5.0
|
||||
* @access public
|
||||
* @var int
|
||||
*/
|
||||
public $cache_hits = 0;
|
||||
@@ -309,7 +307,6 @@ class WP_Object_Cache {
|
||||
* Amount of times the cache did not have the request in cache.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
* @var int
|
||||
*/
|
||||
public $cache_misses = 0;
|
||||
@@ -318,7 +315,6 @@ class WP_Object_Cache {
|
||||
* List of global cache groups.
|
||||
*
|
||||
* @since 3.0.0
|
||||
* @access protected
|
||||
* @var array
|
||||
*/
|
||||
protected $global_groups = array();
|
||||
@@ -327,7 +323,6 @@ class WP_Object_Cache {
|
||||
* The blog prefix to prepend to keys in non-global groups.
|
||||
*
|
||||
* @since 3.5.0
|
||||
* @access private
|
||||
* @var int
|
||||
*/
|
||||
private $blog_prefix;
|
||||
@@ -336,7 +331,6 @@ class WP_Object_Cache {
|
||||
* Holds the value of is_multisite().
|
||||
*
|
||||
* @since 3.5.0
|
||||
* @access private
|
||||
* @var bool
|
||||
*/
|
||||
private $multisite;
|
||||
@@ -345,7 +339,6 @@ class WP_Object_Cache {
|
||||
* Makes private properties readable for backward compatibility.
|
||||
*
|
||||
* @since 4.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $name Property to get.
|
||||
* @return mixed Property.
|
||||
@@ -358,7 +351,6 @@ class WP_Object_Cache {
|
||||
* Makes private properties settable for backward compatibility.
|
||||
*
|
||||
* @since 4.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $name Property to set.
|
||||
* @param mixed $value Property value.
|
||||
@@ -372,7 +364,6 @@ class WP_Object_Cache {
|
||||
* Makes private properties checkable for backward compatibility.
|
||||
*
|
||||
* @since 4.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $name Property to check if set.
|
||||
* @return bool Whether the property is set.
|
||||
@@ -385,7 +376,6 @@ class WP_Object_Cache {
|
||||
* Makes private properties un-settable for backward compatibility.
|
||||
*
|
||||
* @since 4.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $name Property to unset.
|
||||
*/
|
||||
@@ -397,7 +387,6 @@ class WP_Object_Cache {
|
||||
* Adds data to the cache if it doesn't already exist.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @uses WP_Object_Cache::_exists() Checks to see if the cache already has data.
|
||||
* @uses WP_Object_Cache::set() Sets the data after the checking the cache
|
||||
@@ -430,7 +419,6 @@ class WP_Object_Cache {
|
||||
* Sets the list of global cache groups.
|
||||
*
|
||||
* @since 3.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param array $groups List of groups that are global.
|
||||
*/
|
||||
@@ -445,7 +433,6 @@ class WP_Object_Cache {
|
||||
* Decrements numeric cache item's value.
|
||||
*
|
||||
* @since 3.3.0
|
||||
* @access public
|
||||
*
|
||||
* @param int|string $key The cache key to decrement.
|
||||
* @param int $offset Optional. The amount by which to decrement the item's value. Default 1.
|
||||
@@ -481,7 +468,6 @@ class WP_Object_Cache {
|
||||
* If the cache key does not exist in the group, then nothing will happen.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param int|string $key What the contents in the cache are called.
|
||||
* @param string $group Optional. Where the cache contents are grouped. Default 'default'.
|
||||
@@ -506,7 +492,6 @@ class WP_Object_Cache {
|
||||
* Clears the object cache of all data.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @return true Always returns true.
|
||||
*/
|
||||
@@ -526,7 +511,6 @@ class WP_Object_Cache {
|
||||
* On failure, the number of cache misses will be incremented.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param int|string $key What the contents in the cache are called.
|
||||
* @param string $group Optional. Where the cache contents are grouped. Default 'default'.
|
||||
@@ -561,7 +545,6 @@ class WP_Object_Cache {
|
||||
* Increments numeric cache item's value.
|
||||
*
|
||||
* @since 3.3.0
|
||||
* @access public
|
||||
*
|
||||
* @param int|string $key The cache key to increment
|
||||
* @param int $offset Optional. The amount by which to increment the item's value. Default 1.
|
||||
@@ -595,7 +578,6 @@ class WP_Object_Cache {
|
||||
* Replaces the contents in the cache, if contents already exist.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @see WP_Object_Cache::set()
|
||||
*
|
||||
@@ -623,7 +605,6 @@ class WP_Object_Cache {
|
||||
* Resets cache keys.
|
||||
*
|
||||
* @since 3.0.0
|
||||
* @access public
|
||||
*
|
||||
* @deprecated 3.5.0 Use switch_to_blog()
|
||||
* @see switch_to_blog()
|
||||
@@ -651,7 +632,6 @@ class WP_Object_Cache {
|
||||
* more for cache plugins which use files.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*
|
||||
* @param int|string $key What to call the contents in the cache.
|
||||
* @param mixed $data The contents to store in the cache.
|
||||
@@ -680,7 +660,6 @@ class WP_Object_Cache {
|
||||
* key and the data.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
*/
|
||||
public function stats() {
|
||||
echo "<p>";
|
||||
@@ -700,7 +679,6 @@ class WP_Object_Cache {
|
||||
* This changes the blog ID used to create keys in blog specific groups.
|
||||
*
|
||||
* @since 3.5.0
|
||||
* @access public
|
||||
*
|
||||
* @param int $blog_id Blog ID.
|
||||
*/
|
||||
@@ -713,7 +691,6 @@ class WP_Object_Cache {
|
||||
* Serves as a utility function to determine whether a key exists in the cache.
|
||||
*
|
||||
* @since 3.4.0
|
||||
* @access protected
|
||||
*
|
||||
* @param int|string $key Cache key to check for existence.
|
||||
* @param string $group Cache group for the key existence check.
|
||||
|
||||
Reference in New Issue
Block a user