Fixes various phpdoc and coding standards.

Hugo Hamon · Hugo Hamon · commit 37b7288b705e · 2015-01-02T09:58:20.000+01:00
diff --git a/Adapter/AbstractAdapter.php b/Adapter/AbstractAdapter.php
@@ -228,7 +228,7 @@ public function ignoreUnreadableDirs($ignore = true)
      * isSupported in the adapters as the generic implementation provides a cache
      * layer.
      *
-     * @see isSupported
+     * @see isSupported()
      *
      * @return bool Whether the adapter is supported
      */
diff --git a/Comparator/NumberComparator.php b/Comparator/NumberComparator.php
@@ -30,7 +30,7 @@
  * @copyright 2004-2005 Fabien Potencier <fabien@symfony.com>
  * @copyright 2002 Richard Clamp <richardc@unixbeard.net>
  *
- * @see       http://physics.nist.gov/cuu/Units/binary.html
+ * @see http://physics.nist.gov/cuu/Units/binary.html
  */
 class NumberComparator extends Comparator
 {
diff --git a/Finder.php b/Finder.php
@@ -15,7 +15,17 @@
 use Symfony\Component\Finder\Adapter\GnuFindAdapter;
 use Symfony\Component\Finder\Adapter\BsdFindAdapter;
 use Symfony\Component\Finder\Adapter\PhpAdapter;
+use Symfony\Component\Finder\Comparator\DateComparator;
+use Symfony\Component\Finder\Comparator\NumberComparator;
 use Symfony\Component\Finder\Exception\ExceptionInterface;
+use Symfony\Component\Finder\Iterator\CustomFilterIterator;
+use Symfony\Component\Finder\Iterator\DateRangeFilterIterator;
+use Symfony\Component\Finder\Iterator\DepthRangeFilterIterator;
+use Symfony\Component\Finder\Iterator\ExcludeDirectoryFilterIterator;
+use Symfony\Component\Finder\Iterator\FilecontentFilterIterator;
+use Symfony\Component\Finder\Iterator\FilenameFilterIterator;
+use Symfony\Component\Finder\Iterator\SizeRangeFilterIterator;
+use Symfony\Component\Finder\Iterator\SortableIterator;
 
 /**
  * Finder allows to build rules to find files and directories.
@@ -202,8 +212,8 @@ public function files()
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\DepthRangeFilterIterator
-     * @see Symfony\Component\Finder\Comparator\NumberComparator
+     * @see DepthRangeFilterIterator
+     * @see NumberComparator
      *
      * @api
      */
@@ -229,8 +239,8 @@ public function depth($level)
      * @return Finder The current Finder instance
      *
      * @see strtotime
-     * @see Symfony\Component\Finder\Iterator\DateRangeFilterIterator
-     * @see Symfony\Component\Finder\Comparator\DateComparator
+     * @see DateRangeFilterIterator
+     * @see DateComparator
      *
      * @api
      */
@@ -254,7 +264,7 @@ public function date($date)
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\FilenameFilterIterator
+     * @see FilenameFilterIterator
      *
      * @api
      */
@@ -272,7 +282,7 @@ public function name($pattern)
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\FilenameFilterIterator
+     * @see FilenameFilterIterator
      *
      * @api
      */
@@ -295,7 +305,7 @@ public function notName($pattern)
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\FilecontentFilterIterator
+     * @see FilecontentFilterIterator
      */
     public function contains($pattern)
     {
@@ -316,7 +326,7 @@ public function contains($pattern)
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\FilecontentFilterIterator
+     * @see FilecontentFilterIterator
      */
     public function notContains($pattern)
     {
@@ -339,7 +349,7 @@ public function notContains($pattern)
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\FilenameFilterIterator
+     * @see FilenameFilterIterator
      */
     public function path($pattern)
     {
@@ -362,7 +372,7 @@ public function path($pattern)
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\FilenameFilterIterator
+     * @see FilenameFilterIterator
      */
     public function notPath($pattern)
     {
@@ -382,8 +392,8 @@ public function notPath($pattern)
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\SizeRangeFilterIterator
-     * @see Symfony\Component\Finder\Comparator\NumberComparator
+     * @see SizeRangeFilterIterator
+     * @see NumberComparator
      *
      * @api
      */
@@ -401,7 +411,7 @@ public function size($size)
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\ExcludeDirectoryFilterIterator
+     * @see ExcludeDirectoryFilterIterator
      *
      * @api
      */
@@ -419,7 +429,7 @@ public function exclude($dirs)
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\ExcludeDirectoryFilterIterator
+     * @see ExcludeDirectoryFilterIterator
      *
      * @api
      */
@@ -441,7 +451,7 @@ public function ignoreDotFiles($ignoreDotFiles)
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\ExcludeDirectoryFilterIterator
+     * @see ExcludeDirectoryFilterIterator
      *
      * @api
      */
@@ -459,7 +469,7 @@ public function ignoreVCS($ignoreVCS)
     /**
      * Adds VCS patterns.
      *
-     * @see ignoreVCS
+     * @see ignoreVCS()
      *
      * @param string|string[] $pattern VCS patterns to ignore
      */
@@ -483,7 +493,7 @@ public static function addVCSPattern($pattern)
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\SortableIterator
+     * @see SortableIterator
      *
      * @api
      */
@@ -501,7 +511,7 @@ public function sort(\Closure $closure)
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\SortableIterator
+     * @see SortableIterator
      *
      * @api
      */
@@ -519,7 +529,7 @@ public function sortByName()
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\SortableIterator
+     * @see SortableIterator
      *
      * @api
      */
@@ -539,7 +549,7 @@ public function sortByType()
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\SortableIterator
+     * @see SortableIterator
      *
      * @api
      */
@@ -561,7 +571,7 @@ public function sortByAccessedTime()
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\SortableIterator
+     * @see SortableIterator
      *
      * @api
      */
@@ -581,7 +591,7 @@ public function sortByChangedTime()
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\SortableIterator
+     * @see SortableIterator
      *
      * @api
      */
@@ -602,7 +612,7 @@ public function sortByModifiedTime()
      *
      * @return Finder The current Finder instance
      *
-     * @see Symfony\Component\Finder\Iterator\CustomFilterIterator
+     * @see CustomFilterIterator
      *
      * @api
      */

Original file line number	Diff line number	Diff line change
`@@ -228,7 +228,7 @@ public function ignoreUnreadableDirs($ignore = true)`
`228`	`228`	`* isSupported in the adapters as the generic implementation provides a cache`
`229`	`229`	`* layer.`
`230`	`230`	`*`
`231`		`- * @see isSupported`
	`231`	`+ * @see isSupported()`
`232`	`232`	`*`
`233`	`233`	`* @return bool Whether the adapter is supported`
`234`	`234`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`* @copyright 2004-2005 Fabien Potencier <[email protected]>`
`31`	`31`	`* @copyright 2002 Richard Clamp <[email protected]>`
`32`	`32`	`*`
`33`		`- * @see http://physics.nist.gov/cuu/Units/binary.html`
	`33`	`+ * @see http://physics.nist.gov/cuu/Units/binary.html`
`34`	`34`	`*/`
`35`	`35`	`class NumberComparator extends Comparator`
`36`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,17 @@`
`15`	`15`	`use Symfony\Component\Finder\Adapter\GnuFindAdapter;`
`16`	`16`	`use Symfony\Component\Finder\Adapter\BsdFindAdapter;`
`17`	`17`	`use Symfony\Component\Finder\Adapter\PhpAdapter;`
	`18`	`+use Symfony\Component\Finder\Comparator\DateComparator;`
	`19`	`+use Symfony\Component\Finder\Comparator\NumberComparator;`
`18`	`20`	`use Symfony\Component\Finder\Exception\ExceptionInterface;`
	`21`	`+use Symfony\Component\Finder\Iterator\CustomFilterIterator;`
	`22`	`+use Symfony\Component\Finder\Iterator\DateRangeFilterIterator;`
	`23`	`+use Symfony\Component\Finder\Iterator\DepthRangeFilterIterator;`
	`24`	`+use Symfony\Component\Finder\Iterator\ExcludeDirectoryFilterIterator;`
	`25`	`+use Symfony\Component\Finder\Iterator\FilecontentFilterIterator;`
	`26`	`+use Symfony\Component\Finder\Iterator\FilenameFilterIterator;`
	`27`	`+use Symfony\Component\Finder\Iterator\SizeRangeFilterIterator;`
	`28`	`+use Symfony\Component\Finder\Iterator\SortableIterator;`
`19`	`29`
`20`	`30`	`/**`
`21`	`31`	`* Finder allows to build rules to find files and directories.`
`@@ -202,8 +212,8 @@ public function files()`
`202`	`212`	`*`
`203`	`213`	`* @return Finder The current Finder instance`
`204`	`214`	`*`
`205`		`- * @see Symfony\Component\Finder\Iterator\DepthRangeFilterIterator`
`206`		`- * @see Symfony\Component\Finder\Comparator\NumberComparator`
	`215`	`+ * @see DepthRangeFilterIterator`
	`216`	`+ * @see NumberComparator`
`207`	`217`	`*`
`208`	`218`	`* @api`
`209`	`219`	`*/`
`@@ -229,8 +239,8 @@ public function depth($level)`
`229`	`239`	`* @return Finder The current Finder instance`
`230`	`240`	`*`
`231`	`241`	`* @see strtotime`
`232`		`- * @see Symfony\Component\Finder\Iterator\DateRangeFilterIterator`
`233`		`- * @see Symfony\Component\Finder\Comparator\DateComparator`
	`242`	`+ * @see DateRangeFilterIterator`
	`243`	`+ * @see DateComparator`
`234`	`244`	`*`
`235`	`245`	`* @api`
`236`	`246`	`*/`
`@@ -254,7 +264,7 @@ public function date($date)`
`254`	`264`	`*`
`255`	`265`	`* @return Finder The current Finder instance`
`256`	`266`	`*`
`257`		`- * @see Symfony\Component\Finder\Iterator\FilenameFilterIterator`
	`267`	`+ * @see FilenameFilterIterator`
`258`	`268`	`*`
`259`	`269`	`* @api`
`260`	`270`	`*/`
`@@ -272,7 +282,7 @@ public function name($pattern)`
`272`	`282`	`*`
`273`	`283`	`* @return Finder The current Finder instance`
`274`	`284`	`*`
`275`		`- * @see Symfony\Component\Finder\Iterator\FilenameFilterIterator`
	`285`	`+ * @see FilenameFilterIterator`
`276`	`286`	`*`
`277`	`287`	`* @api`
`278`	`288`	`*/`
`@@ -295,7 +305,7 @@ public function notName($pattern)`
`295`	`305`	`*`
`296`	`306`	`* @return Finder The current Finder instance`
`297`	`307`	`*`
`298`		`- * @see Symfony\Component\Finder\Iterator\FilecontentFilterIterator`
	`308`	`+ * @see FilecontentFilterIterator`
`299`	`309`	`*/`
`300`	`310`	`public function contains($pattern)`
`301`	`311`	`{`
`@@ -316,7 +326,7 @@ public function contains($pattern)`
`316`	`326`	`*`
`317`	`327`	`* @return Finder The current Finder instance`
`318`	`328`	`*`
`319`		`- * @see Symfony\Component\Finder\Iterator\FilecontentFilterIterator`
	`329`	`+ * @see FilecontentFilterIterator`
`320`	`330`	`*/`
`321`	`331`	`public function notContains($pattern)`
`322`	`332`	`{`
`@@ -339,7 +349,7 @@ public function notContains($pattern)`
`339`	`349`	`*`
`340`	`350`	`* @return Finder The current Finder instance`
`341`	`351`	`*`
`342`		`- * @see Symfony\Component\Finder\Iterator\FilenameFilterIterator`
	`352`	`+ * @see FilenameFilterIterator`
`343`	`353`	`*/`
`344`	`354`	`public function path($pattern)`
`345`	`355`	`{`
`@@ -362,7 +372,7 @@ public function path($pattern)`
`362`	`372`	`*`
`363`	`373`	`* @return Finder The current Finder instance`
`364`	`374`	`*`
`365`		`- * @see Symfony\Component\Finder\Iterator\FilenameFilterIterator`
	`375`	`+ * @see FilenameFilterIterator`
`366`	`376`	`*/`
`367`	`377`	`public function notPath($pattern)`
`368`	`378`	`{`
`@@ -382,8 +392,8 @@ public function notPath($pattern)`
`382`	`392`	`*`
`383`	`393`	`* @return Finder The current Finder instance`
`384`	`394`	`*`
`385`		`- * @see Symfony\Component\Finder\Iterator\SizeRangeFilterIterator`
`386`		`- * @see Symfony\Component\Finder\Comparator\NumberComparator`
	`395`	`+ * @see SizeRangeFilterIterator`
	`396`	`+ * @see NumberComparator`
`387`	`397`	`*`
`388`	`398`	`* @api`
`389`	`399`	`*/`
`@@ -401,7 +411,7 @@ public function size($size)`
`401`	`411`	`*`
`402`	`412`	`* @return Finder The current Finder instance`
`403`	`413`	`*`
`404`		`- * @see Symfony\Component\Finder\Iterator\ExcludeDirectoryFilterIterator`
	`414`	`+ * @see ExcludeDirectoryFilterIterator`
`405`	`415`	`*`
`406`	`416`	`* @api`
`407`	`417`	`*/`
`@@ -419,7 +429,7 @@ public function exclude($dirs)`
`419`	`429`	`*`
`420`	`430`	`* @return Finder The current Finder instance`
`421`	`431`	`*`
`422`		`- * @see Symfony\Component\Finder\Iterator\ExcludeDirectoryFilterIterator`
	`432`	`+ * @see ExcludeDirectoryFilterIterator`
`423`	`433`	`*`
`424`	`434`	`* @api`
`425`	`435`	`*/`
`@@ -441,7 +451,7 @@ public function ignoreDotFiles($ignoreDotFiles)`
`441`	`451`	`*`
`442`	`452`	`* @return Finder The current Finder instance`
`443`	`453`	`*`
`444`		`- * @see Symfony\Component\Finder\Iterator\ExcludeDirectoryFilterIterator`
	`454`	`+ * @see ExcludeDirectoryFilterIterator`
`445`	`455`	`*`
`446`	`456`	`* @api`
`447`	`457`	`*/`
`@@ -459,7 +469,7 @@ public function ignoreVCS($ignoreVCS)`
`459`	`469`	`/**`
`460`	`470`	`* Adds VCS patterns.`
`461`	`471`	`*`
`462`		`- * @see ignoreVCS`
	`472`	`+ * @see ignoreVCS()`
`463`	`473`	`*`
`464`	`474`	`* @param string\|string[] $pattern VCS patterns to ignore`
`465`	`475`	`*/`
`@@ -483,7 +493,7 @@ public static function addVCSPattern($pattern)`
`483`	`493`	`*`
`484`	`494`	`* @return Finder The current Finder instance`
`485`	`495`	`*`
`486`		`- * @see Symfony\Component\Finder\Iterator\SortableIterator`
	`496`	`+ * @see SortableIterator`
`487`	`497`	`*`
`488`	`498`	`* @api`
`489`	`499`	`*/`
`@@ -501,7 +511,7 @@ public function sort(\Closure $closure)`
`501`	`511`	`*`
`502`	`512`	`* @return Finder The current Finder instance`
`503`	`513`	`*`
`504`		`- * @see Symfony\Component\Finder\Iterator\SortableIterator`
	`514`	`+ * @see SortableIterator`
`505`	`515`	`*`
`506`	`516`	`* @api`
`507`	`517`	`*/`
`@@ -519,7 +529,7 @@ public function sortByName()`
`519`	`529`	`*`
`520`	`530`	`* @return Finder The current Finder instance`
`521`	`531`	`*`
`522`		`- * @see Symfony\Component\Finder\Iterator\SortableIterator`
	`532`	`+ * @see SortableIterator`
`523`	`533`	`*`
`524`	`534`	`* @api`
`525`	`535`	`*/`
`@@ -539,7 +549,7 @@ public function sortByType()`
`539`	`549`	`*`
`540`	`550`	`* @return Finder The current Finder instance`
`541`	`551`	`*`
`542`		`- * @see Symfony\Component\Finder\Iterator\SortableIterator`
	`552`	`+ * @see SortableIterator`
`543`	`553`	`*`
`544`	`554`	`* @api`
`545`	`555`	`*/`
`@@ -561,7 +571,7 @@ public function sortByAccessedTime()`
`561`	`571`	`*`
`562`	`572`	`* @return Finder The current Finder instance`
`563`	`573`	`*`
`564`		`- * @see Symfony\Component\Finder\Iterator\SortableIterator`
	`574`	`+ * @see SortableIterator`
`565`	`575`	`*`
`566`	`576`	`* @api`
`567`	`577`	`*/`
`@@ -581,7 +591,7 @@ public function sortByChangedTime()`
`581`	`591`	`*`
`582`	`592`	`* @return Finder The current Finder instance`
`583`	`593`	`*`
`584`		`- * @see Symfony\Component\Finder\Iterator\SortableIterator`
	`594`	`+ * @see SortableIterator`
`585`	`595`	`*`
`586`	`596`	`* @api`
`587`	`597`	`*/`
`@@ -602,7 +612,7 @@ public function sortByModifiedTime()`
`602`	`612`	`*`
`603`	`613`	`* @return Finder The current Finder instance`
`604`	`614`	`*`
`605`		`- * @see Symfony\Component\Finder\Iterator\CustomFilterIterator`
	`615`	`+ * @see CustomFilterIterator`
`606`	`616`	`*`
`607`	`617`	`* @api`
`608`	`618`	`*/`