Issue #2829537 by Steven Jones: Doxygen documentation is incorrect

src/Annotation/ImageAPIOptimizeProcessor.php

@@ -7,18 +7,17 @@ use Drupal\Component\Annotation\Plugin;
 /**
  * Defines an image optimize processor annotation object.
  *
- * Plugin Namespace: Plugin\ImageEffect
+ * Plugin Namespace: Plugin\ImageAPIOptimizeProcessor
  *
  * For a working example, see
- * \Drupal\imageapi_optimize\Plugin\ImageEffect\ResizeImageEffect
+ * \Drupal\imageapi_optimize\Plugin\ImageAPIOptimizeProcessor\reSmushit
  *
  * @see hook_image_effect_info_alter()
- * @see \Drupal\imageapi_optimize\ConfigurableImageEffectInterface
- * @see \Drupal\imageapi_optimize\ConfigurableImageEffectBase
- * @see \Drupal\imageapi_optimize\ImageEffectInterface
- * @see \Drupal\imageapi_optimize\ImageEffectBase
- * @see \Drupal\imageapi_optimize\ImageEffectManager
- * @see \Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation
+ * @see \Drupal\imageapi_optimize\ConfigurableImageAPIOptimizeProcessorInterface
+ * @see \Drupal\imageapi_optimize\ConfigurableImageAPIOptimizeProcessorBase
+ * @see \Drupal\imageapi_optimize\ImageAPIOptimizePipelineInterface
+ * @see \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorBase
+ * @see \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorManager
  * @see plugin_api
  *
  * @Annotation

src/ConfigurableImageAPIOptimizeProcessorBase.php

@@ -7,11 +7,11 @@ use Drupal\Core\Form\FormStateInterface;
 /**
  * Provides a base class for configurable image optimize processors.
  *
- * @see \Drupal\imageapi_optimize\Annotation\ImageEffect
- * @see \Drupal\imageapi_optimize\ConfigurableImageEffectInterface
- * @see \Drupal\imageapi_optimize\ImageEffectInterface
- * @see \Drupal\imageapi_optimize\ImageEffectBase
- * @see \Drupal\imageapi_optimize\ImageEffectManager
+ * @see \Drupal\imageapi_optimize\Annotation\ImageAPIOptimizeProcessor
+ * @see \Drupal\imageapi_optimize\ConfigurableImageAPIOptimizeProcessorInterface
+ * @see \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorInterface
+ * @see \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorBase
+ * @see \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorManager
  * @see plugin_api
  */
 abstract class ConfigurableImageAPIOptimizeProcessorBase extends ImageAPIOptimizeProcessorBase implements ConfigurableImageAPIOptimizeProcessorInterface {

src/ConfigurableImageAPIOptimizeProcessorInterface.php

@@ -7,11 +7,11 @@ use Drupal\Core\Plugin\PluginFormInterface;
 /**
  * Defines the interface for configurable image optimize processors.
  *
- * @see \Drupal\imageapi_optimize\Annotation\ImageEffect
- * @see \Drupal\imageapi_optimize\ConfigurableImageEffectBase
- * @see \Drupal\imageapi_optimize\ImageEffectInterface
- * @see \Drupal\imageapi_optimize\ImageEffectBase
- * @see \Drupal\imageapi_optimize\ImageEffectManager
+ * @see \Drupal\imageapi_optimize\Annotation\ImageAPIOptimizeProcessor
+ * @see \Drupal\imageapi_optimize\ConfigurableImageAPIOptimizeProcessorBase
+ * @see \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorInterface
+ * @see \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorBase
+ * @see \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorManager
  * @see plugin_api
  */
 interface ConfigurableImageAPIOptimizeProcessorInterface extends ImageAPIOptimizeProcessorInterface, PluginFormInterface {

src/Entity/ImageAPIOptimizePipeline.php

@@ -130,11 +130,11 @@ class ImageAPIOptimizePipeline extends ConfigEntityBase implements ImageAPIOptim
   /**
    * Update field settings if the image optimize pipeline name is changed.
    *
-   * @param \Drupal\imageapi_optimize\ImageAPIOptimizePipelineInterface $style
+   * @param \Drupal\imageapi_optimize\ImageAPIOptimizePipelineInterface $pipeline
    *   The image optimize pipeline.
    */
-  protected static function replaceImageAPIOptimizePipeline(ImageAPIOptimizePipelineInterface $style) {
-    if ($style->id() != $style->getOriginalId()) {
+  protected static function replaceImageAPIOptimizePipeline(ImageAPIOptimizePipelineInterface $pipeline) {
+    if ($pipeline->id() != $pipeline->getOriginalId()) {
       // Loop through all image optimize pipelines looking for usages.
 
     }

src/ImageAPIOptimizePipelineInterface.php

@@ -17,9 +17,9 @@ interface ImageAPIOptimizePipelineInterface extends ConfigEntityInterface {
    *   selected.
    *
    * @deprecated in Drupal 8.0.x, will be removed before Drupal 9.0.x. Use
-   *   \Drupal\imageapi_optimize\ImageStyleStorageInterface::getReplacementId() instead.
+   *   \Drupal\imageapi_optimize\ImageAPIOptimizePipelineStorageInterface::getReplacementId() instead.
    *
-   * @see \Drupal\imageapi_optimize\ImageStyleStorageInterface::getReplacementId()
+   * @see \Drupal\imageapi_optimize\ImageAPIOptimizePipelineStorageInterface::getReplacementId()
    */
   public function getReplacementID();
 
@@ -37,7 +37,7 @@ interface ImageAPIOptimizePipelineInterface extends ConfigEntityInterface {
    * @param string $name
    *   The name of the image optimize pipeline.
    *
-   * @return \Drupal\imageapi_optimize\ImageStyleInterface
+   * @return \Drupal\imageapi_optimize\ImageAPIOptimizePipelineInterface
    *   The class instance this method is called on.
    */
   public function setName($name);
@@ -62,7 +62,7 @@ interface ImageAPIOptimizePipelineInterface extends ConfigEntityInterface {
   public function getProcessors();
 
   /**
-   * Saves an image optimize processor for this style.
+   * Saves an image optimize processor for this pipeline.
    *
    * @param array $configuration
    *   An array of image optimize processor configuration.
@@ -73,7 +73,7 @@ interface ImageAPIOptimizePipelineInterface extends ConfigEntityInterface {
   public function addProcessor(array $configuration);
 
   /**
-   * Deletes an image optimize processor from this style.
+   * Deletes an image optimize processor from this pipeline.
    *
    * @param \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorInterface $effect
    *   The image optimize processor object.

src/ImageAPIOptimizePipelineListBuilder.php

@@ -4,15 +4,51 @@ namespace Drupal\imageapi_optimize;
 
 use Drupal\Core\Config\Entity\ConfigEntityListBuilder;
 use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Entity\EntityTypeInterface;
+use Drupal\Core\Form\FormBuilderInterface;
 use Drupal\Core\Url;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Defines a class to build a listing of image optimize pipeline entities.
  *
- * @see \Drupal\imageapi_optimize\Entity\ImageStyle
+ * @see \Drupal\imageapi_optimize\Entity\ImageAPIOptimizePipeline
  */
 class ImageAPIOptimizePipelineListBuilder extends ConfigEntityListBuilder {
 
+  /**
+   * A form builder.
+   *
+   * @var \Drupal\Core\Form\FormBuilderInterface
+   */
+  protected $formBuilder;
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
+    return new static(
+      $entity_type,
+      $container->get('entity.manager')->getStorage($entity_type->id()),
+      $container->get('form_builder')
+    );
+  }
+
+  /**
+   * Constructs a new EntityListBuilder object.
+   *
+   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
+   *   The entity type definition.
+   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
+   *   The entity storage class.
+   */
+  public function __construct(EntityTypeInterface $entity_type, ImageAPIOptimizePipelineStorageInterface $storage, FormBuilderInterface $form_builder) {
+    $this->entityTypeId = $entity_type->id();
+    $this->storage = $storage;
+    $this->entityType = $entity_type;
+    $this->formBuilder = $form_builder;
+  }
+
   /**
    * {@inheritdoc}
    */
@@ -52,7 +88,7 @@ class ImageAPIOptimizePipelineListBuilder extends ConfigEntityListBuilder {
     $build['table']['#empty'] = $this->t('There are currently no pipelines. <a href=":url">Add a new one</a>.', [
       ':url' => Url::fromRoute('imageapi_optimize.pipeline_add')->toString(),
     ]);
-    $build['config_form'] = \Drupal::formBuilder()->getForm('Drupal\imageapi_optimize\Form\ImageAPIOptimizeDefaultPipelineConfigForm');
+    $build['config_form'] = $this->formBuilder->getForm('Drupal\imageapi_optimize\Form\ImageAPIOptimizeDefaultPipelineConfigForm');
     return $build;
   }