Make WordPress Core


Ignore:
Timestamp:
07/27/2017 12:40:27 AM (8 years ago)
Author:
DrewAPicture
Message:

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.

File:
1 edited

Legend:

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

    r40989 r41162  
    292292     *
    293293     * @since 2.0.0
    294      * @access private
    295294     * @var array
    296295     */
     
    301300     *
    302301     * @since 2.5.0
    303      * @access public
    304302     * @var int
    305303     */
     
    310308     *
    311309     * @since 2.0.0
    312      * @access public
    313310     * @var int
    314311     */
     
    319316     *
    320317     * @since 3.0.0
    321      * @access protected
    322318     * @var array
    323319     */
     
    328324     *
    329325     * @since 3.5.0
    330      * @access private
    331326     * @var int
    332327     */
     
    337332     *
    338333     * @since 3.5.0
    339      * @access private
    340334     * @var bool
    341335     */
     
    346340     *
    347341     * @since 4.0.0
    348      * @access public
    349342     *
    350343     * @param string $name Property to get.
     
    359352     *
    360353     * @since 4.0.0
    361      * @access public
    362354     *
    363355     * @param string $name  Property to set.
     
    373365     *
    374366     * @since 4.0.0
    375      * @access public
    376367     *
    377368     * @param string $name Property to check if set.
     
    386377     *
    387378     * @since 4.0.0
    388      * @access public
    389379     *
    390380     * @param string $name Property to unset.
     
    398388     *
    399389     * @since 2.0.0
    400      * @access public
    401390     *
    402391     * @uses WP_Object_Cache::_exists() Checks to see if the cache already has data.
     
    431420     *
    432421     * @since 3.0.0
    433      * @access public
    434422     *
    435423     * @param array $groups List of groups that are global.
     
    446434     *
    447435     * @since 3.3.0
    448      * @access public
    449436     *
    450437     * @param int|string $key    The cache key to decrement.
     
    482469     *
    483470     * @since 2.0.0
    484      * @access public
    485471     *
    486472     * @param int|string $key        What the contents in the cache are called.
     
    507493     *
    508494     * @since 2.0.0
    509      * @access public
    510495     *
    511496     * @return true Always returns true.
     
    527512     *
    528513     * @since 2.0.0
    529      * @access public
    530514     *
    531515     * @param int|string $key    What the contents in the cache are called.
     
    562546     *
    563547     * @since 3.3.0
    564      * @access public
    565548     *
    566549     * @param int|string $key    The cache key to increment
     
    596579     *
    597580     * @since 2.0.0
    598      * @access public
    599581     *
    600582     * @see WP_Object_Cache::set()
     
    624606     *
    625607     * @since 3.0.0
    626      * @access public
    627608     *
    628609     * @deprecated 3.5.0 Use switch_to_blog()
     
    652633     *
    653634     * @since 2.0.0
    654      * @access public
    655635     *
    656636     * @param int|string $key    What to call the contents in the cache.
     
    681661     *
    682662     * @since 2.0.0
    683      * @access public
    684663     */
    685664    public function stats() {
     
    701680     *
    702681     * @since 3.5.0
    703      * @access public
    704682     *
    705683     * @param int $blog_id Blog ID.
     
    714692     *
    715693     * @since 3.4.0
    716      * @access protected
    717694     *
    718695     * @param int|string $key   Cache key to check for existence.
Note: See TracChangeset for help on using the changeset viewer.