WordPress.org
Get WordPress

Make WordPress Core


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

Docs: Remove @access notations from method DocBlocks in wp-admin/* 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-admin/includes/class-wp-filesystem-direct.php

    r40988 r41161  
    1919     * constructor
    2020     *
    21      * @access public
    2221     *
    2322     * @param mixed $arg ignored argument
    … …  
    3130     * Reads entire file into a string
    3231     *
    33      * @access public
    3432     *
    3533     * @param string $file Name of the file to read.
    … …  
    4341     * Reads entire file into an array
    4442     *
    45      * @access public
    4643     *
    4744     * @param string $file Path to the file.
    … …  
    5552     * Write a string to a file
    5653     *
    57      * @access public
    5854     *
    5955     * @param string $file     Remote path to the file where to write the data.
    … …  
    8985     * Gets the current working directory
    9086     *
    91      * @access public
    9287     *
    9388     * @return string|bool the current working directory on success, or false on failure.
    … …  
    10095     * Change directory
    10196     *
    102      * @access public
    10397     *
    10498     * @param string $dir The new current directory.
    … …  
    112106     * Changes file group
    113107     *
    114      * @access public
    115108     *
    116109     * @param string $file      Path to the file.
    … …  
    138131     * Changes filesystem permissions
    139132     *
    140      * @access public
    141133     *
    142134     * @param string $file      Path to the file.
    … …  
    170162     * Changes file owner
    171163     *
    172      * @access public
    173164     *
    174165     * @param string $file      Path to the file.
    … …  
    196187     * Gets file owner
    197188     *
    198      * @access public
    199189     *
    200190     * @param string $file Path to the file.
    … …  
    216206     * FIXME does not handle errors in fileperms()
    217207     *
    218      * @access public
    219208     *
    220209     * @param string $file Path to the file.
    … …  
    226215
    227216    /**
    228      * @access public
    229217     *
    230218     * @param string $file
    … …  
    242230
    243231    /**
    244      * @access public
    245232     *
    246233     * @param string $source
    … …  
    261248
    262249    /**
    263      * @access public
    264250     *
    265251     * @param string $source
    … …  
    285271
    286272    /**
    287      * @access public
    288273     *
    289274     * @param string $file
    … …  
    320305    }
    321306    /**
    322      * @access public
    323307     *
    324308     * @param string $file
    … …  
    329313    }
    330314    /**
    331      * @access public
    332315     *
    333316     * @param string $file
    … …  
    338321    }
    339322    /**
    340      * @access public
    341323     *
    342324     * @param string $path
    … …  
    348330
    349331    /**
    350      * @access public
    351332     *
    352333     * @param string $file
    … …  
    358339
    359340    /**
    360      * @access public
    361341     *
    362342     * @param string $file
    … …  
    368348
    369349    /**
    370      * @access public
    371350     *
    372351     * @param string $file
    … …  
    378357
    379358    /**
    380      * @access public
    381359     *
    382360     * @param string $file
    … …  
    388366
    389367    /**
    390      * @access public
    391368     *
    392369     * @param string $file
    … …  
    398375
    399376    /**
    400      * @access public
    401377     *
    402378     * @param string $file
    … …  
    414390
    415391    /**
    416      * @access public
    417392     *
    418393     * @param string $path
    … …  
    442417
    443418    /**
    444      * @access public
    445419     *
    446420     * @param string $path
    … …  
    453427
    454428    /**
    455      * @access public
    456429     *
    457430     * @param string $path
Note: See TracChangeset for help on using the changeset viewer.