phpdoc fixes

nicolas-grekas · nicolas-grekas · commit e1730f411a0d · 2021-07-21T10:35:38.000+02:00
diff --git a/src/Symfony/Component/Console/Command/Command.php b/src/Symfony/Component/Console/Command/Command.php
@@ -464,7 +464,7 @@ public function getName()
     /**
      * @param bool $hidden Whether or not the command should be hidden from the list of commands
      *
-     * @return Command The current instance
+     * @return $this
      */
     public function setHidden($hidden)
     {
diff --git a/src/Symfony/Component/Messenger/Envelope.php b/src/Symfony/Component/Messenger/Envelope.php
@@ -53,7 +53,7 @@ public static function wrap($message, array $stamps = []): self
     }
 
     /**
-     * @return Envelope a new Envelope instance with additional stamp
+     * @return static A new Envelope instance with additional stamp
      */
     public function with(StampInterface ...$stamps): self
     {
@@ -67,7 +67,7 @@ public function with(StampInterface ...$stamps): self
     }
 
     /**
-     * @return Envelope a new Envelope instance without any stamps of the given class
+     * @return static A new Envelope instance without any stamps of the given class
      */
     public function withoutAll(string $stampFqcn): self
     {
diff --git a/src/Symfony/Component/Templating/Loader/CacheLoader.php b/src/Symfony/Component/Templating/Loader/CacheLoader.php
@@ -12,7 +12,6 @@
 namespace Symfony\Component\Templating\Loader;
 
 use Symfony\Component\Templating\Storage\FileStorage;
-use Symfony\Component\Templating\Storage\Storage;
 use Symfony\Component\Templating\TemplateReferenceInterface;
 
 /**
@@ -39,9 +38,7 @@ public function __construct(LoaderInterface $loader, string $dir)
     }
 
     /**
-     * Loads a template.
-     *
-     * @return Storage|bool false if the template cannot be loaded, a Storage instance otherwise
+     * {@inheritdoc}
      */
     public function load(TemplateReferenceInterface $template)
     {
@@ -78,11 +75,7 @@ public function load(TemplateReferenceInterface $template)
     }
 
     /**
-     * Returns true if the template is still fresh.
-     *
-     * @param int $time The last modification time of the cached template (timestamp)
-     *
-     * @return bool
+     * {@inheritdoc}
      */
     public function isFresh(TemplateReferenceInterface $template, $time)
     {
diff --git a/src/Symfony/Component/Templating/Loader/ChainLoader.php b/src/Symfony/Component/Templating/Loader/ChainLoader.php
@@ -11,7 +11,6 @@
 
 namespace Symfony\Component\Templating\Loader;
 
-use Symfony\Component\Templating\Storage\Storage;
 use Symfony\Component\Templating\TemplateReferenceInterface;
 
 /**
@@ -24,7 +23,7 @@ class ChainLoader extends Loader
     protected $loaders = [];
 
     /**
-     * @param LoaderInterface[] $loaders An array of loader instances
+     * @param LoaderInterface[] $loaders
      */
     public function __construct(array $loaders = [])
     {
@@ -33,18 +32,13 @@ public function __construct(array $loaders = [])
         }
     }
 
-    /**
-     * Adds a loader instance.
-     */
     public function addLoader(LoaderInterface $loader)
     {
         $this->loaders[] = $loader;
     }
 
     /**
-     * Loads a template.
-     *
-     * @return Storage|bool false if the template cannot be loaded, a Storage instance otherwise
+     * {@inheritdoc}
      */
     public function load(TemplateReferenceInterface $template)
     {
@@ -58,11 +52,7 @@ public function load(TemplateReferenceInterface $template)
     }
 
     /**
-     * Returns true if the template is still fresh.
-     *
-     * @param int $time The last modification time of the cached template (timestamp)
-     *
-     * @return bool
+     * {@inheritdoc}
      */
     public function isFresh(TemplateReferenceInterface $template, $time)
     {
diff --git a/src/Symfony/Component/Templating/Loader/FilesystemLoader.php b/src/Symfony/Component/Templating/Loader/FilesystemLoader.php
@@ -12,7 +12,6 @@
 namespace Symfony\Component\Templating\Loader;
 
 use Symfony\Component\Templating\Storage\FileStorage;
-use Symfony\Component\Templating\Storage\Storage;
 use Symfony\Component\Templating\TemplateReferenceInterface;
 
 /**
@@ -33,9 +32,7 @@ public function __construct($templatePathPatterns)
     }
 
     /**
-     * Loads a template.
-     *
-     * @return Storage|bool false if the template cannot be loaded, a Storage instance otherwise
+     * {@inheritdoc}
      */
     public function load(TemplateReferenceInterface $template)
     {
@@ -76,11 +73,7 @@ public function load(TemplateReferenceInterface $template)
     }
 
     /**
-     * Returns true if the template is still fresh.
-     *
-     * @param int $time The last modification time of the cached template (timestamp)
-     *
-     * @return bool true if the template is still fresh, false otherwise
+     * {@inheritdoc}
      */
     public function isFresh(TemplateReferenceInterface $template, $time)
     {
diff --git a/src/Symfony/Component/Templating/Loader/LoaderInterface.php b/src/Symfony/Component/Templating/Loader/LoaderInterface.php
@@ -24,7 +24,7 @@ interface LoaderInterface
     /**
      * Loads a template.
      *
-     * @return Storage|bool false if the template cannot be loaded, a Storage instance otherwise
+     * @return Storage|false false if the template cannot be loaded, a Storage instance otherwise
      */
     public function load(TemplateReferenceInterface $template);
 
diff --git a/src/Symfony/Component/Workflow/TransitionBlockerList.php b/src/Symfony/Component/Workflow/TransitionBlockerList.php
@@ -61,7 +61,7 @@ public function isEmpty(): bool
     /**
      * {@inheritdoc}
      *
-     * @return \ArrayIterator|TransitionBlocker[]
+     * @return \Traversable<TransitionBlocker>
      */
     public function getIterator(): \Traversable
     {

Original file line number	Diff line number	Diff line change
`@@ -464,7 +464,7 @@ public function getName()`
`464`	`464`	`/**`
`465`	`465`	`* @param bool $hidden Whether or not the command should be hidden from the list of commands`
`466`	`466`	`*`
`467`		`- * @return Command The current instance`
	`467`	`+ * @return $this`
`468`	`468`	`*/`
`469`	`469`	`public function setHidden($hidden)`
`470`	`470`	`{`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public static function wrap($message, array $stamps = []): self`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`/**`
`56`		`- * @return Envelope a new Envelope instance with additional stamp`
	`56`	`+ * @return static A new Envelope instance with additional stamp`
`57`	`57`	`*/`
`58`	`58`	`public function with(StampInterface ...$stamps): self`
`59`	`59`	`{`
`@@ -67,7 +67,7 @@ public function with(StampInterface ...$stamps): self`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`/**`
`70`		`- * @return Envelope a new Envelope instance without any stamps of the given class`
	`70`	`+ * @return static A new Envelope instance without any stamps of the given class`
`71`	`71`	`*/`
`72`	`72`	`public function withoutAll(string $stampFqcn): self`
`73`	`73`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Templating\Loader;`
`13`	`13`
`14`		`-use Symfony\Component\Templating\Storage\Storage;`
`15`	`14`	`use Symfony\Component\Templating\TemplateReferenceInterface;` 57AE
`16`	`15`
`17`	`16`	`/**`
`@@ -24,7 +23,7 @@ class ChainLoader extends Loader`
`24`	`23`	`protected $loaders = [];`
`25`	`24`
`26`	`25`	`/**`
`27`		`- * @param LoaderInterface[] $loaders An array of loader instances`
	`26`	`+ * @param LoaderInterface[] $loaders`
`28`	`27`	`*/`
`29`	`28`	`public function __construct(array $loaders = [])`
`30`	`29`	`{`
`@@ -33,18 +32,13 @@ public function __construct(array $loaders = [])`
`33`	`32`	`}`
`34`	`33`	`}`
`35`	`34`
`36`		`- /**`
`37`		`- * Adds a loader instance.`
`38`		`- */`
`39`	`35`	`public function addLoader(LoaderInterface $loader)`
`40`	`36`	`{`
`41`	`37`	`$this->loaders[] = $loader;`
`42`	`38`	`}`
`43`	`39`
`44`	`40`	`/**`
`45`		`- * Loads a template.`
`46`		`- *`
`47`		`- * @return Storage\|bool false if the template cannot be loaded, a Storage instance otherwise`
	`41`	`+ * {@inheritdoc}`
`48`	`42`	`*/`
`49`	`43`	`public function load(TemplateReferenceInterface $template)`
`50`	`44`	`{`
`@@ -58,11 +52,7 @@ public function load(TemplateReferenceInterface $template)`
`58`	`52`	`}`
`59`	`53`
`60`	`54`	`/**`
`61`		`- * Returns true if the template is still fresh.`
`62`		`- *`
`63`		`- * @param int $time The last modification time of the cached template (timestamp)`
`64`		`- *`
`65`		`- * @return bool`
	`55`	`+ * {@inheritdoc}`
`66`	`56`	`*/`
`67`	`57`	`public function isFresh(TemplateReferenceInterface $template, $time)`
`68`	`58`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ interface LoaderInterface`
`24`	`24`	`/**`
`25`	`25`	`* Loads a template.`
`26`	`26`	`*`
`27`		`- * @return Storage\|bool false if the template cannot be loaded, a Storage instance otherwise`
	`27`	`+ * @return Storage\|false false if the template cannot be loaded, a Storage instance otherwise`
`28`	`28`	`*/`
`29`	`29`	`public function load(TemplateReferenceInterface $template);`
`30`	`30`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public function isEmpty(): bool`
`61`	`61`	`/**`
`62`	`62`	`* {@inheritdoc}`
`63`	`63`	`*`
`64`		`- * @return \ArrayIterator\|TransitionBlocker[]`
	`64`	`+ * @return \Traversable<TransitionBlocker>`
`65`	`65`	`*/`
`66`	`66`	`public function getIterator(): \Traversable`
`67`	`67`	`{`