Issue #2783395 by Mile23: Fix 'Drupal.Commenting.FunctionComment.InvalidReturn' coding standard

core/includes/bootstrap.inc

@@ -599,7 +599,7 @@ function _drupal_exception_handler_additional($exception, $exception2) {
  * @param string $new_prefix
  *   Internal use only. A new prefix to be stored.
  *
- * @return string|FALSE
+ * @return string|false
  *   Either the simpletest prefix (the string "simpletest" followed by any
  *   number of digits) or FALSE if the user agent does not contain a valid
  *   HMAC and timestamp.

core/lib/Drupal/Component/PhpStorage/PhpStorageInterface.php

@@ -80,7 +80,7 @@ public function deleteAll();
    * @param string $name
    *   The virtual file name. Can be a relative path.
    *
-   * @return string|FALSE
+   * @return string|false
    *   The full file path for the provided name. Return FALSE if the
    *   implementation needs to prevent access to the file.
    */

core/lib/Drupal/Core/Access/AccessResultReasonInterface.php

@@ -17,7 +17,7 @@ interface AccessResultReasonInterface extends AccessResultInterface {
   /**
    * Gets the reason for this access result.
    *
-   * @return string|NULL
+   * @return string|null
    *   The reason of this access result or NULL if no reason is provided.
    */
   public function getReason();
@@ -25,7 +25,7 @@ public function getReason();
   /**
    * Sets the reason for this access result.
    *
-   * @param $reason string|NULL
+   * @param $reason string|null
    *   The reason of this access result or NULL if no reason is provided.
    *
    * @return \Drupal\Core\Access\AccessResultInterface

core/lib/Drupal/Core/Asset/LibraryDiscoveryInterface.php

@@ -39,7 +39,7 @@ public function getLibrariesByExtension($extension);
    * @param string $name
    *   The name of a registered library to retrieve.
    *
-   * @return array|FALSE
+   * @return array|false
    *   The definition of the requested library, if $name was passed and it
    *   exists, otherwise FALSE.
    */

core/lib/Drupal/Core/Authentication/AuthenticationCollectorInterface.php

@@ -41,7 +41,7 @@ public function isGlobal($provider_id);
    * @param string $provider_id
    *   The provider ID.
    *
-   * @return \Drupal\Core\Authentication\AuthenticationProviderInterface|NULL
+   * @return \Drupal\Core\Authentication\AuthenticationProviderInterface|null
    *   The authentication provider which matches the ID.
    */
   public function getProvider($provider_id);

core/lib/Drupal/Core/Authentication/AuthenticationManager.php

@@ -94,7 +94,7 @@ public function challengeException(Request $request, \Exception $previous) {
    * @param \Symfony\Component\HttpFoundation\Request $request
    *   The incoming request.
    *
-   * @return string|NULL
+   * @return string|null
    *   The id of the first authentication provider which applies to the request.
    *   If no application detects appropriate credentials, then NULL is returned.
    */
@@ -112,7 +112,7 @@ protected function getProvider(Request $request) {
    * @param \Symfony\Component\HttpFoundation\Request $request
    *   The incoming request.
    *
-   * @return string|NULL
+   * @return string|null
    *   The ID of the first authentication provider which applies to the request.
    *   If no application detects appropriate credentials, then NULL is returned.
    */

core/lib/Drupal/Core/Authentication/AuthenticationProviderChallengeInterface.php

@@ -21,7 +21,7 @@ interface AuthenticationProviderChallengeInterface {
    * @param \Exception $previous
    *   The previous exception.
    *
-   * @return \Symfony\Component\HttpKernel\Exception\HttpExceptionInterface|NULL
+   * @return \Symfony\Component\HttpKernel\Exception\HttpExceptionInterface|null
    *   An exception to be used in order to generate an authentication challenge.
    */
   public function challengeException(Request $request, \Exception $previous);

core/lib/Drupal/Core/Authentication/AuthenticationProviderInterface.php

@@ -27,7 +27,7 @@ public function applies(Request $request);
    * @param \Symfony\Component\HttpFoundation\Request|null $request
    *   The request object.
    *
-   * @return \Drupal\Core\Session\AccountInterface|NULL
+   * @return \Drupal\Core\Session\AccountInterface|null
    *   AccountInterface - in case of a successful authentication.
    *   NULL - in case where authentication failed.
    */

core/lib/Drupal/Core/Composer/Composer.php

@@ -196,7 +196,7 @@ public static function vendorTestCodeCleanup(PackageEvent $event) {
    * @param string $package_name
    *   The package name from composer. This is always already lower case.
    *
-   * @return NULL|string
+   * @return string|null
    *   The string key, or NULL if none was found.
    */
   protected static function findPackageKey($package_name) {

core/lib/Drupal/Core/Config/ConfigCollectionInfo.php

@@ -63,7 +63,7 @@ public function getCollectionNames($include_default = TRUE) {
    * @param string $collection
    *   The configuration collection.
    *
-   * @return \Drupal\Core\Config\ConfigFactoryOverrideInterface|NULL
+   * @return \Drupal\Core\Config\ConfigFactoryOverrideInterface|null
    *   The override service responsible for the collection if one exists. NULL
    *   if not.
    */

core/lib/Drupal/Core/Config/Entity/ConfigEntityTypeInterface.php

@@ -65,7 +65,7 @@ public function getConfigPrefix();
   /**
    * Gets the config entity properties to export if declared on the annotation.
    *
-   * @return array|NULL
+   * @return array|null
    *   The properties to export or NULL if they can not be determine from the
    *   config entity type annotation.
    */

core/lib/Drupal/Core/Config/Entity/Query/QueryFactory.php

@@ -189,7 +189,7 @@ protected function getKeys(Config $config, $key, $get_method, ConfigEntityTypeIn
    * @param int $start
    *   Which position of $parts we are processing. Defaults to 0.
    *
-   * @return array|NULL
+   * @return array|null
    *   The array of configuration values the match the provided key. NULL if
    *   the configuration object does not have a value that corresponds to the
    *   key.

core/lib/Drupal/Core/DrupalKernelInterface.php

@@ -58,7 +58,7 @@ public function getContainer();
    *
    * This also allows inspecting a built container for debugging purposes.
    *
-   * @return array|NULL
+   * @return array|null
    *   The cached container definition or NULL if not found in cache.
    */
   public function getCachedContainerDefinition();

core/lib/Drupal/Core/Entity/Controller/EntityController.php

@@ -273,7 +273,7 @@ public function deleteTitle(RouteMatchInterface $route_match, EntityInterface $_
    *   (optional) The entity, set in
    *   \Drupal\Core\Entity\Enhancer\EntityRouteEnhancer.
    *
-   * @return \Drupal\Core\Entity\EntityInterface|NULL
+   * @return \Drupal\Core\Entity\EntityInterface|null
    *   The entity, if it is passed in directly or if the first parameter of the
    *   active route is an entity; otherwise, NULL.
    */

core/lib/Drupal/Core/EventSubscriber/AuthenticationSubscriber.php

@@ -30,14 +30,14 @@ class AuthenticationSubscriber implements EventSubscriberInterface {
   /**
    * Authentication provider filter.
    *
-   * @var \Drupal\Core\Authentication\AuthenticationProviderFilterInterface|NULL
+   * @var \Drupal\Core\Authentication\AuthenticationProviderFilterInterface|null
    */
   protected $filter;
 
   /**
    * Authentication challenge provider.
    *
-   * @var \Drupal\Core\Authentication\AuthenticationProviderChallengeInterface|NULL
+   * @var \Drupal\Core\Authentication\AuthenticationProviderChallengeInterface|null
    */
   protected $challengeProvider;
 

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/OptionsWidgetBase.php

@@ -190,7 +190,7 @@ protected function sanitizeLabel(&$label) {
   /**
    * Returns the empty option label to add to the list of options, if any.
    *
-   * @return string|NULL
+   * @return string|null
    *   Either a label of the empty option, or NULL.
    */
   protected function getEmptyLabel() { }

core/lib/Drupal/Core/Form/EnforcedResponse.php

@@ -37,7 +37,7 @@ class EnforcedResponse extends Response {
    * @param \Exception $e
    *   The exception where the enforced response is to be extracted from.
    *
-   * @return \Drupal\Core\Form\EnforcedResponse|NULL
+   * @return \Drupal\Core\Form\EnforcedResponse|null
    *   The enforced response or NULL if the exception chain does not contain a
    *   \Drupal\Core\Form\EnforcedResponseException exception.
    */

core/lib/Drupal/Core/Menu/MenuActiveTrailInterface.php

@@ -29,7 +29,7 @@ public function getActiveTrailIds($menu_name);
    *   (optional) The menu within which to find the active link. If omitted, all
    *   menus will be searched.
    *
-   * @return \Drupal\Core\Menu\MenuLinkInterface|NULL
+   * @return \Drupal\Core\Menu\MenuLinkInterface|null
    *   The menu link for the given route name, parameters and menu, or NULL if
    *   there is no matching menu link or the current user cannot access the
    *   current page (i.e. we have a 403 response).

core/lib/Drupal/Core/Menu/MenuLinkTreeElement.php

@@ -68,7 +68,7 @@ class MenuLinkTreeElement {
    * If the value is NULL the access was not determined yet, if an access result
    * object, it was determined already.
    *
-   * @var \Drupal\Core\Access\AccessResultInterface|NULL
+   * @var \Drupal\Core\Access\AccessResultInterface|null
    */
   public $access;
 

core/lib/Drupal/Core/Menu/MenuTreeStorageInterface.php

@@ -41,7 +41,7 @@ public function rebuild(array $definitions);
    * @param string $id
    *   The menu link plugin ID.
    *
-   * @return array|FALSE
+   * @return array|false
    *   The plugin definition, or FALSE if no definition was found for the ID.
    */
   public function load($id);