diff --git a/core/core.api.php b/core/core.api.php index d42b5c776f0251cf3213c6aadb617b2ab9e65bab..1d2aa9106b46f4c927929f691b7f4d754dfe8887 100644 --- a/core/core.api.php +++ b/core/core.api.php @@ -1806,6 +1806,7 @@ * The queue system allows placing items in a queue and processing them later. * The system tries to ensure that only one consumer can process an item. * + * @section create_queues Creating queues * Before a queue can be used it needs to be created by * Drupal\Core\Queue\QueueInterface::createQueue(). * @@ -1830,6 +1831,7 @@ * needs to be passed to Drupal\Core\Queue\QueueInterface::deleteItem() once * processing is completed. * + * @section queue_backends Queue backends * There are two kinds of queue backends available: reliable, which preserves * the order of messages and guarantees that every item will be executed at * least once. The non-reliable kind only does a best effort to preserve order @@ -1923,6 +1925,8 @@ * instead of executing the tasks directly. To do this, first define one or * more queues via a \Drupal\Core\Annotation\QueueWorker plugin. Then, add items * that need to be processed to the defined queues. + * + * @see queue */ function hook_cron() { // Short-running operation example, not using a queue: @@ -1982,6 +1986,8 @@ function hook_data_type_info_alter(&$data_types) { * @see \Drupal\Core\Queue\QueueWorkerInterface * @see \Drupal\Core\Annotation\QueueWorker * @see \Drupal\Core\Cron + * + * @ingroup queue */ function hook_queue_info_alter(&$queues) { // This site has many feeds so let's spend 90 seconds on each cron run diff --git a/core/lib/Drupal/Core/Annotation/QueueWorker.php b/core/lib/Drupal/Core/Annotation/QueueWorker.php index b13071132d9afcbe20998a7a9837429b30e713f5..4797d5f9bb564d391bdce40dbe9d0d0f60817d90 100644 --- a/core/lib/Drupal/Core/Annotation/QueueWorker.php +++ b/core/lib/Drupal/Core/Annotation/QueueWorker.php @@ -31,6 +31,8 @@ * @see \Drupal\Core\Queue\QueueWorkerManager * @see plugin_api * + * @ingroup queue + * * @Annotation */ class QueueWorker extends Plugin { @@ -45,9 +47,9 @@ class QueueWorker extends Plugin { /** * The human-readable title of the plugin. * - * @ingroup plugin_translatable - * * @var \Drupal\Core\Annotation\Translation + * + * @ingroup plugin_translatable */ public $title; diff --git a/core/lib/Drupal/Core/Queue/QueueWorkerBase.php b/core/lib/Drupal/Core/Queue/QueueWorkerBase.php index 819966b85315c017222ae8945605fe9b1432fa6a..96cc27d8392f3ea4890221e3712fbe6024455898 100644 --- a/core/lib/Drupal/Core/Queue/QueueWorkerBase.php +++ b/core/lib/Drupal/Core/Queue/QueueWorkerBase.php @@ -11,6 +11,8 @@ * @see \Drupal\Core\Queue\QueueWorkerManager * @see \Drupal\Core\Annotation\QueueWorker * @see plugin_api + * + * @ingroup queue */ abstract class QueueWorkerBase extends PluginBase implements QueueWorkerInterface { diff --git a/core/lib/Drupal/Core/Queue/QueueWorkerInterface.php b/core/lib/Drupal/Core/Queue/QueueWorkerInterface.php index fff1ae21cca725569f1753ad84ea3096c3fd9417..e6c710ffd84a49be3dc5ca2af9a531844e361659 100644 --- a/core/lib/Drupal/Core/Queue/QueueWorkerInterface.php +++ b/core/lib/Drupal/Core/Queue/QueueWorkerInterface.php @@ -11,6 +11,8 @@ * @see \Drupal\Core\Queue\QueueWorkerManager * @see \Drupal\Core\Annotation\QueueWorker * @see plugin_api + * + * @ingroup queue */ interface QueueWorkerInterface extends PluginInspectionInterface {