Cleanup more @return annotations

nicolas-grekas · nicolas-grekas · commit 9933f638fbd6 · 2021-08-17T16:20:01.000+02:00
diff --git a/DelegatingEngine.php b/DelegatingEngine.php
@@ -86,7 +86,7 @@ public function supports($name)
      *
      * @param string|TemplateReferenceInterface $name A template name or a TemplateReferenceInterface instance
      *
-     * @return EngineInterface The engine
+     * @return EngineInterface
      *
      * @throws \RuntimeException if no engine able to work with the template is found
      */
diff --git a/EngineInterface.php b/EngineInterface.php
@@ -36,7 +36,7 @@ interface EngineInterface
      * @param string|TemplateReferenceInterface $name       A template name or a TemplateReferenceInterface instance
      * @param array                             $parameters An array of parameters to pass to the template
      *
-     * @return string The evaluated template as a string
+     * @return string
      *
      * @throws \RuntimeException if the template cannot be rendered
      */
@@ -47,7 +47,7 @@ public function render($name, array $parameters = []);
      *
      * @param string|TemplateReferenceInterface $name A template name or a TemplateReferenceInterface instance
      *
-     * @return bool true if the template exists, false otherwise
+     * @return bool
      *
      * @throws \RuntimeException if the engine cannot handle the template name
      */
@@ -58,7 +58,7 @@ public function exists($name);
      *
      * @param string|TemplateReferenceInterface $name A template name or a TemplateReferenceInterface instance
      *
-     * @return bool true if this class supports the given template, false otherwise
+     * @return bool
      */
     public function supports($name);
 }
diff --git a/Helper/Helper.php b/Helper/Helper.php
@@ -34,7 +34,7 @@ public function setCharset(string $charset)
     /**
      * Gets the default charset.
      *
-     * @return string The default charset
+     * @return string
      */
     public function getCharset()
     {
diff --git a/Helper/HelperInterface.php b/Helper/HelperInterface.php
@@ -21,7 +21,7 @@ interface HelperInterface
     /**
      * Returns the canonical name of this helper.
      *
-     * @return string The canonical name
+     * @return string
      */
     public function getName();
 
@@ -33,7 +33,7 @@ public function setCharset(string $charset);
     /**
      * Gets the default charset.
      *
-     * @return string The default charset
+     * @return string
      */
     public function getCharset();
 }
diff --git a/Helper/SlotsHelper.php b/Helper/SlotsHelper.php
@@ -73,7 +73,7 @@ public function has(string $name)
      *
      * @param bool|string $default The default slot content
      *
