Issue #2299699 by lokeoke | jhodgdon: Some classes need @ingroup added to them.
parent
b2c4388c43
commit
2691c42b24
|
@ -310,6 +310,7 @@ function drupal_get_feeds() {
|
||||||
* not available, the current path.
|
* not available, the current path.
|
||||||
*
|
*
|
||||||
* @see current_path()
|
* @see current_path()
|
||||||
|
* @ingroup form_api
|
||||||
*/
|
*/
|
||||||
function drupal_get_destination() {
|
function drupal_get_destination() {
|
||||||
$destination = &drupal_static(__FUNCTION__);
|
$destination = &drupal_static(__FUNCTION__);
|
||||||
|
|
|
@ -18,6 +18,8 @@ use Symfony\Component\HttpFoundation\RequestStack;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Provides a base class for forms.
|
* Provides a base class for forms.
|
||||||
|
*
|
||||||
|
* @ingroup form_api
|
||||||
*/
|
*/
|
||||||
abstract class FormBase implements FormInterface, ContainerInjectionInterface {
|
abstract class FormBase implements FormInterface, ContainerInjectionInterface {
|
||||||
use StringTranslationTrait;
|
use StringTranslationTrait;
|
||||||
|
|
|
@ -28,6 +28,8 @@ use Symfony\Component\HttpKernel\KernelEvents;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Provides form building and processing.
|
* Provides form building and processing.
|
||||||
|
*
|
||||||
|
* @ingroup form_api
|
||||||
*/
|
*/
|
||||||
class FormBuilder implements FormBuilderInterface, FormValidatorInterface, FormSubmitterInterface {
|
class FormBuilder implements FormBuilderInterface, FormValidatorInterface, FormSubmitterInterface {
|
||||||
|
|
||||||
|
|
|
@ -9,6 +9,8 @@ namespace Drupal\Core\Form;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Provides an interface for a Form.
|
* Provides an interface for a Form.
|
||||||
|
*
|
||||||
|
* @ingroup form_api
|
||||||
*/
|
*/
|
||||||
interface FormInterface {
|
interface FormInterface {
|
||||||
|
|
||||||
|
|
|
@ -17,6 +17,8 @@ namespace Drupal\Core\Queue;
|
||||||
*
|
*
|
||||||
* Stale items from failed batches are cleaned from the {queue} table on cron
|
* Stale items from failed batches are cleaned from the {queue} table on cron
|
||||||
* using the 'created' date.
|
* using the 'created' date.
|
||||||
|
*
|
||||||
|
* @ingroup queue
|
||||||
*/
|
*/
|
||||||
class Batch extends DatabaseQueue {
|
class Batch extends DatabaseQueue {
|
||||||
|
|
||||||
|
|
|
@ -15,6 +15,8 @@ namespace Drupal\Core\Queue;
|
||||||
* - Ensures FIFO ordering.
|
* - Ensures FIFO ordering.
|
||||||
* - Allows an item to be repeatedly claimed until it is actually deleted (no
|
* - Allows an item to be repeatedly claimed until it is actually deleted (no
|
||||||
* notion of lease time or 'expire' date), to allow multipass operations.
|
* notion of lease time or 'expire' date), to allow multipass operations.
|
||||||
|
*
|
||||||
|
* @ingroup queue
|
||||||
*/
|
*/
|
||||||
class BatchMemory extends Memory {
|
class BatchMemory extends Memory {
|
||||||
|
|
||||||
|
|
|
@ -11,6 +11,8 @@ use Drupal\Core\Database\Connection;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Default queue implementation.
|
* Default queue implementation.
|
||||||
|
*
|
||||||
|
* @ingroup queue
|
||||||
*/
|
*/
|
||||||
class DatabaseQueue implements ReliableQueueInterface {
|
class DatabaseQueue implements ReliableQueueInterface {
|
||||||
|
|
||||||
|
|
|
@ -13,6 +13,8 @@ namespace Drupal\Core\Queue;
|
||||||
* This allows "undelayed" variants of processes relying on the Queue
|
* This allows "undelayed" variants of processes relying on the Queue
|
||||||
* interface. The queue data resides in memory. It should only be used for
|
* 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.
|
* items that will be queued and dequeued within a given page request.
|
||||||
|
*
|
||||||
|
* @ingroup queue
|
||||||
*/
|
*/
|
||||||
class Memory implements QueueInterface {
|
class Memory implements QueueInterface {
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -12,6 +12,8 @@ namespace Drupal\Core\Queue;
|
||||||
*
|
*
|
||||||
* Classes implementing this interface will do a best effort to preserve order
|
* Classes implementing this interface will do a best effort to preserve order
|
||||||
* in messages and to execute them at least once.
|
* in messages and to execute them at least once.
|
||||||
|
*
|
||||||
|
* @ingroup queue
|
||||||
*/
|
*/
|
||||||
interface QueueInterface {
|
interface QueueInterface {
|
||||||
|
|
||||||
|
|
|
@ -12,6 +12,8 @@ namespace Drupal\Core\Queue;
|
||||||
*
|
*
|
||||||
* Classes implementing this interface preserve the order of messages and
|
* Classes implementing this interface preserve the order of messages and
|
||||||
* guarantee that every item will be executed at least once.
|
* guarantee that every item will be executed at least once.
|
||||||
|
*
|
||||||
|
* @ingroup queue
|
||||||
*/
|
*/
|
||||||
interface ReliableQueueInterface extends QueueInterface {
|
interface ReliableQueueInterface extends QueueInterface {
|
||||||
}
|
}
|
||||||
|
|
|
@ -1813,6 +1813,8 @@ function file_icon_map(FileInterface $file) {
|
||||||
* @return
|
* @return
|
||||||
* A multidimensional array. The keys are field_name, entity_type,
|
* A multidimensional array. The keys are field_name, entity_type,
|
||||||
* entity_id and the value is an entity referencing this file.
|
* 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') {
|
function file_get_file_references(FileInterface $file, FieldDefinitionInterface $field = NULL, $age = EntityStorageInterface::FIELD_LOAD_REVISION, $field_type = 'file') {
|
||||||
$references = &drupal_static(__FUNCTION__, array());
|
$references = &drupal_static(__FUNCTION__, array());
|
||||||
|
|
Loading…
Reference in New Issue