Changeset 41688 for trunk/src/wp-includes/cache.php

Timestamp:

10/02/2017 10:13:04 PM (6 years ago)

Author:

johnbillion

Message:

Docs: Standardise the format used for documenting parameters passed by reference.

See #35974, #41017

File:

• trunk/src/wp-includes/cache.php (modified) (2 diffs)

trunk/src/wp-includes/cache.php

@@ -113 +113 @@
  * @param bool        $force  Optional. Whether to force an update of the local cache from the persistent
  *                            cache. Default false.
- * @param bool        $found  Optional. Whether the key was found in the cache. Disambiguates a return of false,
- *                            a storable value. Passed by reference. Default null.
+ * @param bool        $found  Optional. Whether the key was found in the cache (passed by reference).
+ *                            Disambiguates a return of false, a storable value. Default null.
  * @return bool|mixed False on failure to retrieve contents or the cache
  *                    contents on success
@@ -517 +517 @@
      * @param string     $force  Optional. Unused. Whether to force a refetch rather than relying on the local
      *                           cache. Default false.
-     * @param bool       $found  Optional. Whether the key was found in the cache. Disambiguates a return of
-     *                           false, a storable value. Passed by reference. Default null.
+     * @param bool        $found  Optional. Whether the key was found in the cache (passed by reference).
+     *                            Disambiguates a return of false, a storable value. Default null.
      * @return false|mixed False on failure to retrieve contents or the cache contents on success.
      */