Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[cs] remove unused doc blocks #24931

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fix indentation cs after param docs removal
  • Loading branch information
TomasVotruba committed Nov 12, 2017
commit 69b98b560fa3c5d201751b94031961ea9c36f4c3
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public function __construct(ManagerRegistry $registry)
/**
* Adds the stack logger for a connection.
*
* @param string $name
* @param string $name
*/
public function addLogger($name, DebugStack $logger)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ abstract class AbstractDoctrineExtension extends Extension
protected $drivers = array();

/**
* @param array $objectManager A configured object manager
* @param array $objectManager A configured object manager
*
* @throws \InvalidArgumentException
*/
Expand Down Expand Up @@ -170,7 +170,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 array $objectManager
*/
protected function registerMappingDrivers($objectManager, ContainerBuilder $container)
{
Expand Down Expand Up @@ -248,7 +248,7 @@ protected function assertValidMappingConfiguration(array $mappingConfig, $object
/**
* Detects what metadata driver to use for the supplied directory.
*
* @param string $dir A directory path
* @param string $dir A directory path
*
* @return string|null A metadata driver short name, if one can be detected
*/
Expand Down Expand Up @@ -281,8 +281,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 string $cacheName
* @param array $objectManager A configured object manager
* @param string $cacheName
*
* @throws \InvalidArgumentException in case of unknown driver type
*/
Expand Down
4 changes: 2 additions & 2 deletions 4 src/Symfony/Bridge/Doctrine/Form/Type/DoctrineType.php
Original file line number Diff line number Diff line change
Expand Up @@ -268,8 +268,8 @@ public function configureOptions(OptionsResolver $resolver)
/**
* Return the default loader object.
*
* @param mixed $queryBuilder
* @param string $class
* @param mixed $queryBuilder
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mixed params could be removed as well as mixed does not give any useful information.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather keep this, since mixed type is comming to PHP and it would make easier transition to scalar type, as in string, int etc. before

* @param string $class
*
* @return EntityLoaderInterface
*/
Expand Down
4 changes: 2 additions & 2 deletions 4 src/Symfony/Bridge/Doctrine/Form/Type/EntityType.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ public function configureOptions(OptionsResolver $resolver)
/**
* Return the default loader object.
*
* @param QueryBuilder $queryBuilder
* @param string $class
* @param QueryBuilder $queryBuilder
* @param string $class
*
* @return ORMQueryBuilderLoader
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public function __construct(ManagerRegistry $registry)
}

/**
* @param object $entity
* @param object $entity
*
* @throws UnexpectedTypeException
* @throws ConstraintDefinitionException
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ protected function warmUpPhpArrayAdapter(PhpArrayAdapter $phpArrayAdapter, array
}

/**
* @param string $cacheDir
* @param string $cacheDir
*
* @return bool false if there is nothing to warm-up
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ class AnnotationsCacheWarmer extends AbstractPhpFileCacheWarmer
private $excludeRegexp;

/**
* @param string $phpArrayFile The PHP file where annotations are cached
* @param CacheItemPoolInterface $fallbackPool The pool where runtime-discovered annotations are cached
* @param string $phpArrayFile The PHP file where annotations are cached
* @param CacheItemPoolInterface $fallbackPool The pool where runtime-discovered annotations are cached
*/
public function __construct(Reader $annotationReader, string $phpArrayFile, CacheItemPoolInterface $fallbackPool, string $excludeRegexp = null)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class TemplateFinder implements TemplateFinderInterface
private $templates;

/**
* @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
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ class ValidatorCacheWarmer extends AbstractPhpFileCacheWarmer
private $validatorBuilder;

/**
* @param string $phpArrayFile The PHP file where metadata are cached
* @param CacheItemPoolInterface $fallbackPool The pool where runtime-discovered metadata are cached
* @param string $phpArrayFile The PHP file where metadata are cached
* @param CacheItemPoolInterface $fallbackPool The pool where runtime-discovered metadata are cached
*/
public function __construct(ValidatorBuilderInterface $validatorBuilder, string $phpArrayFile, CacheItemPoolInterface $fallbackPool)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ protected function formatParameter($value)
}

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

/**
* @param bool $showPrivate
* @param bool $showPrivate
*
* @return array
*/
Expand Down
6 changes: 3 additions & 3 deletions 6 src/Symfony/Bundle/FrameworkBundle/HttpCache/HttpCache.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ abstract class HttpCache extends BaseHttpCache
protected $kernel;

/**
* @param string $cacheDir The cache directory (default used if null)
* @param string $cacheDir The cache directory (default used if null)
*/
public function __construct(HttpKernelInterface $kernel, string $cacheDir = null)
{
Expand All @@ -42,8 +42,8 @@ public function __construct(HttpKernelInterface $kernel, string $cacheDir = null
/**
* Forwards the Request to the backend and returns the Response.
*
* @param bool $raw Whether to catch exceptions or not
* @param Response $entry A Response instance (the stale entry if present, null otherwise)
* @param bool $raw Whether to catch exceptions or not
* @param Response $entry A Response instance (the stale entry if present, null otherwise)
*
* @return Response A Response instance
*/
Expand Down
6 changes: 3 additions & 3 deletions 6 src/Symfony/Bundle/FrameworkBundle/Routing/Router.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ class Router extends BaseRouter implements WarmableInterface, ServiceSubscriberI
private $collectedParameters = array();

/**
* @param mixed $resource The main resource to load
* @param array $options An array of options
* @param RequestContext $context The context
* @param mixed $resource The main resource to load
* @param array $options An array of options
* @param RequestContext $context The context
*/
public function __construct(ContainerInterface $container, $resource, array $options = array(), RequestContext $context = null)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class TemplateLocator implements FileLocatorInterface
private $cacheHits = array();

/**
* @param string $cacheDir The cache path
* @param string $cacheDir The cache path
*/
public function __construct(FileLocatorInterface $locator, string $cacheDir = null)
{
Expand Down
8 changes: 4 additions & 4 deletions 8 src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,15 @@ class Translator extends BaseTranslator implements WarmableInterface
private $resources = array();

/**
* Available options:
* Available options:.
*
* * cache_dir: The cache directory (or null to disable caching)
* * debug: Whether to enable debugging or not (false by default)
* * resource_files: List of translation resources available grouped by locale.
*
* @param MessageFormatterInterface $formatter The message formatter
* @param array $loaderIds An array of loader Ids
* @param array $options An array of options
* @param MessageFormatterInterface $formatter The message formatter
* @param array $loaderIds An array of loader Ids
* @param array $options An array of options
*
* @throws InvalidArgumentException
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,9 @@ final public function addOption($name, $default = null)
* Subclasses must return the id of a service which implements the
* AuthenticationProviderInterface.
*
* @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
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class ExceptionController
protected $debug;

/**
* @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 @@ -87,9 +87,9 @@ protected function getAndCleanOutputBuffering($startObLevel)
}

/**
* @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
4 changes: 2 additions & 2 deletions 4 src/Symfony/Bundle/TwigBundle/TemplateIterator.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ class TemplateIterator implements \IteratorAggregate
private $paths;

/**
* @param string $rootDir The directory where global templates can be stored
* @param array $paths Additional Twig paths to warm
* @param string $rootDir The directory where global templates can be stored
* @param array $paths Additional Twig paths to warm
*/
public function __construct(KernelInterface $kernel, string $rootDir, array $paths = array())
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ class WebProfilerExtension extends Extension
/**
* Loads the web profiler configuration.
*
* @param array $configs An array of configuration settings
* @param array $configs An array of configuration settings
*/
public function load(array $configs, ContainerBuilder $container)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public function __construct(Profiler $profiler, Environment $twig, array $templa
/**
* Gets the template name for a given panel.
*
* @param string $panel
* @param string $panel
*
* @return mixed
*
Expand Down
4 changes: 2 additions & 2 deletions 4 src/Symfony/Component/BrowserKit/Client.php
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ protected function doRequestInProcess($request)
unlink($deprecationsFile);
foreach ($deprecations ? unserialize($deprecations) : array() as $deprecation) {
if ($deprecation[0]) {
trigger_error($deprecation[1], E_USER_DEPRECATED);
@trigger_error($deprecation[1], E_USER_DEPRECATED);
} else {
@trigger_error($deprecation[1], E_USER_DEPRECATED);
}
Expand Down Expand Up @@ -584,7 +584,7 @@ protected function getAbsoluteUri($uri)
/**
* Makes a request from a Request object directly.
*
* @param bool $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload())
* @param bool $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload())
*
* @return Crawler
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class CacheDataCollector extends DataCollector implements LateDataCollectorInter
private $instances = array();

/**
* @param string $name
* @param string $name
*/
public function addInstance($name, TraceableAdapter $instance)
{
Expand Down
4 changes: 2 additions & 2 deletions 4 src/Symfony/Component/Console/Helper/DescriptorHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public function __construct()
* * format: string, the output format name
* * raw_text: boolean, sets output type as raw
*
* @param object $object
* @param object $object
*
* @throws InvalidArgumentException when the given format is not supported
*/
Expand All @@ -70,7 +70,7 @@ public function describe(OutputInterface $output, $object, array $options = arra
/**
* Registers a descriptor.
*
* @param string $format
* @param string $format
*
* @return $this
*/
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.