From ebd320126878b39061c67733223b7310e0fc14fd Mon Sep 17 00:00:00 2001
From: Scott Taylor <scott.c.taylor@mac.com>
Date: Fri, 22 May 2015 04:24:26 +0000
Subject: [PATCH] Add/standardize missing doc blocks for `cache.php`.

See #32444.

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


git-svn-id: http://core.svn.wordpress.org/trunk@32509 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-includes/cache.php   | 47 +++++++++++++++++++++++------------------
 wp-includes/version.php |  2 +-
 2 files changed, 28 insertions(+), 21 deletions(-)

diff --git a/wp-includes/cache.php b/wp-includes/cache.php
index 66c9991e04..d89ac7416c 100644
--- a/wp-includes/cache.php
+++ b/wp-includes/cache.php
@@ -12,8 +12,8 @@
  * Adds data to the cache, if the cache key doesn't already exist.
  *
  * @since 2.0.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::add()
+ *
+ * @global WP_Object_Cache $wp_object_cache
  *
  * @param int|string $key The cache key to use for retrieval later
  * @param mixed $data The data to add to the cache store
@@ -47,8 +47,8 @@ function wp_cache_close() {
  * Decrement numeric cache item's value
  *
  * @since 3.3.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::decr()
+ *
+ * @global WP_Object_Cache $wp_object_cache
  *
  * @param int|string $key The cache key to increment
  * @param int $offset The amount by which to decrement the item's value. Default is 1.
@@ -65,8 +65,8 @@ function wp_cache_decr( $key, $offset = 1, $group = '' ) {
  * Removes the cache contents matching key and group.
  *
  * @since 2.0.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::delete()
+ *
+ * @global WP_Object_Cache $wp_object_cache
  *
  * @param int|string $key What the contents in the cache are called
  * @param string $group Where the cache contents are grouped
@@ -82,8 +82,8 @@ function wp_cache_delete($key, $group = '') {
  * Removes all cache items.
  *
  * @since 2.0.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::flush()
+ *
+ * @global WP_Object_Cache $wp_object_cache
  *
  * @return bool False on failure, true on success
  */
@@ -97,8 +97,8 @@ function wp_cache_flush() {
  * Retrieves the cache contents from the cache by key and group.
  *
  * @since 2.0.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::get()
+ *
+ * @global WP_Object_Cache $wp_object_cache
  *
  * @param int|string $key What the contents in the cache are called
  * @param string $group Where the cache contents are grouped
@@ -117,8 +117,8 @@ function wp_cache_get( $key, $group = '', $force = false, &$found = null ) {
  * Increment numeric cache item's value
  *
  * @since 3.3.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::incr()
+ *
+ * @global WP_Object_Cache $wp_object_cache
  *
  * @param int|string $key The cache key to increment
  * @param int $offset The amount by which to increment the item's value. Default is 1.
@@ -135,8 +135,8 @@ function wp_cache_incr( $key, $offset = 1, $group = '' ) {
  * Sets up Object Cache Global and assigns it.
  *
  * @since 2.0.0
- * @global $wp_object_cache WordPress Object Cache instance
- * @uses WP_Object_Cache
+ *
+ * @global WP_Object_Cache $wp_object_cache
  */
 function wp_cache_init() {
 	$GLOBALS['wp_object_cache'] = new WP_Object_Cache();
@@ -146,8 +146,8 @@ function wp_cache_init() {
  * Replaces the contents of the cache with new data.
  *
  * @since 2.0.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::replace()
+ *
+ * @global WP_Object_Cache $wp_object_cache
  *
  * @param int|string $key What to call the contents in the cache
  * @param mixed $data The contents to store in the cache
@@ -166,8 +166,7 @@ function wp_cache_replace( $key, $data, $group = '', $expire = 0 ) {
  *
  * @since 2.0.0
  *
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::set()
+ * @global WP_Object_Cache $wp_object_cache
  *
  * @param int|string $key What to call the contents in the cache
  * @param mixed $data The contents to store in the cache
@@ -188,6 +187,8 @@ function wp_cache_set( $key, $data, $group = '', $expire = 0 ) {
  *
  * @since 3.5.0
  *
+ * @global WP_Object_Cache $wp_object_cache
+ *
  * @param int $blog_id Blog ID
  */
 function wp_cache_switch_to_blog( $blog_id ) {
@@ -201,6 +202,8 @@ function wp_cache_switch_to_blog( $blog_id ) {
  *
  * @since 2.6.0
  *
+ * @global WP_Object_Cache $wp_object_cache
+ *
  * @param string|array $groups A group or an array of groups to add
  */
 function wp_cache_add_global_groups( $groups ) {
@@ -234,6 +237,8 @@ function wp_cache_add_non_persistent_groups( $groups ) {
  *
  * @since 2.6.0
  * @deprecated 3.5.0
+ *
+ * @global WP_Object_Cache $wp_object_cache
  */
 function wp_cache_reset() {
 	_deprecated_function( __FUNCTION__, '3.5' );
@@ -478,10 +483,10 @@ class WP_Object_Cache {
 	 *
 	 * @since 2.0.0
 	 *
-	 * @return bool Always returns true
+	 * @return true Always returns true
 	 */
 	public function flush() {
-		$this->cache = array ();
+		$this->cache = array();
 
 		return true;
 	}
@@ -685,6 +690,8 @@ class WP_Object_Cache {
 	 * Sets up object properties; PHP 5 style constructor
 	 *
 	 * @since 2.0.8
+	 *
+     * @global int $blog_id
 	 */
 	public function __construct() {
 		global $blog_id;
diff --git a/wp-includes/version.php b/wp-includes/version.php
index b6d2372b46..fa11220e39 100644
--- a/wp-includes/version.php
+++ b/wp-includes/version.php
@@ -4,7 +4,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '4.3-alpha-32538';
+$wp_version = '4.3-alpha-32539';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.