Commit 83229e05 authored by jhodgdon's avatar jhodgdon

Issue #2290259 by g3r4, er.pushpinderrana, joshi.rohit100, amitgoyal: Make...

Issue #2290259 by g3r4, er.pushpinderrana, joshi.rohit100, amitgoyal: Make developer docs for entity reference selection plugins more discoverable
parent 6357f914
......@@ -10,7 +10,18 @@
use Drupal\Component\Annotation\Plugin;
/**
* Defines a EntityReferenceSelection annotation object.
* Defines an EntityReferenceSelection plugin annotation object.
*
* Plugin Namespace: Plugin\entity_reference\selection
*
* For a working example, see
* \Drupal\comment\Plugin\entity_reference\selection\CommentSelection
*
* @see \Drupal\entity_reference\Plugin\Type\SelectionPluginManager
* @see \Drupal\entity_reference\Plugin\Type\Selection\SelectionInterface
* @see \Drupal\entity_reference\Plugin\entity_reference\selection\SelectionBase
* @see \Drupal\entity_reference\Plugin\Derivative\SelectionBase
* @see plugin_api
*
* @Annotation
*/
......
......@@ -10,7 +10,13 @@
use Drupal\Component\Plugin\Derivative\DeriverBase;
/**
* Base class for selection plugins provided by Entity Reference.
* Provides derivative plugins for Entity Reference Selection plugins.
*
* @see \Drupal\entity_reference\Plugin\entity_reference\selection\SelectionBase
* @see \Drupal\entity_reference\Plugin\Type\SelectionPluginManager
* @see \Drupal\entity_reference\Annotation\EntityReferenceSelection
* @see \Drupal\entity_reference\Plugin\Type\Selection\SelectionInterface
* @see plugin_api
*/
class SelectionBase extends DeriverBase {
/**
......
......@@ -11,12 +11,13 @@
use Drupal\Core\Field\FieldDefinitionInterface;
/**
* Interface definition for Entity Reference selection plugins.
* Interface definition for Entity Reference Selection plugins.
*
* This interface details the methods that most plugin implementations will want
* to override. See \Drupal\field\Plugin\Type\Selection\SelectionBaseInterface
* for base wrapping methods that should most likely be inherited directly from
* Drupal\entity_reference\Plugin\Type\Selection\SelectionBase.
* @see \Drupal\entity_reference\Plugin\entity_reference\selection\SelectionBase
* @see \Drupal\entity_reference\Plugin\Type\SelectionPluginManager
* @see \Drupal\entity_reference\Annotation\EntityReferenceSelection
* @see \Drupal\entity_reference\Plugin\Derivative\SelectionBase
* @see plugin_api
*/
interface SelectionInterface {
......
......@@ -18,7 +18,13 @@
use Drupal\entity_reference\Plugin\Type\Selection\SelectionBroken;
/**
* Plugin type manager for the Entity Reference Selection plugin.
* Plugin type manager for Entity Reference Selection plugins.
*
* @see \Drupal\entity_reference\Annotation\EntityReferenceSelection
* @see \Drupal\entity_reference\Plugin\Type\Selection\SelectionInterface
* @see \Drupal\entity_reference\Plugin\entity_reference\selection\SelectionBase
* @see \Drupal\entity_reference\Plugin\Derivative\SelectionBase
* @see plugin_api
*/
class SelectionPluginManager extends DefaultPluginManager {
......
......@@ -15,7 +15,16 @@
use Drupal\entity_reference\Plugin\Type\Selection\SelectionInterface;
/**
* Plugin implementation of the 'selection' entity_reference.
* Default plugin implementation of the Entity Reference Selection plugin.
*
* Also serves as a base class for specific types of Entity Reference
* Selection plugins.
*
* @see \Drupal\entity_reference\Plugin\Type\SelectionPluginManager
* @see \Drupal\entity_reference\Annotation\EntityReferenceSelection
* @see \Drupal\entity_reference\Plugin\Type\Selection\SelectionInterface
* @see \Drupal\entity_reference\Plugin\Derivative\SelectionBase
* @see plugin_api
*
* @EntityReferenceSelection(
* id = "default",
......
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