Commit 2691c42b authored by alexpott's avatar alexpott

Issue #2299699 by lokeoke | jhodgdon: Some classes need @ingroup added to them.

parent b2c4388c
......@@ -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__);
......
......@@ -18,6 +18,8 @@
/**
* Provides a base class for forms.
*
* @ingroup form_api
*/
abstract class FormBase implements FormInterface, ContainerInjectionInterface {
use StringTranslationTrait;
......
......@@ -28,6 +28,8 @@
/**
* Provides form building and processing.
*
* @ingroup form_api
*/
class FormBuilder implements FormBuilderInterface, FormValidatorInterface, FormSubmitterInterface {
......
......@@ -9,6 +9,8 @@
/**
* Provides an interface for a Form.
*
* @ingroup form_api
*/
interface FormInterface {
......
......@@ -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 {
......
......@@ -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 {
......
......@@ -11,6 +11,8 @@
/**
* Default queue implementation.
*
* @ingroup queue
*/
class DatabaseQueue implements ReliableQueueInterface {
......
......@@ -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 {
/**
......
......@@ -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 {
......
......@@ -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 {
}
......@@ -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());
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment