Merge branch '3487154-fix-drupal.commenting.functioncomment.missingreturncomment-in' into '11.x'

Config and Entity

See merge request !10165

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

@@ -58,6 +58,7 @@ public function loadCheck($service_id);
    * A list of checks that needs the request.
    *
    * @return array
+   *   Array of access checks which will only be run on the incoming request.
    */
   public function getChecksNeedRequest();
 

core/lib/Drupal/Core/Action/ActionPluginCollection.php

@@ -14,6 +14,7 @@ class ActionPluginCollection extends DefaultSingleLazyPluginCollection {
    *
    * @return \Drupal\Core\Action\ActionInterface
    */
+  // phpcs:ignore Drupal.Commenting.FunctionComment.MissingReturnComment
   public function &get($instance_id) {
     return parent::get($instance_id);
   }

core/lib/Drupal/Core/Ajax/OpenDialogCommand.php

@@ -92,6 +92,8 @@ public function __construct($selector, string|\Stringable|null $title, $content,
    * Returns the dialog options.
    *
    * @return array
+   *   An array of the dialog-specific options passed directly to jQuery UI
+   *   dialogs.
    */
   public function getDialogOptions() {
     return $this->dialogOptions;

core/lib/Drupal/Core/Annotation/ContextDefinition.php

@@ -155,6 +155,7 @@ protected function getDefinitionClass(array $values) {
    * Returns the value of an annotation.
    *
    * @return \Drupal\Core\Plugin\Context\ContextDefinitionInterface
+   *   The context definition object.
    */
   public function get() {
     return $this->definition;

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

@@ -41,6 +41,7 @@ public function setLibraries(array $libraries);
    * Returns the asset libraries attached to the current response.
    *
    * @return string[]
+   *   A list of libraries attached to this response.
    */
   public function getLibraries();
 
@@ -58,6 +59,7 @@ public function setSettings(array $settings);
    * Returns the settings attached to the current response.
    *
    * @return array
+   *   An array of the settings attached to the current response.
    */
   public function getSettings();
 
@@ -75,6 +77,7 @@ public function setAlreadyLoadedLibraries(array $libraries);
    * Returns the set of already loaded asset libraries.
    *
    * @return string[]
+   *   A list of the loaded libraries.
    */
   public function getAlreadyLoadedLibraries();
 

core/lib/Drupal/Core/Block/BlockPluginTrait.php

@@ -270,6 +270,7 @@ public function getPreviewFallbackString() {
    * Wraps the transliteration service.
    *
    * @return \Drupal\Component\Transliteration\TransliterationInterface
+   *   The transliteration service.
    */
   protected function transliteration() {
     if (!$this->transliteration) {

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

@@ -25,6 +25,7 @@ class Breadcrumb implements RenderableInterface, RefinableCacheableDependencyInt
    * Gets the breadcrumb links.
    *
    * @return \Drupal\Core\Link[]
+   *   An ordered list of the links for the breadcrumb.
    */
   public function getLinks() {
     return $this->links;

core/lib/Drupal/Core/Cache/ApcuBackend.php

@@ -273,6 +273,7 @@ public function invalidateAll() {
    *   The type to list. Either pass in APC_LIST_ACTIVE or APC_LIST_DELETED.
    *
    * @return \APCUIterator
+   *   An APCUIterator class.
    */
   protected function getIterator($search = NULL, $format = APC_ITER_ALL, $chunk_size = 100, $list = APC_LIST_ACTIVE) {
     return new \APCUIterator($search, $format, $chunk_size, $list);

core/lib/Drupal/Core/Cache/CacheCollector.php

@@ -122,6 +122,7 @@ public function __construct($cid, CacheBackendInterface $cache, LockBackendInter
    * Gets the cache ID.
    *
    * @return string
+   *   The cache ID.
    */
   protected function getCid() {
     return $this->cid;

core/lib/Drupal/Core/Cache/CacheableResponseInterface.php

@@ -31,6 +31,7 @@ public function addCacheableDependency($dependency);
    * Returns the cacheability metadata for this response.
    *
    * @return \Drupal\Core\Cache\CacheableMetadata
+   *   The cacheable metadata.
    */
   public function getCacheableMetadata();
 

core/lib/Drupal/Core/Cache/DatabaseBackend.php

@@ -566,9 +566,10 @@ public function schemaDefinition() {
   }
 
   /**
-   * The maximum number of rows that this cache bin table is allowed to store.
+   * Gets the maximum number of rows for this cache bin table.
    *
    * @return int
+   *   The maximum number of rows that this cache bin table is allowed to store.
    */
   public function getMaxRows() {
     return $this->maxRows;

core/lib/Drupal/Core/Cache/PhpBackend.php

@@ -79,6 +79,7 @@ public function get($cid, $allow_invalid = FALSE) {
    *   has been invalidated.
    *
    * @return bool|mixed
+   *   The requested cached item. Defaults to FALSE when the cache is not set.
    */
   protected function getByHash($cidhash, $allow_invalid = FALSE) {
     if ($file = $this->storage()->getFullPath($cidhash)) {
@@ -260,6 +261,7 @@ protected function writeItem($cidhash, \stdClass $item) {
    * Gets the PHP code storage object to use.
    *
    * @return \Drupal\Component\PhpStorage\PhpStorageInterface
+   *   The PHP storage.
    */
   protected function storage() {
     if (!isset($this->storage)) {

core/lib/Drupal/Core/Command/DbCommandBase.php

@@ -28,6 +28,7 @@ protected function configure(): void {
    *   Input object.
    *
    * @return \Drupal\Core\Database\Connection
+   *   The database connection.
    */
   protected function getDatabaseConnection(InputInterface $input) {
     // Load connection from a URL.

core/lib/Drupal/Core/Command/GenerateTheme.php

@@ -207,6 +207,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
    * Generates a path to a temporary location.
    *
    * @return string
+   *   A temporary path.
    */
   private function getUniqueTmpDirPath(): string {
     return sys_get_temp_dir() . '/drupal-starterkit-theme-' . uniqid(md5(microtime()), TRUE);
@@ -219,6 +220,7 @@ private function getUniqueTmpDirPath(): string {
    *   The machine name of the theme.
    *
    * @return \Drupal\Core\Extension\Extension|null
+   *   The extension info array. NULL if the theme_name is not discovered.
    */
   private function getThemeInfo(string $theme_name): ? Extension {
     $extension_discovery = new ExtensionDiscovery($this->root, FALSE, []);

core/lib/Drupal/Core/Command/InstallCommand.php

@@ -123,6 +123,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
    * Returns whether there is already an existing Drupal installation.
    *
    * @return bool
+   *   Returns TRUE if Drupal is installed, FALSE otherwise.
    */
   protected function isDrupalInstalled() {
     try {

core/lib/Drupal/Core/Condition/ConditionPluginCollection.php

@@ -22,6 +22,7 @@ class ConditionPluginCollection extends DefaultLazyPluginCollection {
    *
    * @return \Drupal\Core\Condition\ConditionInterface
    */
+  // phpcs:ignore Drupal.Commenting.FunctionComment.MissingReturnComment
   public function &get($instance_id) {
     return parent::get($instance_id);
   }

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

@@ -34,6 +34,7 @@ public static function get($class_loader = NULL) {
    * Returns a Database configuration storage implementation.
    *
    * @return \Drupal\Core\Config\DatabaseStorage
+   *   The database storage object.
    */
   public static function getDatabaseStorage() {
     return new DatabaseStorage(Database::getConnection(), 'config');

core/lib/Drupal/Core/Config/Checkpoint/CheckpointListInterface.php

@@ -45,6 +45,7 @@ public function get(string $id): Checkpoint;
    *   The checkpoint ID.
    *
    * @return iterable<string, \Drupal\Core\Config\Checkpoint\Checkpoint>
+   *   The parents for the given checkpoint.
    */
   public function getParents(string $id): iterable;
 

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

@@ -43,6 +43,7 @@ public function getConfig() {
    *   The configuration key to check if it has changed.
    *
    * @return bool
+   *   TRUE if the value of the given key has changed, FALSE otherwise.
    */
   public function isChanged($key) {
     return $this->config->get($key) !== $this->config->getOriginal($key);

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

@@ -97,6 +97,7 @@ public function uninstall($type, $name);
    * store.
    *
    * @return \Drupal\Core\Config\Entity\ConfigDependencyManager
+   *   The configuration dependency manager.
    */
   public function getConfigDependencyManager();