Document explicitly that dotfiles and vcs files are ignored by default

This change makes it clear whether or not each of those two options are enabled by default.

Without this documentation one has to look into the code.
This commit is contained in:
Matthieu Napoli 2018-02-10 18:16:30 +01:00 committed by Nicolas Grekas
parent b22f1df8f4
commit e88e1ff494
1 changed files with 4 additions and 0 deletions

View File

@ -402,6 +402,8 @@ class Finder implements \IteratorAggregate, \Countable
/**
* Excludes "hidden" directories and files (starting with a dot).
*
* This option is enabled by default.
*
* @param bool $ignoreDotFiles Whether to exclude "hidden" files or not
*
* @return $this
@ -422,6 +424,8 @@ class Finder implements \IteratorAggregate, \Countable
/**
* Forces the finder to ignore version control directories.
*
* This option is enabled by default.
*
* @param bool $ignoreVCS Whether to exclude VCS files or not
*
* @return $this