-     * @return string The slot content
+     * @return string
      */
     public function get(string $name, $default = false)
     {
@@ -115,7 +115,7 @@ public function output(string $name, $default = false)
     /**
      * Returns the canonical name of this helper.
      *
-     * @return string The canonical name
+     * @return string
      */
     public function getName()
     {
diff --git a/Loader/FilesystemLoader.php b/Loader/FilesystemLoader.php
@@ -87,7 +87,7 @@ public function isFresh(TemplateReferenceInterface $template, int $time)
     /**
      * Returns true if the file is an existing absolute path.
      *
-     * @return bool true if the path exists and is absolute, false otherwise
+     * @return bool
      */
     protected static function isAbsolutePath(string $file)
     {
diff --git a/PhpEngine.php b/PhpEngine.php
@@ -118,7 +118,7 @@ public function supports($name)
     /**
      * Evaluates a template.
      *
-     * @return string|false The evaluated template, or false if the engine is unable to render the template
+     * @return string|false
      *
      * @throws \InvalidArgumentException
      */
@@ -167,7 +167,7 @@ protected function evaluate(Storage $template, array $parameters = [])
      *
      * @param string $name The helper name
      *
-     * @return HelperInterface The helper value
+     * @return HelperInterface
      *
      * @throws \InvalidArgumentException if the helper is not defined
      */
@@ -182,7 +182,7 @@ public function offsetGet($name)
      *
      * @param string $name The helper name
      *
-     * @return bool true if the helper is defined, false otherwise
+     * @return bool
      */
     #[\ReturnTypeWillChange]
     public function offsetExists($name)
@@ -255,7 +255,7 @@ public function set(HelperInterface $helper, string $alias = null)
     /**
      * Returns true if the helper if defined.
      *
-     * @return bool true if the helper is defined, false otherwise
+     * @return bool
      */
     public function has(string $name)
     {
@@ -291,7 +291,7 @@ public function extend(string $template)
      *
      * @param mixed $value A variable to escape
      *
-     * @return mixed The escaped value
+     * @return mixed
      */
     public function escape($value, string $context = 'html')
     {
@@ -330,7 +330,7 @@ public function setCharset(string $charset)
     /**
      * Gets the current charset.
      *
-     * @return string The current charset
+     * @return string
      */
     public function getCharset()
     {
@@ -349,7 +349,7 @@ public function setEscaper(string $context, callable $escaper)
     /**
      * Gets an escaper for a given context.
      *
-     * @return callable A PHP callable
+     * @return callable
      *
      * @throws \InvalidArgumentException
      */
@@ -408,7 +408,7 @@ protected function initializeEscapers()
                  *
                  * @param string $value The value to escape
                  *
-                 * @return string the escaped value
+                 * @return string
                  */
                 function ($value) use ($flags) {
                     // Numbers and Boolean values get turned into strings which can cause problems
@@ -423,7 +423,7 @@ function ($value) use ($flags) {
                  *
                  * @param string $value The value to escape
                  *
-                 * @return string the escaped value
+                 * @return string
                  */
                 function ($value) {
                     if ('UTF-8' != $this->getCharset()) {
diff --git a/Storage/FileStorage.php b/Storage/FileStorage.php
@@ -21,7 +21,7 @@ class FileStorage extends Storage
     /**
      * Returns the content of the template.
      *
-     * @return string The template content
+     * @return string
      */
     public function getContent()
     {
diff --git a/Storage/Storage.php b/Storage/Storage.php
@@ -31,7 +31,7 @@ public function __construct(string $template)
     /**
      * Returns the object string representation.
      *
-     * @return string The template name
+     * @return string
      */
     public function __toString()
     {
@@ -41,7 +41,7 @@ public function __toString()
     /**
      * Returns the content of the template.
      *
-     * @return string The template content
+     * @return string
      */
     abstract public function getContent();
 }
diff --git a/Storage/StringStorage.php b/Storage/StringStorage.php
@@ -21,7 +21,7 @@ class StringStorage extends Storage
     /**
      * Returns the content of the template.
      *
-     * @return string The template content
+     * @return string
      */
     public function getContent()
     {
diff --git a/TemplateNameParserInterface.php b/TemplateNameParserInterface.php
@@ -24,7 +24,7 @@ interface TemplateNameParserInterface
      *
      * @param string|TemplateReferenceInterface $name A template name or a TemplateReferenceInterface instance
      *
-     * @return TemplateReferenceInterface A template
+     * @return TemplateReferenceInterface
      */
     public function parse($name);
 }
diff --git a/TemplateReferenceInterface.php b/TemplateReferenceInterface.php
@@ -21,7 +21,7 @@ interface TemplateReferenceInterface
     /**
      * Gets the template parameters.
      *
-     * @return array An array of parameters
+     * @return array
      */
     public function all();
 
@@ -37,7 +37,7 @@ public function set(string $name, string $value);
     /**
      * Gets a template parameter.
      *
-     * @return string The parameter value
+     * @return string
      *
      * @throws \InvalidArgumentException if the parameter name is not supported
      */
@@ -48,7 +48,7 @@ public function get(string $name);
      *
      * By default, it just returns the template name.
      *
-     * @return string A path to the template or a resource
+     * @return string
      */
     public function getPath();
 
@@ -57,7 +57,7 @@ public function getPath();
      *
      * The template name acts as a unique identifier for the template.
      *
-     * @return string The template name
+     * @return string
      */
     public function getLogicalName();
 
@@ -66,7 +66,7 @@ public function getLogicalName();
      *
      * Alias of getLogicalName().
      *
-     * @return string The template name
+     * @return string
      */
     public function __toString();
 }

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ public function supports($name)`
`86`	`86`	`*`
`87`	`87`	`* @param string\|TemplateReferenceInterface $name A template name or a TemplateReferenceInterface instance`
`88`	`88`	`*`
`89`		`- * @return EngineInterface The engine`
	`89`	`+ * @return EngineInterface`
`90`	`90`	`*`
`91`	`91`	`* @throws \RuntimeException if no engine able to work with the template is found`
`92`	`92`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ interface EngineInterface`
`36`	`36`	`* @param string\|TemplateReferenceInterface $name A template name or a TemplateReferenceInterface instance`
`37`	`37`	`* @param array $parameters An array of parameters to pass to the template`
`38`	`38`	`*`
`39`		`- * @return string The evaluated template as a string`
	`39`	`+ * @return string`
`40`	`40`	`*`
`41`	`41`	`* @throws \RuntimeException if the template cannot be rendered`
`42`	`42`	`*/`
`@@ -47,7 +47,7 @@ public function render($name, array $parameters = []);`
`47`	`47`	`*`
`48`	`48`	`* @param string\|TemplateReferenceInterface $name A template name or a TemplateReferenceInterface instance`
`49`	`49`	`*`
`50`		`- * @return bool true if the template exists, false otherwise`
	`50`	`+ * @return bool`
`51`	`51`	`*`
`52`	`52`	`* @throws \RuntimeException if the engine cannot handle the template name`
`53`	`53`	`*/`
`@@ -58,7 +58,7 @@ public function exists($name);`
`58`	`58`	`*`
`59`	`59`	`* @param string\|TemplateReferenceInterface $name A template name or a TemplateReferenceInterface instance`
`60`	`60`	`*`
`61`		`- * @return bool true if this class supports the given template, false otherwise`
	`61`	`+ * @return bool`
`62`	`62`	`*/`
`63`	`63`	`public function supports($name);`
`64`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public function setCharset(string $charset)`
`34`	`34`	`/**`
`35`	`35`	`* Gets the default charset.`
`36`	`36`	`*`
`37`		`- * @return string The default charset`
	`37`	`+ * @return string`
`38`	`38`	`*/`
`39`	`39`	`public function getCharset()`
`40`	`40`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ interface HelperInterface`
`21`	`21`	`/**`
`22`	`22`	`* Returns the canonical name of this helper.`
`23`	`23`	`*`
`24`		`- * @return string The canonical name`
	`24`	`+ * @return string`
`25`	`25`	`*/`
`26`	`26`	`public function getName();`
`27`	`27`
`@@ -33,7 +33,7 @@ public function setCharset(string $charset);`
`33`	`33`	`/**`
`34`	`34`	`* Gets the default charset.`
`35`	`35`	`*`
`36`		`- * @return string The default charset`
	`36`	`+ * @return string`
`37`	`37`	`*/`
`38`	`38`	`public function getCharset();`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ public function has(string $name)`
`73`	`73`	`*`
`74`	`74`	`* @param bool\|string $default The default slot content`
`75`	`75`	`*`
`76`		`- * @return string The slot content`
	`76`	`+ * @return string`
`77`	`77`	`*/`
`78`	`78`	`public function get(string $name, $default = false)`
`79`	`79`	`{`
`@@ -115,7 +115,7 @@ public function output(string $name, $default = false)`
`115`	`115`	`/**`
`116`	`116`	`* Returns the canonical name of this helper.`
`117`	`117`	`*`
`118`		`- * @return string The canonical name`
	`118`	`+ * @return string`
`119`	`119`	`*/`
`120`	`120`	`public function getName()`
`121`	`121`	`{`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ public function isFresh(TemplateReferenceInterface $template, int $time)`
`87`	`87`	`/**`
`88`	`88`	`* Returns true if the file is an existing absolute path.`
`89`	`89`	`*`
`90`		`- * @return bool true if the path exists and is absolute, false otherwise`
	`90`	`+ * @return bool`
`91`	`91`	`*/`
`92`	`92`	`protected static function isAbsolutePath(string $file)`
`93`	`93`	`{`
Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ public function supports($name)`
`118`	`118`	`/**`
`119`	`119`	`* Evaluates a template.`
`120`	`120`	`*`
`121`		`- * @return string\|false The evaluated template, or false if the engine is unable to render the template`
	`121`	`+ * @return string\|false`
`122`	`122`	`*`
`123`	`123`	`* @throws \InvalidArgumentException`
`124`	`124`	`*/`
`@@ -167,7 +167,7 @@ protected function evaluate(Storage $template, array $parameters = [])`
`167`	`167`	`*`
`168`	`168`	`* @param string $name The helper name`
`169`	`169`	`*`
`170`		`- * @return HelperInterface The helper value`
	`170`	`+ * @return HelperInterface`
`171`	`171`	`*`
`172`	`172`	`* @throws \InvalidArgumentException if the helper is not defined`
`173`	`173`	`*/`
`@@ -182,7 +182,7 @@ public function offsetGet($name)`
`182`	`182`	`*`
`183`	`183`	`* @param string $name The helper name`
`184`	`184`	`*`
`185`		`- * @return bool true if the helper is defined, false otherwise`
	`185`	`+ * @return bool`
`186`	`186`	`*/`
`187`	`187`	`#[\ReturnTypeWillChange]`
`188`	`188`	`public function offsetExists($name)`
`@@ -255,7 +255,7 @@ public function set(HelperInterface $helper, string $alias = null)`
`255`	`255`	`/**`
`256`	`256`	`* Returns true if the helper if defined.`
`257`	`257`	`*`
`258`		`- * @return bool true if the helper is defined, false otherwise`
	`258`	`+ * @return bool`
`259`	`259`	`*/`
`260`	`260`	`public function has(string $name)`
`261`	`261`	`{`
`@@ -291,7 +291,7 @@ public function extend(string $template)`
`291`	`291`	`*`
`292`	`292`	`* @param mixed $value A variable to escape`
`293`	`293`	`*`
`294`		`- * @return mixed The escaped value`
	`294`	`+ * @return mixed`
`295`	`295`	`*/`
`296`	`296`	`public function escape($value, string $context = 'html')`
`297`	`297`	`{`
`@@ -330,7 +330,7 @@ public function setCharset(string $charset)`
`330`	`330`	`/**`
`331`	`331`	`* Gets the current charset.`
`332`	`332`	`*`
`333`		`- * @return string The current charset`
	`333`	`+ * @return string`
`334`	`334`	`*/`
`335`	`335`	`public function getCharset()`
`336`	`336`	`{`
`@@ -349,7 +349,7 @@ public function setEscaper(string $context, callable $escaper)`
`349`	`349`	`/**`
`350`	`350`	`* Gets an escaper for a given context.`
`351`	`351`	`*`
`352`		`- * @return callable A PHP callable`
	`352`	`+ * @return callable`
`353`	`353`	`*`
`354`	`354`	`* @throws \InvalidArgumentException`
`355`	`355`	`*/`
`@@ -408,7 +408,7 @@ protected function initializeEscapers()`
`408`	`408`	`*`
`409`	`409`	`* @param string $value The value to escape`
`410`	`410`	`*`
`411`		`- * @return string the escaped value`
	`411`	`+ * @return string`
`412`	`412`	`*/`
`413`	`413`	`function ($value) use ($flags) {`
`414`	`414`	`// Numbers and Boolean values get turned into strings which can cause problems`
`@@ -423,7 +423,7 @@ function ($value) use ($flags) {`
`423`	`423`	`*`
`424`	`424`	`* @param string $value The value to escape`
`425`	`425`	`*`
`426`		`- * @return string the escaped value`
	`426`	`+ * @return string`
`427`	`427`	`*/`
`428`	`428`	`function ($value) {`
`429`	`429`	`if ('UTF-8' != $this->getCharset()) {`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ class FileStorage extends Storage`
`21`	`21`	`/**`
`22`	`22`	`* Returns the content of the template.`
`23`	`23`	`*`
`24`		`- * @return string The template content`
	`24`	`+ * @return string`
`25`	`25`	`*/`
`26`	`26`	`public function getContent()`
`27`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public function __construct(string $template)`
`31`	`31`	`/**`
`32`	`32`	`* Returns the object string representation.`
`33`	`33`	`*`
`34`		`- * @return string The template name`
	`34`	`+ * @return string`
`35`	`35`	`*/`
`36`	`36`	`public function __toString()`
`37`	`37`	`{`
`@@ -41,7 +41,7 @@ public function __toString()`
`41`	`41`	`/**`
`42`	`42`	`* Returns the content of the template.`
`43`	`43`	`*`
`44`		`- * @return string The template content`
	`44`	`+ * @return string`
`45`	`45`	`*/`
`46`	`46`	`abstract public function getContent();`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ class StringStorage extends Storage`
`21`	`21`	`/**`
`22`	`22`	`* Returns the content of the template.`
`23`	`23`	`*`
`24`		`- * @return string The template content`
	`24`	`+ * @return string`
`25`	`25`	`*/`
`26`	`26`	`public function getContent()`
`27`	`27`	`{`