From 6c97b7b19d71fa90c66f34a575a5fcb3ee602004 Mon Sep 17 00:00:00 2001 From: mr.baileys Date: Tue, 31 May 2011 06:54:46 +0200 Subject: [PATCH] Issue 623276: Fixed documentation for file_scan_directory. --- includes/file.inc | 14 ++++++++------ 1 files changed, 8 insertions(+), 6 deletions(-) diff --git a/includes/file.inc b/includes/file.inc index f9c38b2..e3c655b 100644 --- a/includes/file.inc +++ b/includes/file.inc @@ -918,6 +918,7 @@ function file_download() { /** * Finds all files that match a given mask in a given directory. + * * Directories and files beginning with a period are excluded; this * prevents hidden files and directories (such as SVN working directories) * from being scanned. @@ -934,18 +935,19 @@ function file_download() { * When TRUE, the directory scan will recurse the entire tree * starting at the provided directory. * @param $key - * The key to be used for the returned array of files. Possible - * values are "filename", for the path starting with $dir, - * "basename", for the basename of the file, and "name" for the name - * of the file without an extension. + * The key to be used for the returned associative array of files. Possible + * values are "filename", for the path starting with $dir; "basename", for + * the basename of the file; and "name" for the name of the file without the + * extension. * @param $min_depth * Minimum depth of directories to return files from. * @param $depth - * Current depth of recursion. This parameter is only used internally and should not be passed. + * Current depth of recursion. This parameter is only used internally and + * should not be passed in. * * @return * An associative array (keyed on the provided key) of objects with - * "path", "basename", and "name" members corresponding to the + * "filename", "basename", and "name" members corresponding to the * matching files. */ function file_scan_directory($dir, $mask, $nomask = array('.', '..', 'CVS'), $callback = 0, $recurse = TRUE, $key = 'filename', $min_depth = 0, $depth = 0) { -- 1.7.1