Issue #2829537 by Steven Jones: Doxygen documentation is incorrect

src/Annotation/ImageAPIOptimizeProcessor.php

@@ -12,7 +12,7 @@ use Drupal\Component\Annotation\Plugin;
  * For a working example, see
  * \Drupal\imageapi_optimize\Plugin\ImageAPIOptimizeProcessor\reSmushit
  *
- * @see hook_image_effect_info_alter()
+ * @see hook_imageapi_optimize_processor_info_alter()
  * @see \Drupal\imageapi_optimize\ConfigurableImageAPIOptimizeProcessorInterface
  * @see \Drupal\imageapi_optimize\ConfigurableImageAPIOptimizeProcessorBase
  * @see \Drupal\imageapi_optimize\ImageAPIOptimizePipelineInterface

src/Entity/ImageAPIOptimizePipeline.php

@@ -192,8 +192,8 @@ class ImageAPIOptimizePipeline extends ConfigEntityBase implements ImageAPIOptim
   /**
    * {@inheritdoc}
    */
-  public function getProcessor($effect) {
-    return $this->getProcessors()->get($effect);
+  public function getProcessor($processor) {
+    return $this->getProcessors()->get($processor);
   }
 
   /**

src/Form/ImageAPIOptimizePipelineEditForm.php

@@ -69,9 +69,9 @@ class ImageAPIOptimizePipelineEditForm extends ImageAPIOptimizePipelineFormBase
         ),
       ),
       '#attributes' => array(
-        'id' => 'image-style-processors',
+        'id' => 'image-pipeline-processors',
       ),
-      '#empty' => t('There are currently no processors in this style. Add one by selecting an option below.'),
+      '#empty' => t('There are currently no processors in this pipeline. Add one by selecting an option below.'),
       // Render processors below parent elements.
       '#weight' => 5,
     );
@@ -161,7 +161,7 @@ class ImageAPIOptimizePipelineEditForm extends ImageAPIOptimizePipelineFormBase
           ),
         ),
       ),
-      '#prefix' => '<div class="image-style-new">',
+      '#prefix' => '<div class="image-pipeline-new">',
       '#suffix' => '</div>',
     );
 
@@ -258,8 +258,8 @@ class ImageAPIOptimizePipelineEditForm extends ImageAPIOptimizePipelineFormBase
    * Updates image optimize processor weights.
    *
    * @param array $processors
-   *   Associative array with effects having effect uuid as keys and array
-   *   with effect data as values.
+   *   Associative array with processors having processor uuid as keys and array
+   *   with processor data as values.
    */
   protected function updateProcessorWeights(array $processors) {
     foreach ($processors as $uuid => $processor_data) {

src/Form/ImageAPIOptimizeProcessorAddForm.php

@@ -22,11 +22,11 @@ class ImageAPIOptimizeProcessorAddForm extends ImageAPIOptimizeProcessorFormBase
   /**
    * Constructs a new ImageAPIOptimizeProcessorAddForm.
    *
-   * @param \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorManager $effect_manager
+   * @param \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorManager $processor_manager
    *   The image optimize processor manager.
    */
-  public function __construct(ImageAPIOptimizeProcessorManager $effect_manager) {
-    $this->processorManager = $effect_manager;
+  public function __construct(ImageAPIOptimizeProcessorManager $processor_manager) {
+    $this->processorManager = $processor_manager;
   }
 
   /**
@@ -55,7 +55,7 @@ class ImageAPIOptimizeProcessorAddForm extends ImageAPIOptimizeProcessorFormBase
    */
   protected function prepareImageAPIOptimizeProcessor($imageapi_optimize_processor) {
     $imageapi_optimize_processor = $this->processorManager->createInstance($imageapi_optimize_processor);
-    // Set the initial weight so this effect comes last.
+    // Set the initial weight so this processor comes last.
     $imageapi_optimize_processor->setWeight(count($this->imageAPIOptimizePipeline->getProcessors()));
     return $imageapi_optimize_processor;
   }

src/ImageAPIOptimizePipelineInterface.php

@@ -45,7 +45,7 @@ interface ImageAPIOptimizePipelineInterface extends ConfigEntityInterface {
   /**
    * Returns a specific image optimize processor.
    *
-   * @param string $effect
+   * @param string $processor
    *   The image optimize processor ID.
    *
    * @return \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorInterface
@@ -54,7 +54,7 @@ interface ImageAPIOptimizePipelineInterface extends ConfigEntityInterface {
   public function getProcessor($processor);
 
   /**
-   * Returns the image optimize processors for this style.
+   * Returns the image optimize processors for this pipeline.
    *
    * @return \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorPluginCollection|\Drupal\imageapi_optimize\ImageAPIOptimizeProcessorInterface[]
    *   The image optimize processor plugin collection.
@@ -75,12 +75,12 @@ interface ImageAPIOptimizePipelineInterface extends ConfigEntityInterface {
   /**
    * Deletes an image optimize processor from this pipeline.
    *
-   * @param \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorInterface $effect
+   * @param \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorInterface $processor
    *   The image optimize processor object.
    *
    * @return $this
    */
-  public function deleteProcessor(ImageAPIOptimizeProcessorInterface $effect);
+  public function deleteProcessor(ImageAPIOptimizeProcessorInterface $processor);
 
   /**
    * Flushes cached media for this pipeline.

src/ImageAPIOptimizePipelineStorage.php

@@ -18,7 +18,7 @@ class ImageAPIOptimizePipelineStorage extends ConfigEntityStorage implements Ima
    *
    * @var string[]
    *
-   * @see \Drupal\imageapi_optimize\Form\ImageStyleDeleteForm::submitForm()
+   * @see \Drupal\imageapi_optimize\Form\ImageAPIOptimizePipelineDeleteForm::submitForm()
    */
   protected $replacement = [];
 

src/ImageAPIOptimizePipelineStorageInterface.php

@@ -10,9 +10,9 @@ interface ImageAPIOptimizePipelineStorageInterface {
   /**
    * Stores a replacement ID for an image optimize pipeline being deleted.
    *
-   * The method stores a replacement style to be used by the configuration
-   * dependency system when a image optimize pipeline is deleted. The replacement style is
-   * replacing the deleted style in other configuration entities that are
+   * The method stores a replacement pipeline to be used by the configuration
+   * dependency system when a image optimize pipeline is deleted. The replacement pipeline is
+   * replacing the deleted pipeline in other configuration entities that are
    * depending on the image optimize pipeline being deleted.
    *
    * @param string $name
@@ -33,7 +33,7 @@ interface ImageAPIOptimizePipelineStorageInterface {
    * @return string|null
    *   The ID of the image optimize pipeline used as replacement, if there's any, or NULL.
    *
-   * @see \Drupal\imageapi_optimize\ImageStyleStorageInterface::setReplacementId()
+   * @see \Drupal\imageapi_optimize\ImageAPIOptimizePipelineStorageInterface::setReplacementId()
    */
   public function getReplacementId($name);
 
@@ -45,7 +45,7 @@ interface ImageAPIOptimizePipelineStorageInterface {
    * @param string $name
    *   The ID of the image optimize pipeline to be replaced.
    *
-   * @see \Drupal\imageapi_optimize\ImageStyleStorageInterface::setReplacementId()
+   * @see \Drupal\imageapi_optimize\ImageAPIOptimizePipelineStorageInterface::setReplacementId()
    */
   public function clearReplacementId($name);
 

src/ImageAPIOptimizeProcessorBase.php

@@ -11,11 +11,11 @@ use Symfony\Component\DependencyInjection\ContainerInterface;
 /**
  * Provides a base class for image optimize processors.
  *
- * @see \Drupal\imageapi_optimize\Annotation\ImageEffect
- * @see \Drupal\imageapi_optimize\ImageEffectInterface
- * @see \Drupal\imageapi_optimize\ConfigurableImageEffectInterface
- * @see \Drupal\imageapi_optimize\ConfigurableImageEffectBase
- * @see \Drupal\imageapi_optimize\ImageEffectManager
+ * @see \Drupal\imageapi_optimize\Annotation\ImageAPIOptimizeProcessor
+ * @see \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorInterface
+ * @see \Drupal\imageapi_optimize\ConfigurableImageAPIOptimizeProcessorInterface
+ * @see \Drupal\imageapi_optimize\ConfigurableImageAPIOptimizeProcessorBase
+ * @see \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorManager
  * @see plugin_api
  */
 abstract class ImageAPIOptimizeProcessorBase extends PluginBase implements ImageAPIOptimizeProcessorInterface, ContainerFactoryPluginInterface {