fixed PHPDoc

symfony · yceruto · Sep 2, 2016 · Sep 2, 2016 · Sep 2, 2016 · Sep 2, 2016
commit c1cc147844cb64cf0e53d8a11aa2d6981e94297a
diff --git a/src/Symfony/Bundle/TwigBundle/Extension/ActionsExtension.php b/src/Symfony/Bundle/TwigBundle/Extension/ActionsExtension.php
@@ -52,6 +52,8 @@ public function __construct($handler)
      * @param string $uri     A URI
      * @param array  $options An array of options
      *
+     * @return string|null The Response content or null when the Response is streamed
+     *
      * @see FragmentHandler::render()
      */
     public function renderUri($uri, array $options = array())

diff --git a/src/Symfony/Bundle/WebProfilerBundle/EventListener/WebDebugToolbarListener.php b/src/Symfony/Bundle/WebProfilerBundle/EventListener/WebDebugToolbarListener.php
@@ -108,8 +108,6 @@ public function onKernelResponse(FilterResponseEvent $event)
 
     /**
      * Injects the web debug toolbar into the given Response.
-     *
-     * @param Response $response A Response instance
      */
     protected function injectToolbar(Response $response, Request $request)
     {

diff --git a/src/Symfony/Component/Console/Command/Command.php b/src/Symfony/Component/Console/Command/Command.php
@@ -569,6 +569,8 @@ public function getSynopsis($short = false)
      * Add a command usage example.
      *
      * @param string $usage The usage, it'll be prefixed with the command name
+     *
+     * @return Command The current instance
      */
     public function addUsage($usage)
     {

diff --git a/src/Symfony/Component/Console/Helper/QuestionHelper.php b/src/Symfony/Component/Console/Helper/QuestionHelper.php
@@ -200,6 +200,7 @@ protected function writeError(OutputInterface $output, \Exception $error)
      *
      * @param OutputInterface $output
      * @param Question        $question
+     * @param resource        $inputStream
      *
      * @return string
      */
@@ -316,7 +317,8 @@ private function autocomplete(OutputInterface $output, Question $question, $inpu
     /**
      * Gets a hidden response from user.
      *
-     * @param OutputInterface $output An Output instance
+     * @param OutputInterface $output      An Output instance
+     * @param resource        $inputStream The handler resource
      *
      * @return string The answer
      *

diff --git a/src/Symfony/Component/Console/Tests/Helper/HelperSetTest.php b/src/Symfony/Component/Console/Tests/Helper/HelperSetTest.php
@@ -107,13 +107,6 @@ public function testIteration()
         }
     }
 
-    /**
-     * Create a generic mock for the helper interface. Optionally check for a call to setHelperSet with a specific
-     * helperset instance.
-     *
-     * @param string    $name
-     * @param HelperSet $helperset allows a mock to verify a particular helperset set is being added to the Helper
-     */
     private function getGenericMockHelper($name, HelperSet $helperset = null)
     {
         $mock_helper = $this->getMock('\Symfony\Component\Console\Helper\HelperInterface');

diff --git a/src/Symfony/Component/CssSelector/XPath/Translator.php b/src/Symfony/Component/CssSelector/XPath/Translator.php
@@ -68,9 +68,6 @@ class Translator implements TranslatorInterface
      */
     private $attributeMatchingTranslators = array();
 
-    /**
-     * Constructor.
-     */
     public function __construct(ParserInterface $parser = null)
     {
         $this->mainParser = $parser ?: new Parser();

diff --git a/src/Symfony/Component/Debug/ErrorHandler.php b/src/Symfony/Component/Debug/ErrorHandler.php
@@ -349,10 +349,12 @@ private function reRegister($prev)
     /**
      * Handles errors by filtering then logging them according to the configured bit fields.
      *
-     * @param int    $type    One of the E_* constants
+     * @param int    $type      One of the E_* constants
+     * @param string $message
      * @param string $file
      * @param int    $line
      * @param array  $context
+     * @param array  $backtrace
      *
      * @return bool Returns false when no handling happens so that the PHP engine can handle the error itself
      *

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ServiceReferenceGraphEdge.php b/src/Symfony/Component/DependencyInjection/Compiler/ServiceReferenceGraphEdge.php
@@ -39,7 +39,7 @@ public function __construct(ServiceReferenceGraphNode $sourceNode, ServiceRefere
     /**
      * Returns the value of the edge.
      *
-     * @return ServiceReferenceGraphNode
+     * @return string
      */
     public function getValue()
     {

diff --git a/src/Symfony/Component/ExpressionLanguage/TokenStream.php b/src/Symfony/Component/ExpressionLanguage/TokenStream.php
@@ -60,6 +60,10 @@ public function next()
 
     /**
      * Tests a token.
+     *
+     * @param array|int   $type    The type to test
+     * @param string|null $value   The token value
+     * @param string|null $message The syntax error message
      */
     public function expect($type, $value = null, $message = null)
     {

diff --git a/src/Symfony/Component/Filesystem/Filesystem.php b/src/Symfony/Component/Filesystem/Filesystem.php
@@ -285,6 +285,8 @@ public function rename($origin, $target, $overwrite = false)
      *
      * @param string $filename Path to the file
      *
+     * @return bool
+     *
      * @throws IOException When windows path is longer than 258 characters
      */
     private function isReadable($filename)

diff --git a/src/Symfony/Component/Form/ChoiceList/ArrayChoiceList.php b/src/Symfony/Component/Form/ChoiceList/ArrayChoiceList.php
@@ -183,12 +183,13 @@ public function getValuesForChoices(array $choices)
     /**
      * Flattens an array into the given output variables.
      *
-     * @param array    $choices         The array to flatten
-     * @param callable $value           The callable for generating choice values
-     * @param array    $choicesByValues The flattened choices indexed by the
-     *                                  corresponding values
-     * @param array    $keysByValues    The original keys indexed by the
-     *                                  corresponding values
+     * @param array    $choices          The array to flatten
+     * @param callable $value            The callable for generating choice values
+     * @param array    $choicesByValues  The flattened choices indexed by the
+     *                                   corresponding values
+     * @param array    $keysByValues     The original keys indexed by the
+     *                                   corresponding values
+     * @param array    $structuredValues The values indexed by the original keys
      *
      * @internal Must not be used by user-land code
      */

diff --git a/src/Symfony/Component/Form/ChoiceList/ArrayKeyChoiceList.php b/src/Symfony/Component/Form/ChoiceList/ArrayKeyChoiceList.php
@@ -153,12 +153,13 @@ public function getValuesForChoices(array $choices)
     /**
      * Flattens and flips an array into the given output variable.
      *
-     * @param array    $choices         The array to flatten
-     * @param callable $value           The callable for generating choice values
-     * @param array    $choicesByValues The flattened choices indexed by the
-     *                                  corresponding values
-     * @param array    $keysByValues    The original keys indexed by the
-     *                                  corresponding values
+     * @param array    $choices          The array to flatten
+     * @param callable $value            The callable for generating choice values
+     * @param array    $choicesByValues  The flattened choices indexed by the
+     *                                   corresponding values
+     * @param array    $keysByValues     The original keys indexed by the
+     *                                   corresponding values
+     * @param array    $structuredValues The values indexed by the original keys
      *
      * @internal Must not be used by user-land code
      */

diff --git a/...ny/Component/Form/Extension/Core/DataTransformer/DateTimeToLocalizedStringTransformer.php b/...ny/Component/Form/Extension/Core/DataTransformer/DateTimeToLocalizedStringTransformer.php
@@ -178,8 +178,6 @@ protected function getIntlDateFormatter($ignoreTimezone = false)
     /**
      * Checks if the pattern contains only a date.
      *
-     * @param string $pattern The input pattern
-     *
      * @return bool
      */
     protected function isPatternDateOnly()

diff --git a/src/Symfony/Component/Form/Extension/DataCollector/FormDataExtractor.php b/src/Symfony/Component/Form/Extension/DataCollector/FormDataExtractor.php
@@ -23,14 +23,8 @@
  */
 class FormDataExtractor implements FormDataExtractorInterface
 {
-    /**
-     * @var ValueExporter
-     */
     private $valueExporter;
 
-    /**
-     * Constructs a new data extractor.
-     */
     public function __construct(ValueExporter $valueExporter = null)
     {
         $this->valueExporter = $valueExporter ?: new ValueExporter();

diff --git a/src/Symfony/Component/HttpFoundation/JsonResponse.php b/src/Symfony/Component/HttpFoundation/JsonResponse.php
@@ -50,7 +50,18 @@ public function __construct($data = null, $status = 200, $headers = array())
     }
 
     /**
-     * {@inheritdoc}
+     * Factory method for chainability.
+     *
+     * Example:.
+     *
+     *     return JsonResponse::create($data, 200)
+     *         ->setSharedMaxAge(300);
+     *
+     * @param mixed $data    The json response data
+     * @param int   $status  The response status code
+     * @param array $headers An array of response headers
+     *
+     * @return JsonResponse
      */
     public static function create($data = null, $status = 200, $headers = array())
     {

diff --git a/src/Symfony/Component/HttpFoundation/Session/Flash/FlashBagInterface.php b/src/Symfony/Component/HttpFoundation/Session/Flash/FlashBagInterface.php
@@ -72,6 +72,8 @@ public function all();
 
     /**
      * Sets all flash messages.
+     *
+     * @param array $messages
      */
     public function setAll(array $messages);
 

diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MongoDbSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MongoDbSessionHandler.php
@@ -214,6 +214,8 @@ protected function getMongo()
      * Return an instance of a MongoDate or \MongoDB\BSON\UTCDateTime
      *
      * @param int $seconds An integer representing UTC seconds since Jan 1 1970.  Defaults to now.
+     *
+     * @return \MongoDate|\MongoDB\BSON\UTCDateTime
      */
     private function createDateTime($seconds = null)
     {

diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/LazyLoadingFragmentHandler.php b/src/Symfony/Component/HttpKernel/DependencyInjection/LazyLoadingFragmentHandler.php
@@ -35,6 +35,7 @@ public function __construct(ContainerInterface $container, $debug = false, Reque
     /**
      * Adds a service as a fragment renderer.
      *
+     * @param string $name     The service name
      * @param string $renderer The render service id
      */
     public function addRendererService($name, $renderer)

diff --git a/src/Symfony/Component/HttpKernel/Profiler/Profiler.php b/src/Symfony/Component/HttpKernel/Profiler/Profiler.php
@@ -78,7 +78,7 @@ public function enable()
      *
      * @param Response $response A Response instance
      *
-     * @return Profile A Profile instance
+     * @return Profile|false A Profile instance
      */
     public function loadProfileFromResponse(Response $response)
     {
@@ -149,7 +149,7 @@ public function export(Profile $profile)
      *
      * @param string $data A data string as exported by the export() method
      *
-     * @return Profile A Profile instance
+     * @return Profile|false A Profile instance
      */
     public function import($data)
     {

diff --git a/src/Symfony/Component/Intl/ResourceBundle/LanguageBundle.php b/src/Symfony/Component/Intl/ResourceBundle/LanguageBundle.php
@@ -42,6 +42,7 @@ class LanguageBundle extends LanguageDataProvider implements LanguageBundleInter
      * @param string                     $path
      * @param BundleEntryReaderInterface $reader
      * @param LocaleDataProvider         $localeProvider
+     * @param ScriptDataProvider         $scriptProvider
      */
     public function __construct($path, BundleEntryReaderInterface $reader, LocaleDataProvider $localeProvider, ScriptDataProvider $scriptProvider)
     {

diff --git a/src/Symfony/Component/Translation/DataCollectorTranslator.php b/src/Symfony/Component/Translation/DataCollectorTranslator.php
@@ -108,7 +108,7 @@ public function getCollectedMessages()
      * @param string|null $locale
      * @param string|null $domain
      * @param string      $id
-     * @param string      $trans
+     * @param string      $translation
      */
     private function collectMessage($locale, $domain, $id, $translation)
     {

diff --git a/src/Symfony/Component/Validator/Tests/Validator/Abstract2Dot5ApiTest.php b/src/Symfony/Component/Validator/Tests/Validator/Abstract2Dot5ApiTest.php
@@ -40,6 +40,7 @@ abstract class Abstract2Dot5ApiTest extends AbstractValidatorTest
 
     /**
      * @param MetadataFactoryInterface $metadataFactory
+     * @param array                    $objectInitializers
      *
      * @return ValidatorInterface
      */

diff --git a/src/Symfony/Component/VarDumper/Dumper/AbstractDumper.php b/src/Symfony/Component/VarDumper/Dumper/AbstractDumper.php
@@ -168,8 +168,9 @@ protected function dumpLine($depth)
     /**
      * Generic line dumper callback.
      *
-     * @param string $line  The line to write
-     * @param int    $depth The recursive depth in the dumped structure
+     * @param string $line      The line to write
+     * @param int    $depth     The recursive depth in the dumped structure
+     * @param string $indentPad The line indent pad
      */
     protected function echoLine($line, $depth, $indentPad)
     {
-Original file line number
+Diff line change
@@ Expand Up @@
         /**
          * Injects the web debug toolbar into the given Response.
-         *
-         * @param Response $response A Response instance
          */
         protected function injectToolbar(Response $response, Request $request)
         {
@@ Expand Down @@