From 2691c42b2408bd40aec7c5a472df4d4a0f61c306 Mon Sep 17 00:00:00 2001 From: Alex Pott Date: Thu, 24 Jul 2014 17:31:01 +0100 Subject: [PATCH] Issue #2299699 by lokeoke | jhodgdon: Some classes need @ingroup added to them. --- core/includes/common.inc | 1 + core/lib/Drupal/Core/Form/FormBase.php | 2 ++ core/lib/Drupal/Core/Form/FormBuilder.php | 2 ++ core/lib/Drupal/Core/Form/FormInterface.php | 2 ++ core/lib/Drupal/Core/Queue/Batch.php | 2 ++ core/lib/Drupal/Core/Queue/BatchMemory.php | 2 ++ core/lib/Drupal/Core/Queue/DatabaseQueue.php | 2 ++ core/lib/Drupal/Core/Queue/Memory.php | 2 ++ core/lib/Drupal/Core/Queue/QueueInterface.php | 2 ++ core/lib/Drupal/Core/Queue/ReliableQueueInterface.php | 2 ++ core/modules/file/file.module | 2 ++ 11 files changed, 21 insertions(+) diff --git a/core/includes/common.inc b/core/includes/common.inc index 6976f9d669..da65525556 100644 --- a/core/includes/common.inc +++ b/core/includes/common.inc @@ -310,6 +310,7 @@ function drupal_get_feeds() { * not available, the current path. * * @see current_path() + * @ingroup form_api */ function drupal_get_destination() { $destination = &drupal_static(__FUNCTION__); diff --git a/core/lib/Drupal/Core/Form/FormBase.php b/core/lib/Drupal/Core/Form/FormBase.php index 8848d3f9cd..b9f04c1a83 100644 --- a/core/lib/Drupal/Core/Form/FormBase.php +++ b/core/lib/Drupal/Core/Form/FormBase.php @@ -18,6 +18,8 @@ /** * Provides a base class for forms. + * + * @ingroup form_api */ abstract class FormBase implements FormInterface, ContainerInjectionInterface { use StringTranslationTrait; diff --git a/core/lib/Drupal/Core/Form/FormBuilder.php b/core/lib/Drupal/Core/Form/FormBuilder.php index db2900c9bf..c150c29dae 100644 --- a/core/lib/Drupal/Core/Form/FormBuilder.php +++ b/core/lib/Drupal/Core/Form/FormBuilder.php @@ -28,6 +28,8 @@ /** * Provides form building and processing. + * + * @ingroup form_api */ class FormBuilder implements FormBuilderInterface, FormValidatorInterface, FormSubmitterInterface { diff --git a/core/lib/Drupal/Core/Form/FormInterface.php b/core/lib/Drupal/Core/Form/FormInterface.php index fda5aae197..40daf12c10 100644 --- a/core/lib/Drupal/Core/Form/FormInterface.php +++ b/core/lib/Drupal/Core/Form/FormInterface.php @@ -9,6 +9,8 @@ /** * Provides an interface for a Form. + * + * @ingroup form_api */ interface FormInterface { diff --git a/core/lib/Drupal/Core/Queue/Batch.php b/core/lib/Drupal/Core/Queue/Batch.php index 56ec94fb15..750b90fae6 100644 --- a/core/lib/Drupal/Core/Queue/Batch.php +++ b/core/lib/Drupal/Core/Queue/Batch.php @@ -17,6 +17,8 @@ * * Stale items from failed batches are cleaned from the {queue} table on cron * using the 'created' date. + * + * @ingroup queue */ class Batch extends DatabaseQueue { diff --git a/core/lib/Drupal/Core/Queue/BatchMemory.php b/core/lib/Drupal/Core/Queue/BatchMemory.php index fcc49f5c7a..e17e7adc70 100644 --- a/core/lib/Drupal/Core/Queue/BatchMemory.php +++ b/core/lib/Drupal/Core/Queue/BatchMemory.php @@ -15,6 +15,8 @@ * - Ensures FIFO ordering. * - Allows an item to be repeatedly claimed until it is actually deleted (no * notion of lease time or 'expire' date), to allow multipass operations. + * + * @ingroup queue */ class BatchMemory extends Memory { diff --git a/core/lib/Drupal/Core/Queue/DatabaseQueue.php b/core/lib/Drupal/Core/Queue/DatabaseQueue.php index 82d0cb4f73..d4dd5d6ce7 100644 --- a/core/lib/Drupal/Core/Queue/DatabaseQueue.php +++ b/core/lib/Drupal/Core/Queue/DatabaseQueue.php @@ -11,6 +11,8 @@ /** * Default queue implementation. + * + * @ingroup queue */ class DatabaseQueue implements ReliableQueueInterface { diff --git a/core/lib/Drupal/Core/Queue/Memory.php b/core/lib/Drupal/Core/Queue/Memory.php index eb25f9a7a3..0dff021134 100644 --- a/core/lib/Drupal/Core/Queue/Memory.php +++ b/core/lib/Drupal/Core/Queue/Memory.php @@ -13,6 +13,8 @@ * This allows "undelayed" variants of processes relying on the Queue * interface. The queue data resides in memory. It should only be used for * items that will be queued and dequeued within a given page request. + * + * @ingroup queue */ class Memory implements QueueInterface { /** diff --git a/core/lib/Drupal/Core/Queue/QueueInterface.php b/core/lib/Drupal/Core/Queue/QueueInterface.php index 0b7b4cfacf..d9afc5f0bf 100644 --- a/core/lib/Drupal/Core/Queue/QueueInterface.php +++ b/core/lib/Drupal/Core/Queue/QueueInterface.php @@ -12,6 +12,8 @@ * * Classes implementing this interface will do a best effort to preserve order * in messages and to execute them at least once. + * + * @ingroup queue */ interface QueueInterface { diff --git a/core/lib/Drupal/Core/Queue/ReliableQueueInterface.php b/core/lib/Drupal/Core/Queue/ReliableQueueInterface.php index 7f7f8b227a..f36c23dc84 100644 --- a/core/lib/Drupal/Core/Queue/ReliableQueueInterface.php +++ b/core/lib/Drupal/Core/Queue/ReliableQueueInterface.php @@ -12,6 +12,8 @@ * * Classes implementing this interface preserve the order of messages and * guarantee that every item will be executed at least once. + * + * @ingroup queue */ interface ReliableQueueInterface extends QueueInterface { } diff --git a/core/modules/file/file.module b/core/modules/file/file.module index 67634cebda..d676bb5734 100644 --- a/core/modules/file/file.module +++ b/core/modules/file/file.module @@ -1813,6 +1813,8 @@ function file_icon_map(FileInterface $file) { * @return * A multidimensional array. The keys are field_name, entity_type, * entity_id and the value is an entity referencing this file. + * + * @ingroup file */ function file_get_file_references(FileInterface $file, FieldDefinitionInterface $field = NULL, $age = EntityStorageInterface::FIELD_LOAD_REVISION, $field_type = 'file') { $references = &drupal_static(__FUNCTION__, array()); -- GitLab