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
......@@ -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.
......
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