Issue #2105065 by tim.plunkett, dawehner: Standards cleanup for null and other types in API docs

core/includes/install.inc

@@ -365,7 +365,7 @@ function _drupal_rewrite_settings_is_array_index($type) {
  *
  * Makes the new settings global.
  *
- * @param array|NULL $ref
+ * @param array|null $ref
  *   A reference to a nested index in $GLOBALS.
  * @param array|object $variable
  *   The nested value of the setting being copied.

core/lib/Drupal/Core/Breadcrumb/BreadcrumbManager.php

@@ -36,7 +36,7 @@ class BreadcrumbManager implements BreadcrumbBuilderInterface {
    *
    * Set to NULL if the array needs to be re-calculated.
    *
-   * @var array|NULL
+   * @var array|null
    */
   protected $sortedBuilders;
 

core/lib/Drupal/Core/Controller/TitleResolverInterface.php

@@ -22,7 +22,7 @@ interface TitleResolverInterface {
    * @param \Symfony\Component\Routing\Route $route
    *   The route information of the route to fetch the title.
    *
-   * @return string|NULL
+   * @return string|null
    *   The title for the route.
    */
   public function getTitle(Request $request, Route $route);

core/lib/Drupal/Core/Entity/EntityAccessController.php

@@ -100,7 +100,7 @@ public function access(EntityInterface $entity, $operation, $langcode = Language
    * @param array $access
    *   An array of access results of the fired access hook.
    *
-   * @return bool|NULL
+   * @return bool|null
    *   Returns FALSE if access should be denied, TRUE if access should be
    *   granted and NULL if no module denied access.
    */

core/lib/Drupal/Core/HttpKernel.php

@@ -64,7 +64,7 @@ public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQ
     /**
      * Forwards the request to another controller.
      *
-     * @param string|NULL $controller
+     * @param string|null $controller
      *   The controller name (a string like BlogBundle:Post:index).
      * @param array $attributes
      *   An array of request attributes.

core/lib/Drupal/Core/Plugin/DefaultPluginManager.php

@@ -196,7 +196,7 @@ public function clearCachedDefinitions() {
   /**
    * Returns the cached plugin definitions of the decorated discovery class.
    *
-   * @return array|NULL
+   * @return array|null
    *   On success this will return an array of plugin definitions. On failure
    *   this should return NULL, indicating to other methods that this has not
    *   yet been defined. Success with no values should return as an empty array

core/lib/Drupal/Core/Session/AccountInterface.php

@@ -45,7 +45,7 @@ public function hasPermission($permission);
   /**
    * Returns the session ID.
    *
-   * @return string|NULL
+   * @return string|null
    *   The session ID or NULL if this user does not have an active session.
    */
   public function getSessionId();
@@ -53,7 +53,7 @@ public function getSessionId();
   /**
    * Returns the secure session ID.
    *
-   * @return string|NULL
+   * @return string|null
    *   The session ID or NULL if this user does not have an active secure session.
    */
   public function getSecureSessionId();

core/modules/block/block.api.php

@@ -83,7 +83,7 @@ function hook_block_view_BASE_BLOCK_ID_alter(array &$build, \Drupal\block\BlockP
  * @param string $langcode
  *   The language code to perform the access check operation on.
  *
- * @return bool|NULL
+ * @return bool|null
  *   FALSE denies access. TRUE allows access unless another module returns
  *   FALSE. If all modules return NULL, then default access rules from
  *   \Drupal\block\BlockAccessController::checkAccess() are used.

core/modules/edit/lib/Drupal/edit/EditorSelectorInterface.php

@@ -19,12 +19,12 @@ interface EditorSelectorInterface {
    *
    * @param string $formatter_type
    *   The field's formatter type name.
-   * @param \Drupal\Core\Entity\Field\FieldDefinitionInterface $field_definition
+   * @param \Drupal\Core\Entity\Field\FieldDefinitionInterface $instance
    *   The field definition.
    * @param array $items
    *   The field's item values.
    *
-   * @return string|NULL
+   * @return string|null
    *   The editor to use, or NULL to not enable in-place editing.
    */
   public function getEditor($formatter_type, FieldDefinitionInterface $instance, array $items);

core/modules/entity_reference/lib/Drupal/entity_reference/Plugin/entity_reference/selection/SelectionBase.php

@@ -39,7 +39,7 @@ class SelectionBase implements SelectionInterface {
   /**
    * The entity object, or NULL
    *
-   * @var NULL|EntityInterface
+   * @var \Drupal\Core\Entity\EntityInterface|null
    */
   protected $entity;
 

core/modules/locale/lib/Drupal/locale/LocaleConfigManager.php

@@ -301,7 +301,7 @@ public function hasTranslation($name, Language $language) {
    *
    * @param string $langcode
    *   The language code.
-   * @param string|NULL $name
+   * @param string|null $name
    *   Name of the original configuration. Set to NULL to get the name prefix
    *   for all $langcode overrides.
    *

core/modules/locale/locale.module

@@ -596,7 +596,7 @@ function locale_js_alter(&$javascript) {
  *
  * @param array $files
  *   An array of local file paths.
- * @return string|NULL
+ * @return string|null
  *   The filepath to the translation file or NULL if no translation is
  *   applicable.
  */

core/modules/serialization/lib/Drupal/serialization/EntityResolver/EntityResolverInterface.php

@@ -35,7 +35,7 @@ interface EntityResolverInterface {
    * @param string $entity_type
    *   The type of entity being resolved; e.g., 'node' or 'user'.
    *
-   * @return string|NULL
+   * @return string|null
    *   Returns the local entity ID, if found. Otherwise, returns NULL.
    */
   public function resolve(NormalizerInterface $normalizer, $data, $entity_type);

core/modules/system/entity.api.php

@@ -719,7 +719,7 @@ function hook_entity_operation_alter(array &$operations, \Drupal\Core\Entity\Ent
  *   (optional) The entity field object on which the operation is to be
  *   performed.
  *
- * @return bool|NULL
+ * @return bool|null
  *   TRUE if access should be allowed, FALSE if access should be denied and NULL
  *   if the implementation has no opinion.
  */

core/modules/views/lib/Drupal/views/Plugin/entity_reference/selection/ViewsSelection.php

@@ -36,7 +36,7 @@ class ViewsSelection implements SelectionInterface {
   /**
    * The entity object, or NULL
    *
-   * @var NULL|EntityInterface
+   * @var \Drupal\Core\Entity\EntityInterface|null
    */
   protected $entity;
 

core/modules/views/lib/Drupal/views/Plugin/views/display/DisplayPluginBase.php

@@ -2768,7 +2768,7 @@ public function getSpecialBlocks() {
   /**
    * Render the exposed form as block.
    *
-   * @return string|NULL
+   * @return string|null
    *  The rendered exposed form as string or NULL otherwise.
    */
   public function viewExposedFormBlocks() {

core/modules/views/lib/Drupal/views/ViewExecutable.php

@@ -1288,7 +1288,7 @@ public function execute($display_id = NULL) {
    * @param string $display_id
    *   The machine name of the display, which should be rendered.
    *
-   * @return (string|NULL)
+   * @return string|null
    *   Return the output of the rendered view or NULL if something failed in the process.
    */
   public function render($display_id = NULL) {