Make WordPress Core


Ignore:
Timestamp:
08/27/2008 06:45:13 AM (16 years ago)
Author:
westi
Message:

phpDoc corrections for wp-includes. See #7550 props santosj.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-includes/cache.php

    r8600 r8742  
    1212 * Adds data to the cache, if the cache key doesn't aleady exist.
    1313 *
    14  * @since 2.0
     14 * @since 2.0.0
    1515 * @uses $wp_object_cache Object Cache Class
    1616 * @see WP_Object_Cache::add()
     
    3636 * make sure that the cache is cleaned up after WordPress no longer needs it.
    3737 *
    38  * @since 2.0
     38 * @since 2.0.0
    3939 *
    4040 * @return bool Always returns True
     
    4747 * Removes the cache contents matching ID and flag.
    4848 *
    49  * @since 2.0
     49 * @since 2.0.0
    5050 * @uses $wp_object_cache Object Cache Class
    5151 * @see WP_Object_Cache::delete()
     
    6464 * Removes all cache items.
    6565 *
    66  * @since 2.0
     66 * @since 2.0.0
    6767 * @uses $wp_object_cache Object Cache Class
    6868 * @see WP_Object_Cache::flush()
     
    7979 * Retrieves the cache contents from the cache by ID and flag.
    8080 *
    81  * @since 2.0
     81 * @since 2.0.0
    8282 * @uses $wp_object_cache Object Cache Class
    8383 * @see WP_Object_Cache::get()
     
    9797 * Sets up Object Cache Global and assigns it.
    9898 *
    99  * @since 2.0
     99 * @since 2.0.0
    100100 * @global WP_Object_Cache $wp_object_cache WordPress Object Cache
    101101 */
     
    107107 * Replaces the contents of the cache with new data.
    108108 *
    109  * @since 2.0
     109 * @since 2.0.0
    110110 * @uses $wp_object_cache Object Cache Class
    111111 * @see WP_Object_Cache::replace()
     
    145145 * Adds a group or set of groups to the list of global groups.
    146146 *
    147  * @since 2.6
     147 * @since 2.6.0
    148148 *
    149149 * @param string|array $groups A group or an array of groups to add
     
    157157 * Adds a group or set of groups to the list of non-persistent groups.
    158158 *
    159  * @since 2.6
     159 * @since 2.6.0
    160160 *
    161161 * @param string|array $groups A group or an array of groups to add
     
    189189     * @var array
    190190     * @access private
    191      * @since 2.0
     191     * @since 2.0.0
    192192     */
    193193    var $cache = array ();
     
    198198     * @var array
    199199     * @access private
    200      * @since 2.0
     200     * @since 2.0.0
    201201     */
    202202    var $non_existant_objects = array ();
     
    205205     * The amount of times the cache data was already stored in the cache.
    206206     *
    207      * @since 2.5
     207     * @since 2.5.0
    208208     * @access private
    209209     * @var int
     
    216216     * @var int
    217217     * @access public
    218      * @since 2.0
     218     * @since 2.0.0
    219219     */
    220220    var $cache_misses = 0;
     
    227227     *      contents existance.
    228228     *
    229      * @since 2.0
     229     * @since 2.0.0
    230230     *
    231231     * @param int|string $id What to call the contents in the cache
     
    255255     * $non_existant_objects property in the class.
    256256     *
    257      * @since 2.0
     257     * @since 2.0.0
    258258     *
    259259     * @param int|string $id What the contents in the cache are called
     
    278278     * Clears the object cache of all data
    279279     *
    280      * @since 2.0
     280     * @since 2.0.0
    281281     *
    282282     * @return bool Always returns true
     
    301301     * the nonexistant objects.
    302302     *
    303      * @since 2.0
     303     * @since 2.0.0
    304304     *
    305305     * @param int|string $id What the contents in the cache are called
     
    328328     * Replace the contents in the cache, if contents already exist
    329329     *
    330      * @since 2.0
     330     * @since 2.0.0
    331331     * @see WP_Object_Cache::set()
    332332     *
     
    359359     * more for cache plugins which use files.
    360360     *
    361      * @since 2.0
     361     * @since 2.0.0
    362362     *
    363363     * @param int|string $id What to call the contents in the cache
     
    388388     * key and the data.
    389389     *
    390      * @since 2.0
     390     * @since 2.0.0
    391391     */
    392392    function stats() {
     
    409409     * PHP4 constructor; Calls PHP 5 style constructor
    410410     *
    411      * @since 2.0
     411     * @since 2.0.0
    412412     *
    413413     * @return WP_Object_Cache
Note: See TracChangeset for help on using the changeset viewer.