diff --git a/inc/search.php b/inc/search.php index be47102371b3cc346100e9cc297aa0494739eb0b..5489dc2c0fad3e3af397fb28102441245eb73521 100644 --- a/inc/search.php +++ b/inc/search.php @@ -317,25 +317,25 @@ function pathID($path,$keeptxt=false){ * How the function behaves, depends on the options passed in the $opts * array, where the following settings can be used. * - * depth int recursion depth. 0 for unlimited - * keeptxt bool keep .txt extension for IDs - * listfiles bool include files in listing - * listdirs bool include namespaces in listing - * pagesonly bool restrict files to pages - * skipacl bool do not check for READ permission - * sneakyacl bool don't recurse into nonreadable dirs - * hash bool create MD5 hash for files - * meta bool return file metadata - * filematch string match files against this regexp - * idmatch string match full ID against this regexp - * dirmatch string match directory against this regexp when adding - * nsmatch string match namespace against this regexp when adding - * recmatch string match directory against this regexp when recursing - * showmsg bool warn about non-ID files - * showhidden bool show hidden files too - * firsthead bool return first heading for pages + * depth int recursion depth. 0 for unlimited (default: 0) + * keeptxt bool keep .txt extension for IDs (default: false) + * listfiles bool include files in listing (default: false) + * listdirs bool include namespaces in listing (default: false) + * pagesonly bool restrict files to pages (default: false) + * skipacl bool do not check for READ permission (default: false) + * sneakyacl bool don't recurse into nonreadable dirs (default: false) + * hash bool create MD5 hash for files (default: false) + * meta bool return file metadata (default: false) + * filematch string match files against this regexp (default: '', so accept everything) + * idmatch string match full ID against this regexp (default: '', so accept everything) + * dirmatch string match directory against this regexp when adding (default: '', so accept everything) + * nsmatch string match namespace against this regexp when adding (default: '', so accept everything) + * recmatch string match directory against this regexp when recursing (default: '', so accept everything) + * showmsg bool warn about non-ID files (default: false) + * showhidden bool show hidden files(e.g. by hidepages config) too (default: false) + * firsthead bool return first heading for pages (default: false) * - * @param array &$data - Reference to the result data structure + * @param array &$data - Reference to the result data structure * @param string $base - Base usually $conf['datadir'] * @param string $file - current file or directory relative to $base * @param string $type - Type either 'd' for directory or 'f' for file