Commit 69edc2a3 authored by catch's avatar catch

Issue #2903908 by mfernea, martin107: Fix...

Issue #2903908 by mfernea, martin107: Fix 'Drupal.Commenting.FunctionComment.ParamCommentIndentation' coding standard
parent 297c35eb
...@@ -321,9 +321,9 @@ public function __call($method, $args) { ...@@ -321,9 +321,9 @@ public function __call($method, $args) {
* Returns the difference between two DateTimePlus objects. * Returns the difference between two DateTimePlus objects.
* *
* @param \Drupal\Component\Datetime\DateTimePlus|\DateTime $datetime2 * @param \Drupal\Component\Datetime\DateTimePlus|\DateTime $datetime2
* The date to compare to. * The date to compare to.
* @param bool $absolute * @param bool $absolute
* Should the interval be forced to be positive? * Should the interval be forced to be positive?
* *
* @return \DateInterval * @return \DateInterval
* A DateInterval object representing the difference between the two dates. * A DateInterval object representing the difference between the two dates.
......
...@@ -29,7 +29,7 @@ class MappedDiff extends Diff { ...@@ -29,7 +29,7 @@ class MappedDiff extends Diff {
* The elements in $mapped_from_lines and $mapped_to_lines are what is * The elements in $mapped_from_lines and $mapped_to_lines are what is
* actually compared when computing the diff. * actually compared when computing the diff.
* @param array $mapped_to_lines * @param array $mapped_to_lines
* This array should have the same number of elements as $to_lines. * This array should have the same number of elements as $to_lines.
*/ */
public function __construct($from_lines, $to_lines, $mapped_from_lines, $mapped_to_lines) { public function __construct($from_lines, $to_lines, $mapped_from_lines, $mapped_to_lines) {
......
...@@ -44,7 +44,7 @@ public function load($name); ...@@ -44,7 +44,7 @@ public function load($name);
* @param string $name * @param string $name
* The virtual file name. Can be a relative path. * The virtual file name. Can be a relative path.
* @param string $code * @param string $code
* The PHP code to be saved. * The PHP code to be saved.
* *
* @return bool * @return bool
* TRUE if the save succeeded, FALSE if it failed. * TRUE if the save succeeded, FALSE if it failed.
......
...@@ -20,9 +20,9 @@ class Cache { ...@@ -20,9 +20,9 @@ class Cache {
* Merges arrays of cache contexts and removes duplicates. * Merges arrays of cache contexts and removes duplicates.
* *
* @param array $a * @param array $a
* Cache contexts array to merge. * Cache contexts array to merge.
* @param array $b * @param array $b
* Cache contexts array to merge. * Cache contexts array to merge.
* *
* @return string[] * @return string[]
* The merged array of cache contexts. * The merged array of cache contexts.
...@@ -46,9 +46,9 @@ public static function mergeContexts(array $a = [], array $b = []) { ...@@ -46,9 +46,9 @@ public static function mergeContexts(array $a = [], array $b = []) {
* they're constituted from. * they're constituted from.
* *
* @param array $a * @param array $a
* Cache tags array to merge. * Cache tags array to merge.
* @param array $b * @param array $b
* Cache tags array to merge. * Cache tags array to merge.
* *
* @return string[] * @return string[]
* The merged array of cache tags. * The merged array of cache tags.
...@@ -67,9 +67,9 @@ public static function mergeTags(array $a = [], array $b = []) { ...@@ -67,9 +67,9 @@ public static function mergeTags(array $a = [], array $b = []) {
* Ensures infinite max-age (Cache::PERMANENT) is taken into account. * Ensures infinite max-age (Cache::PERMANENT) is taken into account.
* *
* @param int $a * @param int $a
* Max age value to merge. * Max age value to merge.
* @param int $b * @param int $b
* Max age value to merge. * Max age value to merge.
* *
* @return int * @return int
* The minimum max-age value. * The minimum max-age value.
......
...@@ -81,7 +81,7 @@ class Cron implements CronInterface { ...@@ -81,7 +81,7 @@ class Cron implements CronInterface {
* @param \Drupal\Core\State\StateInterface $state * @param \Drupal\Core\State\StateInterface $state
* The state service. * The state service.
* @param \Drupal\Core\Session\AccountSwitcherInterface $account_switcher * @param \Drupal\Core\Session\AccountSwitcherInterface $account_switcher
* The account switching service. * The account switching service.
* @param \Psr\Log\LoggerInterface $logger * @param \Psr\Log\LoggerInterface $logger
* A logger instance. * A logger instance.
* @param \Drupal\Core\Queue\QueueWorkerManagerInterface $queue_manager * @param \Drupal\Core\Queue\QueueWorkerManagerInterface $queue_manager
......
...@@ -297,9 +297,9 @@ protected function createTableSql($name, $table) { ...@@ -297,9 +297,9 @@ protected function createTableSql($name, $table) {
* function it has to be processed by _db_process_field(). * function it has to be processed by _db_process_field().
* *
* @param $name * @param $name
* Name of the field. * Name of the field.
* @param $spec * @param $spec
* The field specification, as per the schema data structure format. * The field specification, as per the schema data structure format.
*/ */
protected function createFieldSql($name, $spec) { protected function createFieldSql($name, $spec) {
// The PostgreSQL server converts names into lowercase, unless quoted. // The PostgreSQL server converts names into lowercase, unless quoted.
......
...@@ -149,9 +149,9 @@ protected function processField($field) { ...@@ -149,9 +149,9 @@ protected function processField($field) {
* to be processed by db_processField(). * to be processed by db_processField().
* *
* @param $name * @param $name
* Name of the field. * Name of the field.
* @param $spec * @param $spec
* The field specification, as per the schema data structure format. * The field specification, as per the schema data structure format.
*/ */
protected function createFieldSql($name, $spec) { protected function createFieldSql($name, $spec) {
if (!empty($spec['auto_increment'])) { if (!empty($spec['auto_increment'])) {
......
...@@ -25,7 +25,7 @@ class PsrResponseSubscriber implements EventSubscriberInterface { ...@@ -25,7 +25,7 @@ class PsrResponseSubscriber implements EventSubscriberInterface {
* Constructs a new PathRootsSubscriber instance. * Constructs a new PathRootsSubscriber instance.
* *
* @param \Symfony\Bridge\PsrHttpMessage\HttpFoundationFactoryInterface $http_foundation_factory * @param \Symfony\Bridge\PsrHttpMessage\HttpFoundationFactoryInterface $http_foundation_factory
* The httpFoundation factory. * The httpFoundation factory.
*/ */
public function __construct(HttpFoundationFactoryInterface $http_foundation_factory) { public function __construct(HttpFoundationFactoryInterface $http_foundation_factory) {
$this->httpFoundationFactory = $http_foundation_factory; $this->httpFoundationFactory = $http_foundation_factory;
......
...@@ -158,7 +158,7 @@ public function prepareView(array $entities_items) { ...@@ -158,7 +158,7 @@ public function prepareView(array $entities_items) {
* Returns whether the entity referenced by an item needs to be loaded. * Returns whether the entity referenced by an item needs to be loaded.
* *
* @param \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $item * @param \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $item
* The item to check. * The item to check.
* *
* @return bool * @return bool
* TRUE if the entity needs to be loaded. * TRUE if the entity needs to be loaded.
...@@ -175,7 +175,7 @@ protected function needsEntityLoad(EntityReferenceItem $item) { ...@@ -175,7 +175,7 @@ protected function needsEntityLoad(EntityReferenceItem $item) {
* granting access. * granting access.
* *
* @param \Drupal\Core\Entity\EntityInterface $entity * @param \Drupal\Core\Entity\EntityInterface $entity
* The entity to check. * The entity to check.
* *
* @return \Drupal\Core\Access\AccessResult * @return \Drupal\Core\Access\AccessResult
* A cacheable access result. * A cacheable access result.
......
...@@ -376,7 +376,7 @@ public function getConfigOverrideLanguage() { ...@@ -376,7 +376,7 @@ public function getConfigOverrideLanguage() {
* The locked languages are removed by default. * The locked languages are removed by default.
* *
* @param \Drupal\Core\Language\LanguageInterface[] $languages * @param \Drupal\Core\Language\LanguageInterface[] $languages
* Array with languages to be filtered. * Array with languages to be filtered.
* @param int $flags * @param int $flags
* (optional) Specifies the state of the languages that have to be returned. * (optional) Specifies the state of the languages that have to be returned.
* It can be: LanguageInterface::STATE_CONFIGURABLE, * It can be: LanguageInterface::STATE_CONFIGURABLE,
......
...@@ -283,8 +283,8 @@ public function scan($text) { ...@@ -283,8 +283,8 @@ public function scan($text) {
* modules require special formatting of token text, for example URL * modules require special formatting of token text, for example URL
* encoding or truncation to a specific length. * encoding or truncation to a specific length.
* @param \Drupal\Core\Render\BubbleableMetadata $bubbleable_metadata * @param \Drupal\Core\Render\BubbleableMetadata $bubbleable_metadata
* The bubbleable metadata. This is passed to the token replacement * The bubbleable metadata. This is passed to the token replacement
* implementations so that they can attach their metadata. * implementations so that they can attach their metadata.
* *
* @return array * @return array
* An associative array of replacement values, keyed by the original 'raw' * An associative array of replacement values, keyed by the original 'raw'
......
...@@ -25,7 +25,7 @@ class AggregatorController extends ControllerBase { ...@@ -25,7 +25,7 @@ class AggregatorController extends ControllerBase {
* Constructs a \Drupal\aggregator\Controller\AggregatorController object. * Constructs a \Drupal\aggregator\Controller\AggregatorController object.
* *
* @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
* The date formatter service. * The date formatter service.
*/ */
public function __construct(DateFormatterInterface $date_formatter) { public function __construct(DateFormatterInterface $date_formatter) {
$this->dateFormatter = $date_formatter; $this->dateFormatter = $date_formatter;
......
...@@ -24,7 +24,7 @@ class ContextualController implements ContainerInjectionInterface { ...@@ -24,7 +24,7 @@ class ContextualController implements ContainerInjectionInterface {
* Constructors a new ContextualController * Constructors a new ContextualController
* *
* @param \Drupal\Core\Render\RendererInterface $renderer * @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer. * The renderer.
*/ */
public function __construct(RendererInterface $renderer) { public function __construct(RendererInterface $renderer) {
$this->renderer = $renderer; $this->renderer = $renderer;
......
...@@ -74,7 +74,7 @@ class LanguageNegotiator implements LanguageNegotiatorInterface { ...@@ -74,7 +74,7 @@ class LanguageNegotiator implements LanguageNegotiatorInterface {
* Constructs a new LanguageNegotiator object. * Constructs a new LanguageNegotiator object.
* *
* @param \Drupal\language\ConfigurableLanguageManagerInterface $language_manager * @param \Drupal\language\ConfigurableLanguageManagerInterface $language_manager
* The language manager. * The language manager.
* @param \Drupal\Component\Plugin\PluginManagerInterface $negotiator_manager * @param \Drupal\Component\Plugin\PluginManagerInterface $negotiator_manager
* The language negotiation methods plugin manager * The language negotiation methods plugin manager
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
......
...@@ -31,11 +31,11 @@ public function checkAll(AccountInterface $account); ...@@ -31,11 +31,11 @@ public function checkAll(AccountInterface $account);
* @param array $tables * @param array $tables
* A list of tables that need to be part of the alter. * A list of tables that need to be part of the alter.
* @param string $op * @param string $op
* The operation to be performed on the node. Possible values are: * The operation to be performed on the node. Possible values are:
* - "view" * - "view"
* - "update" * - "update"
* - "delete" * - "delete"
* - "create" * - "create"
* @param \Drupal\Core\Session\AccountInterface $account * @param \Drupal\Core\Session\AccountInterface $account
* A user object representing the user for whom the operation is to be * A user object representing the user for whom the operation is to be
* performed. * performed.
......
...@@ -214,13 +214,13 @@ public function sanitizeValue($value, $type = NULL) { ...@@ -214,13 +214,13 @@ public function sanitizeValue($value, $type = NULL) {
* Transform a string by a certain method. * Transform a string by a certain method.
* *
* @param $string * @param $string
* The input you want to transform. * The input you want to transform.
* @param $option * @param $option
* How do you want to transform it, possible values: * How do you want to transform it, possible values:
* - upper: Uppercase the string. * - upper: Uppercase the string.
* - lower: lowercase the string. * - lower: lowercase the string.
* - ucfirst: Make the first char uppercase. * - ucfirst: Make the first char uppercase.
* - ucwords: Make each word in the string uppercase. * - ucwords: Make each word in the string uppercase.
* *
* @return string * @return string
* The transformed string. * The transformed string.
......
...@@ -46,7 +46,7 @@ class EntityOperations extends FieldPluginBase { ...@@ -46,7 +46,7 @@ class EntityOperations extends FieldPluginBase {
* @param array $plugin_definition * @param array $plugin_definition
* The plugin implementation definition. * The plugin implementation definition.
* @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
* The entity manager. * The entity manager.
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager. * The language manager.
*/ */
......
...@@ -46,7 +46,7 @@ class RenderedEntity extends FieldPluginBase implements CacheableDependencyInter ...@@ -46,7 +46,7 @@ class RenderedEntity extends FieldPluginBase implements CacheableDependencyInter
* @param array $plugin_definition * @param array $plugin_definition
* The plugin implementation definition. * The plugin implementation definition.
* @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
* The entity manager. * The entity manager.
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager. * The language manager.
*/ */
......
...@@ -385,7 +385,7 @@ public function validateOptionsForm(&$form, FormStateInterface $form_state) { ...@@ -385,7 +385,7 @@ public function validateOptionsForm(&$form, FormStateInterface $form_state) {
* @param \Drupal\Core\Form\FormStateInterface $form_state * @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form. * The current state of the form.
* @param string $type * @param string $type
* The display type, either block or page. * The display type, either block or page.
*/ */
public function wizardForm(&$form, FormStateInterface $form_state, $type) { public function wizardForm(&$form, FormStateInterface $form_state, $type) {
} }
...@@ -788,7 +788,7 @@ public function getField($index, $field) { ...@@ -788,7 +788,7 @@ public function getField($index, $field) {
* @param $index * @param $index
* The index count of the row. * The index count of the row.
* @param $field * @param $field
* The id of the field. * The id of the field.
*/ */
public function getFieldValue($index, $field) { public function getFieldValue($index, $field) {
$this->view->row_index = $index; $this->view->row_index = $index;
......
...@@ -1338,8 +1338,8 @@ public function build($display_id = NULL) { ...@@ -1338,8 +1338,8 @@ public function build($display_id = NULL) {
* @todo Some filter needs this function, even it is internal. * @todo Some filter needs this function, even it is internal.
* *
* @param string $key * @param string $key
* The type of handlers (filter etc.) which should be iterated over to * The type of handlers (filter etc.) which should be iterated over to build
* build the relationship and query information. * the relationship and query information.
*/ */
public function _build($key) { public function _build($key) {
$handlers = &$this->$key; $handlers = &$this->$key;
......
...@@ -544,11 +544,11 @@ function hook_field_views_data(\Drupal\field\FieldStorageConfigInterface $field_ ...@@ -544,11 +544,11 @@ function hook_field_views_data(\Drupal\field\FieldStorageConfigInterface $field_
* default data that views_field_default_views_data() supplies for the * default data that views_field_default_views_data() supplies for the
* field storage. * field storage.
* *
* @param array $data * @param array $data
* The views data for the field storage. This has the same format as the * The views data for the field storage. This has the same format as the
* return value of hook_views_data(). * return value of hook_views_data().
* @param \Drupal\field\FieldStorageConfigInterface $field_storage * @param \Drupal\field\FieldStorageConfigInterface $field_storage
* The field storage config entity. * The field storage config entity.
* *
* @see views_views_data() * @see views_views_data()
* @see hook_field_views_data() * @see hook_field_views_data()
......
...@@ -60,7 +60,6 @@ ...@@ -60,7 +60,6 @@
<exclude name="Drupal.Commenting.FunctionComment.MissingReturnComment"/> <exclude name="Drupal.Commenting.FunctionComment.MissingReturnComment"/>
<exclude name="Drupal.Commenting.FunctionComment.MissingReturnType"/> <exclude name="Drupal.Commenting.FunctionComment.MissingReturnType"/>
<exclude name="Drupal.Commenting.FunctionComment.ParamCommentFullStop"/> <exclude name="Drupal.Commenting.FunctionComment.ParamCommentFullStop"/>
<exclude name="Drupal.Commenting.FunctionComment.ParamCommentIndentation"/>
<exclude name="Drupal.Commenting.FunctionComment.ParamMissingDefinition"/> <exclude name="Drupal.Commenting.FunctionComment.ParamMissingDefinition"/>
<exclude name="Drupal.Commenting.FunctionComment.TypeHintMissing"/> <exclude name="Drupal.Commenting.FunctionComment.TypeHintMissing"/>
</rule> </rule>
......
...@@ -391,11 +391,11 @@ public static function providerTestIsExternal() { ...@@ -391,11 +391,11 @@ public static function providerTestIsExternal() {
* @covers ::filterBadProtocol * @covers ::filterBadProtocol
* *
* @param string $uri * @param string $uri
* Protocol URI. * Protocol URI.
* @param string $expected * @param string $expected
* Expected escaped value. * Expected escaped value.
* @param array $protocols * @param array $protocols
* Protocols to allow. * Protocols to allow.
*/ */
public function testFilterBadProtocol($uri, $expected, $protocols) { public function testFilterBadProtocol($uri, $expected, $protocols) {
UrlHelper::setAllowedProtocols($protocols); UrlHelper::setAllowedProtocols($protocols);
...@@ -430,11 +430,11 @@ public static function providerTestFilterBadProtocol() { ...@@ -430,11 +430,11 @@ public static function providerTestFilterBadProtocol() {
* @covers ::stripDangerousProtocols * @covers ::stripDangerousProtocols
* *
* @param string $uri * @param string $uri
* Protocol URI. * Protocol URI.
* @param string $expected * @param string $expected
* Expected escaped value. * Expected escaped value.
* @param array $protocols * @param array $protocols
* Protocols to allow. * Protocols to allow.
*/ */
public function testStripDangerousProtocols($uri, $expected, $protocols) { public function testStripDangerousProtocols($uri, $expected, $protocols) {
UrlHelper::setAllowedProtocols($protocols); UrlHelper::setAllowedProtocols($protocols);
......
...@@ -77,7 +77,7 @@ public function testDoesNotConvertControllerResult() { ...@@ -77,7 +77,7 @@ public function testDoesNotConvertControllerResult() {
* Sets up an alias event that return $controllerResult. * Sets up an alias event that return $controllerResult.
* *
* @param mixed $controller_result * @param mixed $controller_result
* The return Object. * The return Object.
* *
* @return \Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent|\PHPUnit_Framework_MockObject_MockObject * @return \Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent|\PHPUnit_Framework_MockObject_MockObject
* A mock object to test. * A mock object to test.
......
...@@ -128,7 +128,7 @@ function twig_render_template($template_file, array $variables) { ...@@ -128,7 +128,7 @@ function twig_render_template($template_file, array $variables) {
* *
* @param array|object $element * @param array|object $element
* The parent renderable array to exclude the child items. * The parent renderable array to exclude the child items.
* @param string[] $args, ... * @param string[] ...
* The string keys of $element to prevent printing. * The string keys of $element to prevent printing.
* *
* @return array * @return array
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment