Skip to content

Commit

Permalink
minor #33019 Remove unneeded phpdocs (fabpot)
Browse files Browse the repository at this point in the history
This PR was squashed before being merged into the 4.4 branch (closes #33019).

Discussion
----------

Remove unneeded phpdocs

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | no
| New feature?  | no <!-- please update src/**/CHANGELOG.md files -->
| BC breaks?    | no     <!-- see https://symfony.com/bc -->
| Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| Tests pass?   | yes    <!-- please add some, will be required by reviewers -->
| Fixed tickets | n/a
| License       | MIT
| Doc PR        | n/a

Commits
-------

692a6e7 Remove unneeded phpdocs
  • Loading branch information
nicolas-grekas committed Aug 8, 2019
2 parents 2273de0 + 692a6e7 commit 53b2c43
Show file tree
Hide file tree
Showing 175 changed files with 266 additions and 655 deletions.
Expand Up @@ -45,8 +45,7 @@ public function __construct(ManagerRegistry $registry)
/**
* Adds the stack logger for a connection.
*
* @param string $name
* @param DebugStack $logger
* @param string $name
*/
public function addLogger($name, DebugStack $logger)
{
Expand Down
Expand Up @@ -171,8 +171,7 @@ protected function getMappingDriverBundleConfigDefaults(array $bundleConfig, \Re
/**
* Register all the collected mapping information with the object manager by registering the appropriate mapping drivers.
*
* @param array $objectManager
* @param ContainerBuilder $container A ContainerBuilder instance
* @param array $objectManager
*/
protected function registerMappingDrivers($objectManager, ContainerBuilder $container)
{
Expand Down Expand Up @@ -251,8 +250,7 @@ protected function assertValidMappingConfiguration(array $mappingConfig, $object
/**
* Detects what metadata driver to use for the supplied directory.
*
* @param string $dir A directory path
* @param ContainerBuilder $container A ContainerBuilder instance
* @param string $dir A directory path
*
* @return string|null A metadata driver short name, if one can be detected
*/
Expand Down Expand Up @@ -285,9 +283,8 @@ protected function detectMetadataDriver($dir, ContainerBuilder $container)
/**
* Loads a configured object manager metadata, query or result cache driver.
*
* @param array $objectManager A configured object manager
* @param ContainerBuilder $container A ContainerBuilder instance
* @param string $cacheName
* @param array $objectManager A configured object manager
* @param string $cacheName
*
* @throws \InvalidArgumentException in case of unknown driver type
*/
Expand All @@ -299,10 +296,9 @@ protected function loadObjectManagerCacheDriver(array $objectManager, ContainerB
/**
* Loads a cache driver.
*
* @param string $cacheName The cache driver name
* @param string $objectManagerName The object manager name
* @param array $cacheDriver The cache driver mapping
* @param ContainerBuilder $container The ContainerBuilder instance
* @param string $cacheName The cache driver name
* @param string $objectManagerName The object manager name
* @param array $cacheDriver The cache driver mapping
*
* @return string
*
Expand Down
Expand Up @@ -40,10 +40,7 @@ class DoctrineChoiceLoader implements ChoiceLoaderInterface
* passed which optimizes the object loading for one of the Doctrine
* mapper implementations.
*
* @param ObjectManager $manager The object manager
* @param string $class The class name of the loaded objects
* @param IdReader|null $idReader The reader for the object IDs
* @param EntityLoaderInterface|null $objectLoader The objects loader
* @param string $class The class name of the loaded objects
*/
public function __construct(ObjectManager $manager, string $class, IdReader $idReader = null, EntityLoaderInterface $objectLoader = null)
{
Expand Down
Expand Up @@ -32,11 +32,6 @@ class ORMQueryBuilderLoader implements EntityLoaderInterface
*/
private $queryBuilder;

/**
* Construct an ORM Query Builder Loader.
*
* @param QueryBuilder $queryBuilder The query builder for creating the query builder
*/
public function __construct(QueryBuilder $queryBuilder)
{
$this->queryBuilder = $queryBuilder;
Expand Down
5 changes: 2 additions & 3 deletions src/Symfony/Bridge/Doctrine/Form/Type/DoctrineType.php
Expand Up @@ -265,9 +265,8 @@ public function configureOptions(OptionsResolver $resolver)
/**
* Return the default loader object.
*
* @param ObjectManager $manager
* @param mixed $queryBuilder
* @param string $class
* @param mixed $queryBuilder
* @param string $class
*
* @return EntityLoaderInterface
*/
Expand Down
5 changes: 2 additions & 3 deletions src/Symfony/Bridge/Doctrine/Form/Type/EntityType.php
Expand Up @@ -46,9 +46,8 @@ public function configureOptions(OptionsResolver $resolver)
/**
* Return the default loader object.
*
* @param ObjectManager $manager
* @param QueryBuilder $queryBuilder
* @param string $class
* @param QueryBuilder $queryBuilder
* @param string $class
*
* @return ORMQueryBuilderLoader
*/
Expand Down
2 changes: 0 additions & 2 deletions src/Symfony/Bridge/Doctrine/Test/DoctrineTestHelper.php
Expand Up @@ -31,8 +31,6 @@ class DoctrineTestHelper
/**
* Returns an entity manager for testing.
*
* @param Configuration|null $config
*
* @return EntityManager
*/
public static function createTestEntityManager(Configuration $config = null)
Expand Down
Expand Up @@ -34,8 +34,7 @@ public function __construct(ManagerRegistry $registry)
}

/**
* @param object $entity
* @param Constraint $constraint
* @param object $entity
*
* @throws UnexpectedTypeException
* @throws ConstraintDefinitionException
Expand Down
Expand Up @@ -81,8 +81,7 @@ final protected function ignoreAutoloadException($class, \Exception $exception)
}

/**
* @param string $cacheDir
* @param ArrayAdapter $arrayAdapter
* @param string $cacheDir
*
* @return bool false if there is nothing to warm-up
*/
Expand Down
Expand Up @@ -34,9 +34,7 @@ class TemplateFinder implements TemplateFinderInterface
private $templates;

/**
* @param KernelInterface $kernel A KernelInterface instance
* @param TemplateNameParserInterface $parser A TemplateNameParserInterface instance
* @param string $rootDir The directory where global templates can be stored
* @param string $rootDir The directory where global templates can be stored
*/
public function __construct(KernelInterface $kernel, TemplateNameParserInterface $parser, string $rootDir)
{
Expand Down
Expand Up @@ -133,7 +133,6 @@ abstract protected function describeContainerTags(ContainerBuilder $builder, arr
*
* @param Definition|Alias|object $service
* @param array $options
* @param ContainerBuilder|null $builder
*/
abstract protected function describeContainerService($service, array $options = [], ContainerBuilder $builder = null);

Expand Down Expand Up @@ -224,8 +223,7 @@ protected function formatParameter($value)
}

/**
* @param ContainerBuilder $builder
* @param string $serviceId
* @param string $serviceId
*
* @return mixed
*/
Expand All @@ -249,8 +247,7 @@ protected function resolveServiceDefinition(ContainerBuilder $builder, $serviceI
}

/**
* @param ContainerBuilder $builder
* @param bool $showHidden
* @param bool $showHidden
*
* @return array
*/
Expand Down
Expand Up @@ -46,7 +46,6 @@ public function __construct(UrlGeneratorInterface $router = null, int $httpPort
* In case the route name is empty, the status code will be 404 when permanent is false
* and 410 otherwise.
*
* @param Request $request The request instance
* @param string $route The route name to redirect to
* @param bool $permanent Whether the redirection is permanent
* @param bool|array $ignoreAttributes Whether to ignore attributes or an array of attributes to ignore
Expand Down Expand Up @@ -88,7 +87,6 @@ public function redirectAction(Request $request, string $route, bool $permanent
* In case the path is empty, the status code will be 404 when permanent is false
* and 410 otherwise.
*
* @param Request $request The request instance
* @param string $path The absolute path or URL to redirect to
* @param bool $permanent Whether the redirect is permanent or not
* @param string|null $scheme The URL scheme (null to keep the current one)
Expand Down
Expand Up @@ -29,8 +29,6 @@ trait MicroKernelTrait
*
* $routes->import('config/routing.yml');
* $routes->add('/admin', 'App\Controller\AdminController::dashboard', 'admin_dashboard');
*
* @param RouteCollectionBuilder $routes
*/
abstract protected function configureRoutes(RouteCollectionBuilder $routes);

Expand All @@ -50,9 +48,6 @@ abstract protected function configureRoutes(RouteCollectionBuilder $routes);
* Or parameters:
*
* $c->setParameter('halloween', 'lot of fun');
*
* @param ContainerBuilder $c
* @param LoaderInterface $loader
*/
abstract protected function configureContainer(ContainerBuilder $c, LoaderInterface $loader);

Expand Down
Expand Up @@ -28,9 +28,8 @@ interface EngineInterface extends BaseEngineInterface
/**
* Renders a view and returns a Response.
*
* @param string $view The view name
* @param array $parameters An array of parameters to pass to the view
* @param Response $response A Response instance
* @param string $view The view name
* @param array $parameters An array of parameters to pass to the view
*
* @return Response A Response instance
*
Expand Down
31 changes: 10 additions & 21 deletions src/Symfony/Bundle/FrameworkBundle/Templating/Helper/FormHelper.php
Expand Up @@ -47,7 +47,6 @@ public function getName()
*
* The theme format is "<Bundle>:<Controller>".
*
* @param FormView $view A FormView instance
* @param string|array $themes A theme or an array of theme
* @param bool $useDefaultThemes If true, will use default themes defined in the renderer
*/
Expand Down Expand Up @@ -75,8 +74,7 @@ public function setTheme(FormView $view, $themes, $useDefaultThemes = true)
* form individually. You can also create a custom form theme to adapt
* the look of the form.
*
* @param FormView $view The view for which to render the form
* @param array $variables Additional variables passed to the template
* @param array $variables Additional variables passed to the template
*
* @return string The HTML markup
*/
Expand All @@ -92,8 +90,7 @@ public function form(FormView $view, array $variables = [])
*
* <?php echo $view['form']->start($form) ?>>
*
* @param FormView $view The view for which to render the start tag
* @param array $variables Additional variables passed to the template
* @param array $variables Additional variables passed to the template
*
* @return string The HTML markup
*/
Expand All @@ -109,8 +106,7 @@ public function start(FormView $view, array $variables = [])
*
* <?php echo $view['form']->end($form) ?>>
*
* @param FormView $view The view for which to render the end tag
* @param array $variables Additional variables passed to the template
* @param array $variables Additional variables passed to the template
*
* @return string The HTML markup
*/
Expand All @@ -132,8 +128,7 @@ public function end(FormView $view, array $variables = [])
*
* <?php echo $view['form']->widget($form, ['separator' => '+++++']) ?>
*
* @param FormView $view The view for which to render the widget
* @param array $variables Additional variables passed to the template
* @param array $variables Additional variables passed to the template
*
* @return string The HTML markup
*/
Expand All @@ -145,8 +140,7 @@ public function widget(FormView $view, array $variables = [])
/**
* Renders the entire form field "row".
*
* @param FormView $view The view for which to render the row
* @param array $variables Additional variables passed to the template
* @param array $variables Additional variables passed to the template
*
* @return string The HTML markup
*/
Expand All @@ -158,9 +152,8 @@ public function row(FormView $view, array $variables = [])
/**
* Renders the label of the given view.
*
* @param FormView $view The view for which to render the label
* @param string $label The label
* @param array $variables Additional variables passed to the template
* @param string $label The label
* @param array $variables Additional variables passed to the template
*
* @return string The HTML markup
*/
Expand All @@ -176,8 +169,6 @@ public function label(FormView $view, $label = null, array $variables = [])
/**
* Renders the help of the given view.
*
* @param FormView $view The parent view
*
* @return string The HTML markup
*/
public function help(FormView $view): string
Expand All @@ -198,8 +189,7 @@ public function errors(FormView $view)
/**
* Renders views which have not already been rendered.
*
* @param FormView $view The parent view
* @param array $variables An array of variables
* @param array $variables An array of variables
*
* @return string The HTML markup
*/
Expand All @@ -211,9 +201,8 @@ public function rest(FormView $view, array $variables = [])
/**
* Renders a block of the template.
*
* @param FormView $view The view for determining the used themes
* @param string $blockName The name of the block to render
* @param array $variables The variable to pass to the template
* @param string $blockName The name of the block to render
* @param array $variables The variable to pass to the template
*
* @return string The HTML markup
*/
Expand Down
Expand Up @@ -31,8 +31,7 @@ class TemplateLocator implements FileLocatorInterface
private $cacheHits = [];

/**
* @param FileLocatorInterface $locator A FileLocatorInterface instance
* @param string $cacheDir The cache path
* @param string $cacheDir The cache path
*/
public function __construct(FileLocatorInterface $locator, string $cacheDir = null)
{
Expand Down
Expand Up @@ -98,10 +98,9 @@ final public function addOption($name, $default = null)
* Subclasses must return the id of a service which implements the
* AuthenticationProviderInterface.
*
* @param ContainerBuilder $container
* @param string $id The unique id of the firewall
* @param array $config The options array for this listener
* @param string $userProviderId The id of the user provider
* @param string $id The unique id of the firewall
* @param array $config The options array for this listener
* @param string $userProviderId The id of the user provider
*
* @return string never null, the id of the authentication provider
*/
Expand Down
Expand Up @@ -24,11 +24,10 @@ interface SecurityFactoryInterface
/**
* Configures the container services required to use the authentication listener.
*
* @param ContainerBuilder $container
* @param string $id The unique id of the firewall
* @param array $config The options array for the listener
* @param string $userProvider The service id of the user provider
* @param string $defaultEntryPoint
* @param string $id The unique id of the firewall
* @param array $config The options array for the listener
* @param string $userProvider The service id of the user provider
* @param string $defaultEntryPoint
*
* @return array containing three values:
* - the provider id
Expand Down
Expand Up @@ -33,8 +33,6 @@ public function __construct(TraceableAccessDecisionManager $traceableAccessDecis

/**
* Event dispatched by a voter during access manager decision.
*
* @param VoteEvent $event event with voter data
*/
public function onVoterVote(VoteEvent $event)
{
Expand Down
10 changes: 4 additions & 6 deletions src/Symfony/Bundle/TwigBundle/Controller/ExceptionController.php
Expand Up @@ -36,8 +36,7 @@ class ExceptionController
protected $debug;

/**
* @param Environment $twig
* @param bool $debug Show error (false) or exception (true) pages by default
* @param bool $debug Show error (false) or exception (true) pages by default
*/
public function __construct(Environment $twig, bool $debug)
{
Expand Down Expand Up @@ -92,10 +91,9 @@ protected function getAndCleanOutputBuffering($startObLevel)
}

/**
* @param Request $request
* @param string $format
* @param int $code An HTTP response status code
* @param bool $showException
* @param string $format
* @param int $code An HTTP response status code
* @param bool $showException
*
* @return string
*/
Expand Down

0 comments on commit 53b2c43

Please sign in to comment.