change docblocks to please phpcs

bircher · bircher · commit cd6c4cecf866 · 2020-09-14T13:36:40.000+02:00
diff --git a/src/Driver/Cores/CoreInterface.php b/src/Driver/Cores/CoreInterface.php
@@ -5,9 +5,7 @@
 use Drupal\Driver\Cores\CoreInterface as OriginalCoreInterface;
 
 /**
- * Interface CoreInterface.
- *
- * @package NuvoleWeb\Drupal\Driver\Cores
+ * Adding more methods to the core interface.
  */
 interface CoreInterface extends OriginalCoreInterface {
 
diff --git a/src/Driver/Cores/Drupal6.php b/src/Driver/Cores/Drupal6.php
@@ -5,9 +5,7 @@
 use Drupal\Driver\Cores\Drupal6 as OriginalDrupal6;
 
 /**
- * Class Drupal6.
- *
- * @package NuvoleWeb\Drupal\Driver\Cores
+ * Extending the Drupal 6 direver.
  */
 class Drupal6 extends OriginalDrupal6 {
 
diff --git a/src/Driver/Cores/Drupal7.php b/src/Driver/Cores/Drupal7.php
@@ -5,9 +5,7 @@
 use Drupal\Driver\Cores\Drupal7 as OriginalDrupal7;
 
 /**
- * Class Drupal7.
- *
- * @package NuvoleWeb\Drupal\Driver\Cores
+ * Extending the Drupal 7 direver.
  */
 class Drupal7 extends OriginalDrupal7 {
 
diff --git a/src/Driver/Cores/Drupal8.php b/src/Driver/Cores/Drupal8.php
@@ -21,9 +21,7 @@
 use Webmozart\Assert\Assert;
 
 /**
- * Class Drupal8.
- *
- * @package NuvoleWeb\Drupal\Driver\Cores
+ * Extending the Drupal 8 direver with more methods.
  */
 class Drupal8 extends OriginalDrupal8 implements CoreInterface {
 
diff --git a/src/Driver/Objects/Drupal8/EditableConfig.php b/src/Driver/Objects/Drupal8/EditableConfig.php
@@ -5,9 +5,7 @@
 use NuvoleWeb\Drupal\Driver\Objects\EditableConfigInterface;
 
 /**
- * Class EditableConfig.
- *
- * @package NuvoleWeb\Drupal\Driver\Objects\Drupal8
+ * Simple abstraction for editable config.
  */
 class EditableConfig implements EditableConfigInterface {
 
diff --git a/src/Driver/Objects/Drupal8/State.php b/src/Driver/Objects/Drupal8/State.php
@@ -5,9 +5,7 @@
 use NuvoleWeb\Drupal\Driver\Objects\StateInterface;
 
 /**
- * Class State.
- *
- * @package NuvoleWeb\Drupal\Driver\Objects\Drupal8
+ * Simple state abstraction.
  */
 class State implements StateInterface {
 
diff --git a/src/Driver/Objects/EditableConfigInterface.php b/src/Driver/Objects/EditableConfigInterface.php
@@ -3,8 +3,6 @@
 namespace NuvoleWeb\Drupal\Driver\Objects;
 
 /**
- * Interface EditableConfigInterface.
- *
  * This is in essence an interface for Drupal 8s \Drupal\Core\Config\Config.
  */
 interface EditableConfigInterface {
diff --git a/src/DrupalExtension/Component/PyStringYamlParser.php b/src/DrupalExtension/Component/PyStringYamlParser.php
@@ -6,9 +6,7 @@
 use Symfony\Component\Yaml\Yaml;
 
 /**
- * Class PyStringYamlParser.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Component
+ * Our YAML parser.
  */
 class PyStringYamlParser {
 
diff --git a/src/DrupalExtension/Component/RandomGeneratorComponent.php b/src/DrupalExtension/Component/RandomGeneratorComponent.php
@@ -3,9 +3,7 @@
 namespace NuvoleWeb\Drupal\DrupalExtension\Component;
 
 /**
- * Class RandomGeneratorComponent.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Component
+ * Random generator component for easy test values.
  */
 class RandomGeneratorComponent {
 
diff --git a/src/DrupalExtension/Component/ResolutionComponent.php b/src/DrupalExtension/Component/ResolutionComponent.php
@@ -5,9 +5,7 @@
 use Webmozart\Assert\Assert;
 
 /**
- * Class ResolutionComponent.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Component
+ * Resolution component to work with screen resolutions.
  */
 class ResolutionComponent {
 
diff --git a/src/DrupalExtension/Context/CKEditorContext.php b/src/DrupalExtension/Context/CKEditorContext.php
@@ -5,9 +5,7 @@
 use Behat\MinkExtension\Context\RawMinkContext;
 
 /**
- * Class CKEditorContext.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Context
+ * CKEditor Context step definitions.
  */
 class CKEditorContext extends RawMinkContext {
 
diff --git a/src/DrupalExtension/Context/ChosenFieldContext.php b/src/DrupalExtension/Context/ChosenFieldContext.php
@@ -6,9 +6,7 @@
 use Behat\Mink\Exception\ExpectationException;
 
 /**
- * Class ChosenFieldContext.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Context
+ * Chosen context step definitions.
  */
 class ChosenFieldContext extends RawMinkContext {
 
diff --git a/src/DrupalExtension/Context/ContentContext.php b/src/DrupalExtension/Context/ContentContext.php
@@ -7,9 +7,7 @@
 use Webmozart\Assert\Assert;
 
 /**
- * Class ContentContext.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Context
+ * Content context step definitions.
  */
 class ContentContext extends RawDrupalContext {
 
diff --git a/src/DrupalExtension/Context/DrupalContext.php b/src/DrupalExtension/Context/DrupalContext.php
@@ -8,8 +8,6 @@
  * Extends Drupal Extension DrupalContext class.
  *
  * Load this context instead of Drupal\DrupalExtension\Context\DrupalContext.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Context
  */
 class DrupalContext extends RawDrupalContext {
 
diff --git a/src/DrupalExtension/Context/Initializer/ServiceContainerInitializer.php b/src/DrupalExtension/Context/Initializer/ServiceContainerInitializer.php
@@ -8,9 +8,7 @@
 use NuvoleWeb\Drupal\DrupalExtension\Context\ServiceContainerAwareInterface;
 
 /**
- * Class ServiceContainer.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Context\Initializer
+ * Service Container Initializer gives easy access to the container.
  */
 class ServiceContainerInitializer implements ContextInitializer {
 
diff --git a/src/DrupalExtension/Context/MenuContext.php b/src/DrupalExtension/Context/MenuContext.php
@@ -7,9 +7,7 @@
 use Behat\Mink\Exception\ExpectationException;
 
 /**
- * Class MenuContext.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Context
+ * Menu context step definitions.
  */
 class MenuContext extends RawDrupalContext {
 
diff --git a/src/DrupalExtension/Context/PositionContext.php b/src/DrupalExtension/Context/PositionContext.php
@@ -5,9 +5,7 @@
 use Behat\Mink\Exception\ExpectationException;
 
 /**
- * Class PositionContext.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Context
+ * Position context to determine the order of elements.
  */
 class PositionContext extends RawMinkContext {
 
diff --git a/src/DrupalExtension/Context/RawDrupalContext.php b/src/DrupalExtension/Context/RawDrupalContext.php
@@ -6,9 +6,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
- * Class RawDrupalContext.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Context
+ * The raw drupal context extended with the service container.
  */
 class RawDrupalContext extends OriginalRawDrupalContext implements ServiceContainerAwareInterface {
 
diff --git a/src/DrupalExtension/Context/RawMinkContext.php b/src/DrupalExtension/Context/RawMinkContext.php
@@ -8,9 +8,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
- * Class RawMinkContext.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Context
+ * Extended raw mink context with service container.
  */
 class RawMinkContext extends OriginalRawMinkContext implements ServiceContainerAwareInterface {
 
diff --git a/src/DrupalExtension/Context/ResponsiveContext.php b/src/DrupalExtension/Context/ResponsiveContext.php
@@ -6,9 +6,7 @@
 use Webmozart\Assert\Assert;
 
 /**
- * Class ResponsiveContext.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Context
+ * Responsive Context for responsive tests.
  */
 class ResponsiveContext extends RawMinkContext {
 
diff --git a/src/DrupalExtension/Context/ScreenShotContext.php b/src/DrupalExtension/Context/ScreenShotContext.php
@@ -9,9 +9,7 @@
 use Behat\Testwork\Tester\Result\TestResult;
 
 /**
- * Class ScreenShotContext.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Context
+ * Screenshot context for taking screenshots.
  */
 class ScreenShotContext extends RawMinkContext {
 
diff --git a/src/DrupalExtension/Context/SelectFieldContext.php b/src/DrupalExtension/Context/SelectFieldContext.php
@@ -7,9 +7,7 @@
 use Behat\Mink\Exception\ExpectationException;
 
 /**
- * Class SelectFieldContext.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Context
+ * Select field context to work with select fields.
  */
 class SelectFieldContext extends RawMinkContext {
 
@@ -24,7 +22,7 @@ public function assertSelectOptions($select, TableNode $options) {
       throw new ExpectationException("Field '$select' not found.", $this->getSession());
     }
 
-    /* @var \Behat\Mink\Element\NodeElement $field */
+    /** @var \Behat\Mink\Element\NodeElement $field */
 
     // Check that the specified field is a <select> field.
     $this->assertElementType($field, 'select');
@@ -62,7 +60,7 @@ public function assertNoSelectOptions($select, TableNode $options) {
       throw new ExpectationException("Field '$select' not found.", $this->getSession());
     }
 
-    /* @var \Behat\Mink\Element\NodeElement $field */
+    /** @var \Behat\Mink\Element\NodeElement $field */
 
     // Check that the specified field is a <select> field.
     $this->assertElementType($field, 'select');
@@ -128,7 +126,7 @@ protected function getSelectedOptionByLabel($select, $option_label, $check_selec
       throw new ExpectationException("Field '$select' not found.", $this->getSession());
     }
 
-    /* @var \Behat\Mink\Element\NodeElement $field */
+    /** @var \Behat\Mink\Element\NodeElement $field */
 
     // Check that the specified field is a <select> field.
     $this->assertElementType($field, 'select');
diff --git a/src/DrupalExtension/Context/ServiceContainerAwareInterface.php b/src/DrupalExtension/Context/ServiceContainerAwareInterface.php
@@ -5,9 +5,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
- * Interface ServiceContainerAwareInterface.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Context
+ * Define a service container aware interface.
  */
 interface ServiceContainerAwareInterface {
 
diff --git a/src/DrupalExtension/Context/TaxonomyTermContext.php b/src/DrupalExtension/Context/TaxonomyTermContext.php
@@ -5,9 +5,7 @@
 use Behat\Mink\Exception\ExpectationException;
 
 /**
- * Class TaxonomyTermContext.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Context
+ * Taxonomy term context with sep definitions.
  */
 class TaxonomyTermContext extends RawDrupalContext {
 
diff --git a/src/DrupalExtension/Context/VisibilityContext.php b/src/DrupalExtension/Context/VisibilityContext.php
@@ -7,9 +7,7 @@
 use Behat\Mink\Exception\UnsupportedDriverActionException;
 
 /**
- * Class VisibilityContext.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\Context
+ * Visibility context with step definitions.
  */
 class VisibilityContext extends RawMinkContext {
 
diff --git a/src/DrupalExtension/ServiceContainer/DrupalExtension.php b/src/DrupalExtension/ServiceContainer/DrupalExtension.php
@@ -9,9 +9,7 @@
 use Drupal\DrupalExtension\ServiceContainer\DrupalExtension as OriginalDrupalExtension;
 
 /**
- * Class DrupalExtension.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\ServiceContainer
+ * Drupal extension which loads the service container.
  */
 class DrupalExtension extends OriginalDrupalExtension {
 
diff --git a/src/DrupalExtension/ServiceProvider/BehatServiceProvider.php b/src/DrupalExtension/ServiceProvider/BehatServiceProvider.php
@@ -7,9 +7,7 @@
 use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
 
 /**
- * Class BehatServiceProvider.
- *
- * @package NuvoleWeb\Drupal\DrupalExtension\ServiceProvider
+ * Behat service provider for getting parameter overrides.
  */
 class BehatServiceProvider extends ServiceProviderBase {
 
