summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Pott2014-07-24 16:31:01 (GMT)
committerAlex Pott2014-07-24 16:31:01 (GMT)
commit2691c42b2408bd40aec7c5a472df4d4a0f61c306 (patch)
tree208fce0c121c7c155c066f409908013fea819961
parentb2c4388c43d7055a8eeb2cd5995b4cf0fd823fa1 (diff)
Issue #2299699 by lokeoke | jhodgdon: Some classes need @ingroup added to them.
-rw-r--r--core/includes/common.inc1
-rw-r--r--core/lib/Drupal/Core/Form/FormBase.php2
-rw-r--r--core/lib/Drupal/Core/Form/FormBuilder.php2
-rw-r--r--core/lib/Drupal/Core/Form/FormInterface.php2
-rw-r--r--core/lib/Drupal/Core/Queue/Batch.php2
-rw-r--r--core/lib/Drupal/Core/Queue/BatchMemory.php2
-rw-r--r--core/lib/Drupal/Core/Queue/DatabaseQueue.php2
-rw-r--r--core/lib/Drupal/Core/Queue/Memory.php2
-rw-r--r--core/lib/Drupal/Core/Queue/QueueInterface.php2
-rw-r--r--core/lib/Drupal/Core/Queue/ReliableQueueInterface.php2
-rw-r--r--core/modules/file/file.module2
11 files changed, 21 insertions, 0 deletions
diff --git a/core/includes/common.inc b/core/includes/common.inc
index 6976f9d..da65525 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 8848d3f..b9f04c1 100644
--- a/core/lib/Drupal/Core/Form/FormBase.php
+++ b/core/lib/Drupal/Core/Form/FormBase.php
@@ -18,6 +18,8 @@ use Symfony\Component\HttpFoundation\RequestStack;
/**
* 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 db2900c..c150c29 100644
--- a/core/lib/Drupal/Core/Form/FormBuilder.php
+++ b/core/lib/Drupal/Core/Form/FormBuilder.php
@@ -28,6 +28,8 @@ use Symfony\Component\HttpKernel\KernelEvents;
/**
* 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 fda5aae..40daf12 100644
--- a/core/lib/Drupal/Core/Form/FormInterface.php
+++ b/core/lib/Drupal/Core/Form/FormInterface.php
@@ -9,6 +9,8 @@ namespace Drupal\Core\Form;
/**
* 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 56ec94f..750b90f 100644
--- a/core/lib/Drupal/Core/Queue/Batch.php
+++ b/core/lib/Drupal/Core/Queue/Batch.php
@@ -17,6 +17,8 @@ namespace Drupal\Core\Queue;
*
* 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 fcc49f5..e17e7ad 100644
--- a/core/lib/Drupal/Core/Queue/BatchMemory.php
+++ b/core/lib/Drupal/Core/Queue/BatchMemory.php
@@ -15,6 +15,8 @@ namespace Drupal\Core\Queue;
* - 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 82d0cb4..d4dd5d6 100644
--- a/core/lib/Drupal/Core/Queue/DatabaseQueue.php
+++ b/core/lib/Drupal/Core/Queue/DatabaseQueue.php
@@ -11,6 +11,8 @@ use Drupal\Core\Database\Connection;
/**
* 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 eb25f9a..0dff021 100644
--- a/core/lib/Drupal/Core/Queue/Memory.php
+++ b/core/lib/Drupal/Core/Queue/Memory.php
@@ -13,6 +13,8 @@ namespace Drupal\Core\Queue;
* 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 0b7b4cf..d9afc5f 100644
--- a/core/lib/Drupal/Core/Queue/QueueInterface.php
+++ b/core/lib/Drupal/Core/Queue/QueueInterface.php
@@ -12,6 +12,8 @@ namespace Drupal\Core\Queue;
*
* 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 7f7f8b2..f36c23d 100644
--- a/core/lib/Drupal/Core/Queue/ReliableQueueInterface.php
+++ b/core/lib/Drupal/Core/Queue/ReliableQueueInterface.php
@@ -12,6 +12,8 @@ namespace Drupal\Core\Queue;
*
* 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 67634ce..d676bb5 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());