Commit d11fff21 authored by alexpott's avatar alexpott

Issue #2290267 by jhodgdon: Image-related plugin classes need more docs links.

parent 9be30ef5
......@@ -12,10 +12,21 @@
/**
* Defines a Plugin annotation object for the image toolkit plugin.
*
* @Annotation
* An image toolkit provides common image file manipulations like scaling,
* cropping, and rotating.
*
* Plugin namespace: Plugin\ImageToolkit
*
* For a working example, see
* \Drupal\system\Plugin\ImageToolkit\GDToolkit
*
* @see \Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation
* @see \Drupal\Core\ImageToolkit\ImageToolkitInterface
* @see \Drupal\Core\ImageToolkit\ImageToolkitBase
* @see \Drupal\Core\ImageToolkit\ImageToolkitManager
* @see plugin_api
*
* @Annotation
*/
class ImageToolkit extends Plugin {
......
......@@ -12,9 +12,23 @@
/**
* Defines a Plugin annotation object for the image toolkit operation plugin.
*
* @Annotation
* An image toolkit operation plugin provides a self-contained image
* manipulation routine, for a specific image toolkit. Examples of image
* toolkit operations are scaling, cropping, rotating, etc.
*
* Plugin namespace: Plugin\ImageToolkit\Operation
*
* For a working example, see
* \Drupal\system\Plugin\ImageToolkit\Operation\gd\Crop
*
* @see \Drupal\Core\ImageToolkit\Annotation\ImageToolkit
* @see \Drupal\image\Annotation\ImageEffect
* @see \Drupal\Core\ImageToolkit\ImageToolkitOperationInterface
* @see \Drupal\Core\ImageToolkit\ImageToolkitOperationBase
* @see \Drupal\Core\ImageToolkit\ImageToolkitOperationManager
* @see plugin_api
*
* @Annotation
*/
class ImageToolkitOperation extends Plugin {
......
......@@ -12,6 +12,14 @@
use Drupal\Core\Plugin\PluginBase;
use Psr\Log\LoggerInterface;
/**
* Provides a base class for image toolkit plugins.
*
* @see \Drupal\Core\ImageToolkit\Annotation\ImageToolkit
* @see \Drupal\Core\ImageToolkit\ImageToolkitInterface
* @see \Drupal\Core\ImageToolkit\ImageToolkitManager
* @see plugin_api
*/
abstract class ImageToolkitBase extends PluginBase implements ImageToolkitInterface {
/**
......
......@@ -43,6 +43,11 @@
*
* An image toolkit provides common image file manipulations like scaling,
* cropping, and rotating.
*
* @see \Drupal\Core\ImageToolkit\Annotation\ImageToolkit
* @see \Drupal\Core\ImageToolkit\ImageToolkitBase
* @see \Drupal\Core\ImageToolkit\ImageToolkitManager
* @see plugin_api
*/
interface ImageToolkitInterface extends PluginInspectionInterface {
......
......@@ -15,7 +15,12 @@
use Psr\Log\LoggerInterface;
/**
* Manages toolkit plugins.
* Manages image toolkit plugins.
*
* @see \Drupal\Core\ImageToolkit\Annotation\ImageToolkit
* @see \Drupal\Core\ImageToolkit\ImageToolkitInterface
* @see \Drupal\Core\ImageToolkit\ImageToolkitBase
* @see plugin_api
*/
class ImageToolkitManager extends DefaultPluginManager {
......
......@@ -12,6 +12,14 @@
use Drupal\Core\Plugin\PluginBase;
use Psr\Log\LoggerInterface;
/**
* Provides a base class for image toolkit operation plugins.
*
* @see \Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation
* @see \Drupal\Core\ImageToolkit\ImageToolkitOperationInterface
* @see \Drupal\Core\ImageToolkit\ImageToolkitOperationManager
* @see plugin_api
*/
abstract class ImageToolkitOperationBase extends PluginBase implements ImageToolkitOperationInterface {
/**
......
......@@ -15,6 +15,11 @@
* An image toolkit operation plugin provides a self-contained image
* manipulation routine, for a specific image toolkit. Examples of image
* toolkit operations are scaling, cropping, rotating, etc.
*
* @see \Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation
* @see \Drupal\Core\ImageToolkit\ImageToolkitOperationBase
* @see \Drupal\Core\ImageToolkit\ImageToolkitOperationManager
* @see plugin_api
*/
interface ImageToolkitOperationInterface extends PluginInspectionInterface {
......
......@@ -17,6 +17,11 @@
/**
* Manages toolkit operation plugins.
*
* @see \Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation
* @see \Drupal\Core\ImageToolkit\ImageToolkitOperationBase
* @see \Drupal\Core\ImageToolkit\ImageToolkitOperationInterface
* @see plugin_api
*/
class ImageToolkitOperationManager extends DefaultPluginManager implements ImageToolkitOperationManagerInterface {
......
......@@ -12,7 +12,19 @@
/**
* Defines an image effect annotation object.
*
* Plugin Namespace: Plugin\ImageEffect
*
* For a working example, see
* \Drupal\image\Plugin\ImageEffect\ResizeImageEffect
*
* @see hook_image_effect_info_alter()
* @see \Drupal\image\ConfigurableImageEffectInterface
* @see \Drupal\image\ConfigurableImageEffectBase
* @see \Drupal\image\ImageEffectInterface
* @see \Drupal\image\ImageEffectBase
* @see \Drupal\image\ImageEffectManager
* @see \Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation
* @see plugin_api
*
* @Annotation
*/
......
......@@ -11,6 +11,13 @@
/**
* Provides a base class for configurable image effects.
*
* @see \Drupal\image\Annotation\ImageEffect
* @see \Drupal\image\ConfigurableImageEffectInterface
* @see \Drupal\image\ImageEffectInterface
* @see \Drupal\image\ImageEffectBase
* @see \Drupal\image\ImageEffectManager
* @see plugin_api
*/
abstract class ConfigurableImageEffectBase extends ImageEffectBase implements ConfigurableImageEffectInterface {
......
......@@ -11,6 +11,13 @@
/**
* Defines the interface for configurable image effects.
*
* @see \Drupal\image\Annotation\ImageEffect
* @see \Drupal\image\ConfigurableImageEffectBase
* @see \Drupal\image\ImageEffectInterface
* @see \Drupal\image\ImageEffectBase
* @see \Drupal\image\ImageEffectManager
* @see plugin_api
*/
interface ConfigurableImageEffectInterface extends ImageEffectInterface, PluginFormInterface {
}
......@@ -2,7 +2,7 @@
/**
* @file
* Contains \Drupal\image\Annotation\ImageEffectBase.
* Contains \Drupal\image\ImageEffectBase.
*/
namespace Drupal\image;
......@@ -14,6 +14,13 @@
/**
* Provides a base class for image effects.
*
* @see \Drupal\image\Annotation\ImageEffect
* @see \Drupal\image\ImageEffectInterface
* @see \Drupal\image\ConfigurableImageEffectInterface
* @see \Drupal\image\ConfigurableImageEffectBase
* @see \Drupal\image\ImageEffectManager
* @see plugin_api
*/
abstract class ImageEffectBase extends PluginBase implements ImageEffectInterface, ContainerFactoryPluginInterface {
......
......@@ -13,6 +13,13 @@
/**
* Defines the interface for image effects.
*
* @see \Drupal\image\Annotation\ImageEffect
* @see \Drupal\image\ImageEffectBase
* @see \Drupal\image\ConfigurableImageEffectInterface
* @see \Drupal\image\ConfigurableImageEffectBase
* @see \Drupal\image\ImageEffectManager
* @see plugin_api
*/
interface ImageEffectInterface extends PluginInspectionInterface, ConfigurablePluginInterface {
......
......@@ -13,6 +13,14 @@
/**
* Manages image effect plugins.
*
* @see hook_image_effect_info_alter()
* @see \Drupal\image\Annotation\ImageEffect
* @see \Drupal\image\ConfigurableImageEffectInterface
* @see \Drupal\image\ConfigurableImageEffectBase
* @see \Drupal\image\ImageEffectInterface
* @see \Drupal\image\ImageEffectBase
* @see plugin_api
*/
class ImageEffectManager extends DefaultPluginManager {
......
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