summaryrefslogtreecommitdiff
path: root/includes/filetransfer
diff options
context:
space:
mode:
authorAngie Byron <webchick@24967.no-reply.drupal.org>2009-10-12 20:11:04 +0000
committerAngie Byron <webchick@24967.no-reply.drupal.org>2009-10-12 20:11:04 +0000
commit2eb7c94ed559c5ccd1fdae1d6a282f64c2cd79fe (patch)
tree973c9cee4ea0a37fee9ccbdadc4bc1a6349c3b8d /includes/filetransfer
parentc5fe1d16f712fbff6d5ca6882d371a523af5a6d2 (diff)
downloadbrdo-2eb7c94ed559c5ccd1fdae1d6a282f64c2cd79fe.tar.gz
brdo-2eb7c94ed559c5ccd1fdae1d6a282f64c2cd79fe.tar.bz2
#602518 by dww and JacobSingh: Fixed PHPDoc for includes/filetransfer/filetransfer.inc.
Diffstat (limited to 'includes/filetransfer')
-rw-r--r--includes/filetransfer/filetransfer.inc9
1 files changed, 6 insertions, 3 deletions
diff --git a/includes/filetransfer/filetransfer.inc b/includes/filetransfer/filetransfer.inc
index f0cf9d56a..921b9fa53 100644
--- a/includes/filetransfer/filetransfer.inc
+++ b/includes/filetransfer/filetransfer.inc
@@ -263,10 +263,13 @@ abstract class FileTransfer {
abstract public function isFile($path);
/**
- * Gets the chroot property for this connection. It does this by moving up
- * the tree until it finds itself. If successful, it will return a chroot.
+ * Return the chroot property for this connection.
*
- * @return string chroot
+ * It does this by moving up the tree until it finds itself. If successful,
+ * it will return the chroot, otherwise FALSE.
+ *
+ * @return
+ * The chroot path for this connection or FALSE.
*/
function findChroot() {
// If the file exists as is, there is no chroot.