Make WordPress Core


Ignore:
Timestamp:
09/07/2010 11:21:11 AM (15 years ago)
Author:
nacin
Message:

Phpdoc argument/@param cleanups. props duck_, see #14783.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-admin/includes/class-wp-filesystem-direct.php

    r13025 r15590  
    2020     * constructor
    2121     *
    22      * @param $arg mixed ingored argument
     22     * @param mixed $arg ingored argument
    2323     */
    2424    function WP_Filesystem_Direct($arg) {
     
    3737     * Reads entire file into a string
    3838     *
    39      * @param $file string Name of the file to read.
     39     * @param string $file Name of the file to read.
    4040     * @return string|bool The function returns the read data or false on failure.
    4141     */
     
    4646     * Reads entire file into an array
    4747     *
    48      * @param $file string Path to the file.
     48     * @param string $file Path to the file.
    4949     * @return array|bool the file contents in an array or false on failure.
    5050     */
     
    5555     * Write a string to a file
    5656     *
    57      * @param $file string Remote path to the file where to write the data.
    58      * @param $contents string The data to write.
    59      * @param $mode int (optional) The file permissions as octal number, usually 0644.
     57     * @param string $file Remote path to the file where to write the data.
     58     * @param string $contents The data to write.
     59     * @param int $mode (optional) The file permissions as octal number, usually 0644.
    6060     * @return bool False upon failure.
    6161     */
     
    7979     * Change directory
    8080     *
    81      * @param $dir string The new current directory.
     81     * @param string $dir The new current directory.
    8282     * @return bool Returns true on success or false on failure.
    8383     */
     
    8888     * Changes file group
    8989     *
    90      * @param $file string Path to the file.
    91      * @param $group mixed A group name or number.
    92      * @param $recursive bool (optional) If set True changes file group recursivly. Defaults to False.
     90     * @param string $file Path to the file.
     91     * @param mixed $group A group name or number.
     92     * @param bool $recursive (optional) If set True changes file group recursivly. Defaults to False.
    9393     * @return bool Returns true on success or false on failure.
    9494     */
     
    111111     * Changes filesystem permissions
    112112     *
    113      * @param $file string Path to the file.
    114      * @param $mode int (optional) The permissions as octal number, usually 0644 for files, 0755 for dirs.
    115      * @param $recursive bool (optional) If set True changes file group recursivly. Defaults to False.
     113     * @param string $file Path to the file.
     114     * @param int $mode (optional) The permissions as octal number, usually 0644 for files, 0755 for dirs.
     115     * @param bool $recursive (optional) If set True changes file group recursivly. Defaults to False.
    116116     * @return bool Returns true on success or false on failure.
    117117     */
     
    139139     * Changes file owner
    140140     *
    141      * @param $file string Path to the file.
    142      * @param $owner mixed A user name or number.
    143      * @param $recursive bool (optional) If set True changes file owner recursivly. Defaults to False.
     141     * @param string $file Path to the file.
     142     * @param mixed $owner A user name or number.
     143     * @param bool $recursive (optional) If set True changes file owner recursivly. Defaults to False.
    144144     * @return bool Returns true on success or false on failure.
    145145     */
     
    161161     * Gets file owner
    162162     *
    163      * @param $file string Path to the file.
     163     * @param string $file Path to the file.
    164164     * @return string Username of the user.
    165165     */
     
    178178     * FIXME does not handle errors in fileperms()
    179179     *
    180      * @param $file string Path to the file.
     180     * @param string $file Path to the file.
    181181     * @return string Mode of the file (last 4 digits).
    182182     */
Note: See TracChangeset for help on using the changeset viewer.