Skip to content
Snippets Groups Projects
Commit 0a847106 authored by catch's avatar catch
Browse files

Issue #3426217 by mstrelan: Fix @param docs for $deriver on plugin attribute classes

parent a1a138cf
No related branches found
No related tags found
No related merge requests found
...@@ -12,7 +12,7 @@ interface DerivablePluginDefinitionInterface extends PluginDefinitionInterface { ...@@ -12,7 +12,7 @@ interface DerivablePluginDefinitionInterface extends PluginDefinitionInterface {
/** /**
* Gets the name of the deriver of this plugin definition, if it exists. * Gets the name of the deriver of this plugin definition, if it exists.
* *
* @return string|null * @return class-string|null
* Either the deriver class name, or NULL if the plugin is not derived. * Either the deriver class name, or NULL if the plugin is not derived.
*/ */
public function getDeriver(); public function getDeriver();
...@@ -20,7 +20,7 @@ public function getDeriver(); ...@@ -20,7 +20,7 @@ public function getDeriver();
/** /**
* Sets the deriver of this plugin definition. * Sets the deriver of this plugin definition.
* *
* @param string|null $deriver * @param class-string|null $deriver
* Either the name of a class that implements * Either the name of a class that implements
* \Drupal\Component\Plugin\Derivative\DeriverInterface, or NULL. * \Drupal\Component\Plugin\Derivative\DeriverInterface, or NULL.
* *
......
...@@ -31,7 +31,7 @@ class Action extends Plugin { ...@@ -31,7 +31,7 @@ class Action extends Plugin {
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $category * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $category
* (optional) The category under which the action should be listed in the * (optional) The category under which the action should be listed in the
* UI. * UI.
* @param string|null $deriver * @param class-string|null $deriver
* (optional) The deriver class. * (optional) The deriver class.
* @param string|null $confirm_form_route_name * @param string|null $confirm_form_route_name
* (optional) The route name for a confirmation form for this action. * (optional) The route name for a confirmation form for this action.
......
...@@ -31,7 +31,7 @@ class Archiver extends Plugin { ...@@ -31,7 +31,7 @@ class Archiver extends Plugin {
* The description of the archiver plugin. * The description of the archiver plugin.
* @param array $extensions * @param array $extensions
* An array of valid extensions for this archiver. * An array of valid extensions for this archiver.
* @param string|null $deriver * @param class-string|null $deriver
* (optional) The deriver class. * (optional) The deriver class.
*/ */
public function __construct( public function __construct(
......
...@@ -23,7 +23,7 @@ class Block extends Plugin { ...@@ -23,7 +23,7 @@ class Block extends Plugin {
* @param \Drupal\Core\Plugin\Context\ContextDefinitionInterface[] $context_definitions * @param \Drupal\Core\Plugin\Context\ContextDefinitionInterface[] $context_definitions
* (optional) An array of context definitions describing the context used by * (optional) An array of context definitions describing the context used by
* the plugin. The array is keyed by context names. * the plugin. The array is keyed by context names.
* @param string|null $deriver * @param class-string|null $deriver
* (optional) The deriver class. * (optional) The deriver class.
* @param string[] $forms * @param string[] $forms
* (optional) An array of form class names keyed by a string. * (optional) An array of form class names keyed by a string.
......
...@@ -56,7 +56,7 @@ class ImageToolkitOperation extends Plugin { ...@@ -56,7 +56,7 @@ class ImageToolkitOperation extends Plugin {
* The human-readable name of the image toolkit operation. * The human-readable name of the image toolkit operation.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $description * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $description
* (optional) The description of the image toolkit operation. * (optional) The description of the image toolkit operation.
* @param string|null $deriver * @param class-string|null $deriver
* (optional) The deriver class for the image toolkit operation. * (optional) The deriver class for the image toolkit operation.
*/ */
public function __construct( public function __construct(
......
...@@ -30,7 +30,7 @@ class Mail extends Plugin { ...@@ -30,7 +30,7 @@ class Mail extends Plugin {
* The label of the plugin. * The label of the plugin.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $description * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $description
* (optional) A description of the plugin. * (optional) A description of the plugin.
* @param string|null $deriver * @param class-string|null $deriver
* (optional) The deriver class. * (optional) The deriver class.
*/ */
public function __construct( public function __construct(
......
...@@ -59,7 +59,7 @@ class DataType extends Plugin { ...@@ -59,7 +59,7 @@ class DataType extends Plugin {
* (optional) An array of validation constraints for this type. * (optional) An array of validation constraints for this type.
* @param bool $unwrap_for_canonical_representation * @param bool $unwrap_for_canonical_representation
* Whether the typed object wraps the canonical representation of the data. * Whether the typed object wraps the canonical representation of the data.
* @param string|null $deriver * @param class-string|null $deriver
* (optional) The deriver class for the data type. * (optional) The deriver class for the data type.
* *
* @see \Drupal\Core\TypedData\TypedDataManager::getConstraints() * @see \Drupal\Core\TypedData\TypedDataManager::getConstraints()
......
...@@ -34,7 +34,7 @@ class Constraint extends Plugin { ...@@ -34,7 +34,7 @@ class Constraint extends Plugin {
* multiple type names. For supporting all types, FALSE may be specified. * multiple type names. For supporting all types, FALSE may be specified.
* The key defaults to an empty array, which indicates no types are * The key defaults to an empty array, which indicates no types are
* supported. * supported.
* @param string|null $deriver * @param class-string|null $deriver
* (optional) The deriver class. * (optional) The deriver class.
*/ */
public function __construct( public function __construct(
......
...@@ -40,7 +40,7 @@ class HelpSection extends Plugin { ...@@ -40,7 +40,7 @@ class HelpSection extends Plugin {
* page itself. * page itself.
* @param int|null $weight * @param int|null $weight
* (optional) The weight of the help page section. * (optional) The weight of the help page section.
* @param string|null $deriver * @param class-string|null $deriver
* (optional) The deriver class. * (optional) The deriver class.
* *
* The sections will be ordered by this weight on the help page. * The sections will be ordered by this weight on the help page.
......
...@@ -33,12 +33,12 @@ class RestResource extends Plugin { ...@@ -33,12 +33,12 @@ class RestResource extends Plugin {
* The human-readable name of the REST resource plugin. * The human-readable name of the REST resource plugin.
* @param string|null $serialization_class * @param string|null $serialization_class
* (optional) The serialization class to deserialize serialized data into. * (optional) The serialization class to deserialize serialized data into.
* @param string|null $deriver * @param class-string|null $deriver
* (optional) The deriver class for the rest resource.
* @param array $uri_paths
* (optional) The URI paths that this REST resource plugin provides. * (optional) The URI paths that this REST resource plugin provides.
* - key: The link relation type plugin ID. * - key: The link relation type plugin ID.
* - value: The URL template. * - value: The URL template.
* @param array $uri_paths
* (optional) The deriver class for the rest resource.
* *
* @see \Symfony\Component\Serializer\SerializerInterface * @see \Symfony\Component\Serializer\SerializerInterface
* @see core/core.link_relation_types.yml * @see core/core.link_relation_types.yml
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment