Commit 904b0de0 authored by alexpott's avatar alexpott

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

Issue #2700661 by anoopjohn: Ensure core compliance to Drupal.Commenting.FunctionComment.ParamCommentIndentation (part 1).
parent 1516faf6
......@@ -48,7 +48,7 @@
* have access to the 'administer software updates' permission.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The incoming request.
* The incoming request.
*
* @return bool
* TRUE if the current user can run authorize.php, and FALSE if not.
......
......@@ -1957,34 +1957,34 @@ function hook_queue_info_alter(&$queues) {
*
* @param $message
* An array containing the message data. Keys in this array include:
* - 'id':
* - 'id':
* The MailManagerInterface->mail() id of the message. Look at module source
* code or MailManagerInterface->mail() for possible id values.
* - 'to':
* - 'to':
* The address or addresses the message will be sent to. The
* formatting of this string must comply with RFC 2822.
* - 'from':
* - 'from':
* The address the message will be marked as being from, which is
* either a custom address or the site-wide default email address.
* - 'subject':
* - 'subject':
* Subject of the email to be sent. This must not contain any newline
* characters, or the email may not be sent properly.
* - 'body':
* - 'body':
* An array of strings or objects that implement
* \Drupal\Component\Render\MarkupInterface containing the message text. The
* message body is created by concatenating the individual array strings
* into a single text string using "\n\n" as a separator.
* - 'headers':
* - 'headers':
* Associative array containing mail headers, such as From, Sender,
* MIME-Version, Content-Type, etc.
* - 'params':
* - 'params':
* An array of optional parameters supplied by the caller of
* MailManagerInterface->mail() that is used to build the message before
* hook_mail_alter() is invoked.
* - 'language':
* - 'language':
* The language object used to build the message before hook_mail_alter()
* is invoked.
* - 'send':
* - 'send':
* Set to FALSE to abort sending this email message.
*
* @see \Drupal\Core\Mail\MailManagerInterface::mail()
......
......@@ -120,10 +120,10 @@ function error_displayable($error = NULL) {
* with the exception of @message, which needs to be an HTML string, and
* backtrace, which is a standard PHP backtrace.
* @param bool $fatal
* TRUE for:
* TRUE for:
* - An exception is thrown and not caught by something else.
* - A recoverable fatal error, which is a fatal error.
* Non-recoverable fatal errors cannot be logged by Drupal.
* Non-recoverable fatal errors cannot be logged by Drupal.
*/
function _drupal_log_error($error, $fatal = FALSE) {
$is_installer = drupal_installation_attempted();
......
......@@ -1083,7 +1083,7 @@ function install_verify_completed_task() {
* Verifies that settings.php specifies a valid database connection.
*
* @param string $site_path
* The site path.
* The site path.
*
* @return bool
* TRUE if there are no database errors.
......@@ -1377,7 +1377,7 @@ function install_retrieve_file($uri, $destination) {
* Checks if the localization server can be contacted.
*
* @param string $uri
* The URI to contact.
* The URI to contact.
*
* @return string
* TRUE if the URI was contacted successfully, FALSE if not.
......
......@@ -715,11 +715,11 @@ function drupal_verify_install_file($file, $mask = NULL, $type = 'file') {
* Creates a directory with the specified permissions.
*
* @param $file
* The name of the directory to create;
* The name of the directory to create;
* @param $mask
* The permissions of the directory to create.
* The permissions of the directory to create.
* @param $message
* (optional) Whether to output messages. Defaults to TRUE.
* (optional) Whether to output messages. Defaults to TRUE.
*
* @return
* TRUE/FALSE whether or not the directory was successfully created.
......@@ -764,11 +764,11 @@ function drupal_install_mkdir($file, $mask, $message = TRUE) {
* 0700 and get the correct value of 0500.
*
* @param $file
* The name of the file with permissions to fix.
* The name of the file with permissions to fix.
* @param $mask
* The desired permissions for the file.
* The desired permissions for the file.
* @param $message
* (optional) Whether to output messages. Defaults to TRUE.
* (optional) Whether to output messages. Defaults to TRUE.
*
* @return
* TRUE/FALSE whether or not we were able to fix the file's permissions.
......
......@@ -20,18 +20,18 @@ class MappedDiff extends Diff {
* changes in white-space.
*
* @param $from_lines array An array of strings.
* (Typically these are lines from a file.)
* (Typically these are lines from a file.)
*
* @param $to_lines array An array of strings.
*
* @param $mapped_from_lines array This array should
* have the same size number of elements as $from_lines.
* The elements in $mapped_from_lines and
* $mapped_to_lines are what is actually compared
* when computing the diff.
* have the same size number of elements as $from_lines.
* The elements in $mapped_from_lines and
* $mapped_to_lines are what is actually compared
* when computing the diff.
*
* @param $mapped_to_lines array This array should
* have the same number of elements as $to_lines.
* have the same number of elements as $to_lines.
*/
public function __construct($from_lines, $to_lines, $mapped_from_lines, $mapped_to_lines) {
......
......@@ -134,7 +134,7 @@ public function name($length = 8, $unique = FALSE) {
* Generate a string that looks like a word (letters only, alternating consonants and vowels).
*
* @param int $length
* The desired word length.
* The desired word length.
*
* @return string
*/
......
......@@ -71,7 +71,7 @@ public function getName() {
* Sets the name of this configuration object.
*
* @param string $name
* The name of the configuration object.
* The name of the configuration object.
*
* @return $this
* The configuration object.
......@@ -85,7 +85,7 @@ public function setName($name) {
* Validates the configuration object name.
*
* @param string $name
* The name of the configuration object.
* The name of the configuration object.
*
* @throws \Drupal\Core\Config\ConfigNameException
*
......
......@@ -227,7 +227,7 @@ public function installOptionalConfig(StorageInterface $storage = NULL, $depende
* @param StorageInterface $storage
* The configuration storage to read configuration from.
* @param string $collection
* The configuration collection to use.
* The configuration collection to use.
* @param string $prefix
* (optional) Limit to configuration starting with the provided string.
* @param \Drupal\Core\Config\StorageInterface[] $profile_storages
......
......@@ -196,7 +196,7 @@ protected function checkEngineVersion() {
* Return driver specific configuration options.
*
* @param $database
* An array of driver specific configuration options.
* An array of driver specific configuration options.
*
* @return
* The options form array.
......
......@@ -91,7 +91,7 @@ public function setModuleHandler(ModuleHandlerInterface $module_handler);
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition.
* @param \Drupal\Core\Session\AccountInterface $account
* (optional) The user session for which to check access, or NULL to check
* (optional) The user session for which to check access, or NULL to check
* access for the current user. Defaults to NULL.
* @param \Drupal\Core\Field\FieldItemListInterface $items
* (optional) The field values for which to check access, or NULL if access
......
......@@ -158,7 +158,7 @@ protected function setStaticCache(array $entities) {
*
* @param string $hook
* One of 'presave', 'insert', 'update', 'predelete', 'delete', or
* 'revision_delete'.
* 'revision_delete'.
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity object.
*/
......
......@@ -99,7 +99,7 @@ public function resetCache(array $entities = NULL);
* @param \Drupal\Core\Field\FieldItemListInterface $items
* FieldItemList containing the values to be displayed.
* @param string|array $display_options
* Can be either:
* Can be either:
* - The name of a view mode. The field will be displayed according to the
* display settings specified for this view mode in the $field
* definition for the field in the entity's bundle. If no display settings
......
......@@ -266,7 +266,7 @@ public function getCardinality() {
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* @param int $cardinality
* The field cardinality.
* The field cardinality.
*
* @return $this
*/
......
......@@ -113,7 +113,7 @@ public function onException(GetResponseForExceptionEvent $event) {
* Extracts a form AJAX exception.
*
* @param \Exception $e
* A generic exception that might contain a form AJAX exception.
* A generic exception that might contain a form AJAX exception.
*
* @return \Drupal\Core\Form\FormAjaxException|null
* Either the form AJAX exception, or NULL if none could be found.
......
......@@ -650,8 +650,8 @@ public function renderPlaceholderFormAction() {
* #lazy_builder callback; renders form CSRF token.
*
* @param string $placeholder
* A string containing a placeholder, matching the value of the form's
* #token.
* A string containing a placeholder, matching the value of the form's
* #token.
*
* @return array
* A renderable array containing the CSRF token.
......
......@@ -93,7 +93,7 @@ class MenuLinkTreeElement {
* The depth of this element relative to the tree root.
* @param bool $in_active_trail
* A flag as to whether this link was included in the list of active trail
* IDs used to build the tree.
* IDs used to build the tree.
* @param \Drupal\Core\Menu\MenuLinkTreeElement[] $subtree
* The children of this element in the menu link tree.
*/
......
......@@ -46,7 +46,7 @@ public function get() {
* Sets the private key.
*
* @param string $key
* The private key to set.
* The private key to set.
*/
public function set($key) {
return $this->state->set('system.private_key', $key);
......
......@@ -28,7 +28,7 @@ class CurrentRouteMatch implements ResettableStackedRouteMatchInterface {
* Constructs a CurrentRouteMatch object.
*
* @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
* The request stack.
* The request stack.
*/
public function __construct(RequestStack $request_stack) {
$this->requestStack = $request_stack;
......
......@@ -14,7 +14,7 @@ interface RouteEnhancerInterface extends BaseRouteEnhancerInterface {
* Declares if the route enhancer 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.
......
......@@ -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.
......
......@@ -56,7 +56,7 @@ public function getInfo() {
* rendering to ensure that it is built only if it will be displayed.
*
* @param array $element
* A renderable array.
* A renderable array.
*
* @return array
* A renderable array.
......
......@@ -11,7 +11,7 @@ class TourTestController {
* Outputs some content for testing tours.
*
* @param string $locale
* (optional) Dummy locale variable for testing routing parameters. Defaults
* (optional) Dummy locale variable for testing routing parameters. Defaults
* to 'foo'.
*
* @return array
......
......@@ -304,7 +304,7 @@ function _tracker_calculate_changed($node) {
* Cleans up indexed data when nodes or comments are removed.
*
* @param int $nid
* The node ID.
* The node ID.
* @param int $uid
* The author of the node or comment.
* @param int $changed
......
......@@ -34,7 +34,7 @@ class UpdateManagerUpdate extends FormBase {
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Drupal\Core\State\StateInterface $state
* The state service.
* The state service.
*/
public function __construct(ModuleHandlerInterface $module_handler, StateInterface $state) {
$this->moduleHandler = $module_handler;
......
......@@ -30,7 +30,7 @@ class UpdateRootFactory {
* @param \Drupal\Core\DrupalKernelInterface $drupal_kernel
* The Drupal kernel.
* @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
* The request stack.
* The request stack.
*/
public function __construct(DrupalKernelInterface $drupal_kernel, RequestStack $request_stack) {
$this->drupalKernel = $drupal_kernel;
......
......@@ -101,7 +101,7 @@ public static function create(ContainerInterface $container) {
* Loads and renders a view via AJAX.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The current request object.
* The current request object.
*
* @return \Drupal\views\Ajax\ViewAjaxResponse
* The view response as ajax response.
......
......@@ -93,7 +93,7 @@ public function buildOptionsForm(&$form, FormStateInterface $form_state) {
* Performs any operations needed before full rendering.
*
* @param array $results
* The results of the view.
* The results of the view.
*/
public function preRender(array $results) {
}
......
......@@ -143,11 +143,11 @@ public function query() {
* Add 'additional' fields to the query.
*
* @param $fields
* An array of fields. The key is an identifier used to later find the
* field alias used. The value is either a string in which case it's
* assumed to be a field on this handler's table; or it's an array in the
* form of
* @code array('table' => $tablename, 'field' => $fieldname) @endcode
* An array of fields. The key is an identifier used to later find the
* field alias used. The value is either a string in which case it's
* assumed to be a field on this handler's table; or it's an array in the
* form of
* @code array('table' => $tablename, 'field' => $fieldname) @endcode
*/
protected function addAdditionalFields($fields = NULL) {
if (!isset($fields)) {
......
......@@ -45,7 +45,7 @@ protected function assertIdenticalResultset($view, $expected_result, $column_map
* An expected result set.
* @param array $column_map
* (optional) An associative array mapping the columns of the result set
* from the view (as keys) and the expected result set (as values).
* from the view (as keys) and the expected result set (as values).
* @param string $message
* (optional) A custom message to display with the assertion. Defaults to
* 'Non-identical result set.'
......
......@@ -278,21 +278,21 @@ public static function getDisabledViews() {
* checkboxes and radios as #options.
*
* @param bool $views_only
* If TRUE, only return views, not displays.
* If TRUE, only return views, not displays.
* @param string $filter
* Filters the views on status. Can either be 'all' (default), 'enabled' or
* 'disabled'
* Filters the views on status. Can either be 'all' (default), 'enabled' or
* 'disabled'
* @param mixed $exclude_view
* view or current display to exclude
* either a
* - views object (containing $exclude_view->storage->name and $exclude_view->current_display)
* - views name as string: e.g. my_view
* - views name and display id (separated by ':'): e.g. my_view:default
* view or current display to exclude
* either a
* - views object (containing $exclude_view->storage->name and $exclude_view->current_display)
* - views name as string: e.g. my_view
* - views name and display id (separated by ':'): e.g. my_view:default
* @param bool $optgroup
* If TRUE, returns an array with optgroups for each view (will be ignored for
* $views_only = TRUE). Can be used by select
* If TRUE, returns an array with optgroups for each view (will be ignored for
* $views_only = TRUE). Can be used by select
* @param bool $sort
* If TRUE, the list of views is sorted ascending.
* If TRUE, the list of views is sorted ascending.
*
* @return array
* an associative array for use in select.
......
......@@ -1110,7 +1110,7 @@ class RecursivePlaceholdersTest {
* #lazy_builder callback; bubbles another placeholder.
*
* @param string $animal
* An animal.
* An animal.
*
* @return array
* A renderable array.
......
......@@ -258,7 +258,7 @@ class PlaceholdersTest {
* #lazy_builder callback; attaches setting, generates markup.
*
* @param string $animal
* An animal.
* An animal.
*
* @return array
* A renderable array.
......@@ -282,7 +282,7 @@ public static function callback($animal, $use_animal_as_array_key = FALSE) {
* #lazy_builder callback; attaches setting, generates markup, user-specific.
*
* @param string $animal
* An animal.
* An animal.
*
* @return array
* A renderable array.
......@@ -297,7 +297,7 @@ public static function callbackPerUser($animal) {
* #lazy_builder callback; attaches setting, generates markup, cache tag.
*
* @param string $animal
* An animal.
* An animal.
*
* @return array
* A renderable array.
......