Commit 904b0de0 authored by alexpott's avatar alexpott
Browse files

Issue #2700661 by anoopjohn: Ensure core compliance to...

Issue #2700661 by anoopjohn: Ensure core compliance to Drupal.Commenting.FunctionComment.ParamCommentIndentation (part 1).
parent 1516faf6
......@@ -14,7 +14,7 @@ interface RouteFilterInterface extends BaseRouteFilterInterface {
* Determines if the route filter applies to the given route.
*
* @param \Symfony\Component\Routing\Route $route
* The route to consider attaching to.
* The route to consider attaching to.
*
* @return bool
* TRUE if the check applies to the passed route, FALSE otherwise.
......
......@@ -44,7 +44,7 @@ class RouteMatch implements RouteMatchInterface {
* Constructs a RouteMatch object.
*
* @param string $route_name
* The name of the route.
* The name of the route.
* @param \Symfony\Component\Routing\Route $route
* The route.
* @param array $parameters
......
......@@ -245,10 +245,10 @@ protected function doGenerate(array $variables, array $defaults, array $tokens,
* @param $name
* The route name or other debug message.
* @param \Symfony\Component\Routing\Route $route
* The route object.
* The route object.
* @param array $parameters
* An array of parameters as passed to
* \Symfony\Component\Routing\Generator\UrlGeneratorInterface::generate().
* An array of parameters as passed to
* \Symfony\Component\Routing\Generator\UrlGeneratorInterface::generate().
* @param array $query_params
* An array of query string parameter, which will get any extra values from
* $parameters merged in.
......
......@@ -15,10 +15,10 @@ interface UrlGeneratorInterface extends VersatileGeneratorInterface {
* Gets the internal path (system path) for a route.
*
* @param string|\Symfony\Component\Routing\Route $name
* The route name or a route object.
* The route name or a route object.
* @param array $parameters
* An array of parameters as passed to
* \Symfony\Component\Routing\Generator\UrlGeneratorInterface::generate().
* An array of parameters as passed to
* \Symfony\Component\Routing\Generator\UrlGeneratorInterface::generate().
*
* @return string
* The internal Drupal path corresponding to the route.
......
......@@ -62,9 +62,9 @@ public function get($index);
* @param int $index
* The position of the item in the list. Since a List only contains
* sequential, 0-based indexes, $index has to be:
* - Either the position of an existing item in the list. This updates the
* - Either the position of an existing item in the list. This updates the
* item value.
* - Or the next available position in the sequence of the current list
* - Or the next available position in the sequence of the current list
* indexes. This appends a new item with the provided value at the end of
* the list.
* @param mixed $value
......
......@@ -25,7 +25,7 @@ public function isInstalled();
* Returns the system name of the project.
*
* @param string $directory
* A directory containing a project.
* A directory containing a project.
*/
public static function getProjectName($directory);
......
......@@ -36,7 +36,7 @@
* @param array $data
* An associative array of data objects to be used when generating replacement
* values, as supplied in the $data parameter to
* \Drupal\Core\Utility\Token::replace().
* \Drupal\Core\Utility\Token::replace().
* @param array $options
* An associative array of options for token replacement; see
* \Drupal\Core\Utility\Token::replace() for possible values.
......
......@@ -29,15 +29,15 @@ class BlockedIP extends DestinationBase implements ContainerFactoryPluginInterfa
* Constructs a BlockedIP object.
*
* @param array $configuration
* Plugin configuration.
* Plugin configuration.
* @param string $plugin_id
* The plugin ID.
* The plugin ID.
* @param mixed $plugin_definition
* The plugin definiiton.
* The plugin definiiton.
* @param \Drupal\migrate\Plugin\MigrationInterface $migration
* The current migration.
* The current migration.
* @param \Drupal\ban\BanIpManagerInterface $ban_manager
* The IP manager service.
* The IP manager service.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, BanIpManagerInterface $ban_manager) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
......
......@@ -80,7 +80,7 @@ class BlockForm extends EntityForm {
* @param \Drupal\Core\Language\LanguageManagerInterface $language
* The language manager.
* @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
* The theme handler.
* The theme handler.
*/
public function __construct(EntityManagerInterface $entity_manager, ExecutableManagerInterface $manager, ContextRepositoryInterface $context_repository, LanguageManagerInterface $language, ThemeHandlerInterface $theme_handler) {
$this->storage = $entity_manager->getStorage('block');
......
......@@ -120,7 +120,7 @@ public function renderForm($commented_entity_type_id, $commented_entity_id, $fie
* @param string $langcode
* The language in which the comment entity is being viewed.
* @param bool $is_in_preview
* Whether the comment is currently being previewed.
* Whether the comment is currently being previewed.
*
* @return array
* A renderable array representing the comment links.
......
......@@ -187,7 +187,7 @@ protected function getOverwriteMode(Row $row) {
* API functions (such as file_prepare_directory()).
*
* @param string $uri
* The URI or path.
* The URI or path.
*
* @return string|false
* The directory component of the path or URI, or FALSE if it could not
......@@ -208,9 +208,9 @@ protected function getDirectory($uri) {
* If either URI is a remote stream, will return FALSE.
*
* @param string $source
* The source URI.
* The source URI.
* @param string $destination
* The destination URI.
* The destination URI.
*
* @return bool
* TRUE if the source and destination URIs refer to the same physical path,
......@@ -233,7 +233,7 @@ protected function isLocationUnchanged($source, $destination) {
* \Drupal\Core\StreamWrapper\LocalStream.
*
* @param string $uri
* The URI or path to test.
* The URI or path to test.
*
* @return bool
*/
......
......@@ -47,7 +47,7 @@ class ForumUninstallValidator implements ModuleUninstallValidatorInterface {
* @param \Drupal\Core\Entity\Query\QueryFactory $query_factory
* The entity query factory.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The config factory.
* The config factory.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* The string translation service.
*/
......
......@@ -135,7 +135,7 @@ function previewNodeImage($image, $field_name, $type) {
* @param $type
* The type of node to create.
* @param $alt
* The alt text for the image. Use if the field settings require alt text.
* The alt text for the image. Use if the field settings require alt text.
*/
function uploadNodeImage($image, $field_name, $type, $alt = '') {
$edit = array(
......
......@@ -596,7 +596,7 @@ public function testBlockContextualLinks() {
* test whether it works when we do the authenticatedUser tests. Defaults
* to FALSE.
* @param string $weight
* Menu weight. Defaults to 0.
* Menu weight. Defaults to 0.
*
* @return \Drupal\menu_link_content\Entity\MenuLinkContent
* A menu link entity.
......
......@@ -137,7 +137,7 @@ public function getProcessPlugins(array $process = NULL);
* Returns the initialized destination plugin.
*
* @param bool $stub_being_requested
* TRUE to indicate that this destination will be asked to construct a stub.
* TRUE to indicate that this destination will be asked to construct a stub.
*
* @return \Drupal\migrate\Plugin\MigrateDestinationInterface
* The destination plugin.
......@@ -271,10 +271,10 @@ public function setProcessOfProperty($property, $process_of_property);
*
* @param string $property
* The property of which to merge the passed in process pipeline
* configuration.
* configuration.
* @param array $process_of_property
* The process pipeline configuration to be merged with the existing process
* pipeline configuration.
* pipeline configuration.
*
* @return $this
* The migration entity.
......
......@@ -61,7 +61,7 @@ public function updateType($old_type, $new_type);
* Unsets the language for all nodes with the given language.
*
* @param \Drupal\Core\Language\LanguageInterface $language
* The language object.
* The language object.
*/
public function clearRevisionsLanguage(LanguageInterface $language);
}
......@@ -36,13 +36,13 @@ protected function setUp() {
*
* @dataProvider testNodeTypeDataProvider
* @param string $id
* The node type ID.
* The node type ID.
* @param string $label
* The expected label.
* The expected label.
* @param string $description
* The expected node type description.
* The expected node type description.
* @param string $help
* The expected help text.
* The expected help text.
*/
protected function assertEntity($id, $label, $description, $help, $display_submitted, $new_revision, $body_label = NULL) {
/** @var \Drupal\node\NodeTypeInterface $entity */
......
......@@ -59,7 +59,7 @@ function options_field_storage_config_delete(FieldStorageConfigInterface $field_
* @param \Drupal\Core\Entity\FieldableEntityInterface|NULL $entity
* (optional) The specific entity when this function is called from the
* context of a specific field on a specific entity. This allows custom
* 'allowed_values_function' callbacks to either restrict the values or
* 'allowed_values_function' callbacks to either restrict the values or
* customize the labels for particular bundles and entities. NULL when
* there is not a specific entity available, such as for Views filters.
*
......
......@@ -162,7 +162,7 @@ protected function addTestImageStyleMappings($empty_styles = FALSE) {
* File scheme to use.
* @param bool $empty_styles
* If true, use an empty string for image style names.
* Defaults to false.
* Defaults to false.
*/
protected function doTestResponsiveImageFieldFormatters($scheme, $empty_styles = FALSE) {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
......
......@@ -226,7 +226,7 @@ protected function selectViewMode($entity_type) {
* Creates a referencing and a non-referencing entity for testing purposes.
*
* @param \Drupal\Core\Entity\EntityInterface $referenced_entity
* The entity that the referencing entity should reference.
* The entity that the referencing entity should reference.
*
* @return \Drupal\Core\Entity\EntityInterface[]
* An array containing a referencing entity and a non-referencing entity.
......
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