Improve various @param docs for src/wp-admin/includes/class-wp-filesystem-*.php.

See #30224.

Built from https://develop.svn.wordpress.org/trunk@30678


git-svn-id: http://core.svn.wordpress.org/trunk@30668 1a063a9b-81f0-0310-95a4-ce76da25c4cd

wp-admin/includes/class-wp-filesystem-ftpext.php

@@ -87,6 +87,10 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
 		return true;
 	}
 
+	/**
+	 * @param string $file
+	 * @return bool|string
+	 */
 	public function get_contents( $file ) {
 		$tempfile = wp_tempnam($file);
 		$temp = fopen($tempfile, 'w+');
@@ -108,10 +112,20 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
 		return $contents;
 	}
 
+	/**
+	 * @param string $file
+	 * @return array
+	 */
 	public function get_contents_array($file) {
 		return explode("\n", $this->get_contents($file));
 	}
 
+	/**
+	 * @param string $file
+	 * @param string $contents
+	 * @param bool|string $mode
+	 * @return bool
+	 */
 	public function put_contents($file, $contents, $mode = false ) {
 		$tempfile = wp_tempnam($file);
 		$temp = fopen( $tempfile, 'wb+' );
@@ -143,6 +157,9 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
 		return $ret;
 	}
 
+	/**
+	 * @return string
+	 */
 	public function cwd() {
 		$cwd = @ftp_pwd($this->link);
 		if ( $cwd )
@@ -150,14 +167,29 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
 		return $cwd;
 	}
 
+	/**
+	 * @param string $dir
+	 * @return bool
+	 */
 	public function chdir($dir) {
 		return @ftp_chdir($this->link, $dir);
 	}
 
+	/**
+	 * @param string $file
+	 * @param bool $group
+	 * @param bool $recursive
+	 */
 	public function chgrp($file, $group, $recursive = false ) {
 		return false;
 	}
 
+	/**
+	 * @param string $file
+	 * @param int $mode
+	 * @param bool $recursive
+	 * @return bool
+	 */
 	public function chmod($file, $mode = false, $recursive = false) {
 		if ( ! $mode ) {
 			if ( $this->is_file($file) )
@@ -181,21 +213,39 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
 		return (bool)@ftp_chmod($this->link, $mode, $file);
 	}
 
+	/**
+	 * @param string $file
+	 * @return string
+	 */
 	public function owner($file) {
 		$dir = $this->dirlist($file);
 		return $dir[$file]['owner'];
 	}
-
+	/**
+	 * @param string $file
+	 * @return string
+	 */
 	public function getchmod($file) {
 		$dir = $this->dirlist($file);
 		return $dir[$file]['permsn'];
 	}
-
+	/**
+	 * @param string $file
+	 * @return string
+	 */
 	public function group($file) {
 		$dir = $this->dirlist($file);
 		return $dir[$file]['group'];
 	}
 
+	/**
+	 *
+	 * @param string $source
+	 * @param string $destination
+	 * @param bool   $overwrite
+	 * @param string|bool $mode
+	 * @return bool
+	 */
 	public function copy($source, $destination, $overwrite = false, $mode = false) {
 		if ( ! $overwrite && $this->exists($destination) )
 			return false;
@@ -204,11 +254,21 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
 			return false;
 		return $this->put_contents($destination, $content, $mode);
 	}
-
+	/**
+	 * @param string $source
+	 * @param string $destination
+	 * @param bool $overwrite
+	 * @return bool
+	 */
 	public function move($source, $destination, $overwrite = false) {
 		return ftp_rename($this->link, $source, $destination);
 	}
-
+	/**
+	 * @param string $file
+	 * @param bool $recursive
+	 * @param string $type
+	 * @return bool
+	 */
 	public function delete($file, $recursive = false, $type = false) {
 		if ( empty($file) )
 			return false;
@@ -223,16 +283,25 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
 				$this->delete( trailingslashit($file) . $delete_file['name'], $recursive, $delete_file['type'] );
 		return @ftp_rmdir($this->link, $file);
 	}
-
+	/**
+	 * @param string $file
+	 * @return bool
+	 */
 	public function exists($file) {
 		$list = @ftp_nlist($this->link, $file);
 		return !empty($list); //empty list = no file, so invert.
 	}
-
+	/**
+	 * @param string $file
+	 * @return bool
+	 */
 	public function is_file($file) {
 		return $this->exists($file) && !$this->is_dir($file);
 	}
-
+	/**
+	 * @param string $path
+	 * @return bool
+	 */
 	public function is_dir($path) {
 		$cwd = $this->cwd();
 		$result = @ftp_chdir($this->link, trailingslashit($path) );
@@ -243,30 +312,56 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
 		return false;
 	}
 
+	/**
+	 * @param string $file
+	 * @return bool
+	 */
 	public function is_readable($file) {
 		return true;
 	}
-
+	/**
+	 * @param string $file
+	 * @return bool
+	 */
 	public function is_writable($file) {
 		return true;
 	}
-
+	/**
+	 * @param string $file
+	 * @return bool
+	 */
 	public function atime($file) {
 		return false;
 	}
-
+	/**
+	 * @param string $file
+	 * @return int
+	 */
 	public function mtime($file) {
 		return ftp_mdtm($this->link, $file);
 	}
-
+	/**
+	 * @param string $file
+	 * @return int
+	 */
 	public function size($file) {
 		return ftp_size($this->link, $file);
 	}
-
+	/**
+	 * @param string $file
+	 * @return bool
+	 */
 	public function touch($file, $time = 0, $atime = 0) {
 		return false;
 	}
 
+	/**
+	 * @param string $path
+	 * @param mixed $chmod
+	 * @param mixed $chown
+	 * @param mixed $chgrp
+	 * @return bool
+	 */
 	public function mkdir($path, $chmod = false, $chown = false, $chgrp = false) {
 		$path = untrailingslashit($path);
 		if ( empty($path) )
@@ -282,10 +377,20 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
 		return true;
 	}
 
+	/**
+	 * @param string $path
+	 * @param bool $recursive
+	 * @return bool
+	 */
 	public function rmdir($path, $recursive = false) {
 		return $this->delete($path, $recursive);
 	}
 
+	/**
+	 * @staticvar bool $is_windows
+	 * @param string $line
+	 * @return string
+	 */
 	public function parselisting($line) {
 		static $is_windows;
 		if ( is_null($is_windows) )
@@ -359,6 +464,12 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
 		return $b;
 	}
 
+	/**
+	 * @param string $path
+	 * @param bool $include_hidden
+	 * @param bool $recursive
+	 * @return bool|array
+	 */
 	public function dirlist($path = '.', $include_hidden = true, $recursive = false) {
 		if ( $this->is_file($path) ) {
 			$limit_file = basename($path);