A few function comment rules and doc comment rules removed (drupal-graphql#1066)

Author: Dylan203

graphql.install

@@ -1,5 +1,10 @@
 <?php
 
+/**
+ * @file
+ * Install, update and uninstall functions for the GraphQL module.
+ */
+
 /**
  * Implements hook_requirements().
  */

graphql.module

@@ -1,5 +1,10 @@
 <?php
 
+/**
+ * @file
+ * Primary module hooks for GraphQL module.
+ */
+
 /**
  * Implements hook_help().
  */

phpcs.xml.dist

@@ -28,17 +28,10 @@
     <exclude name="Drupal.Commenting.DocComment.ParamGroup"/>
     <exclude name="Drupal.Commenting.DocComment.ShortFullStop"/>
     <exclude name="Drupal.Commenting.DocComment.SpacingAfter"/>
-    <exclude name="Drupal.Commenting.DocComment.SpacingBeforeTags"/>
-    <exclude name="Drupal.Commenting.DocComment.TagGroupSpacing"/>
-    <exclude name="Drupal.Commenting.DocCommentAlignment.SpaceBeforeStar"/>
-    <exclude name="Drupal.Commenting.FileComment.Missing"/>
-    <exclude name="Drupal.Commenting.FunctionComment.IncorrectParamVarName"/>
-    <exclude name="Drupal.Commenting.FunctionComment.IncorrectTypeHint"/>
-    <exclude name="Drupal.Commenting.FunctionComment.InvalidNoReturn"/>
-    <exclude name="Drupal.Commenting.FunctionComment.InvalidReturn"/>
     <exclude name="Drupal.Commenting.FunctionComment.MissingParamComment"/>
     <exclude name="Drupal.Commenting.FunctionComment.MissingParamType"/>
     <exclude name="Drupal.Commenting.FunctionComment.MissingReturnComment"/>
+    <exclude name="Drupal.Commenting.FunctionComment.InvalidNoReturn"/>
   </rule>
 
 </ruleset>

src/GraphQL/Execution/FieldContext.php

@@ -97,7 +97,7 @@ public function getContextValue($name) {
    * @param string $name
    *   The name of the context.
    *
-   * @return boolean
+   * @return bool
    *   TRUE if the context exists, FALSE Otherwise.
    */
   public function hasContextValue($name) {

src/GraphQL/Execution/ResolveContext.php

@@ -177,7 +177,7 @@ public function getContextValue(ResolveInfo $info, $name) {
    * @param string $name
    *   The name of the context.
    *
-   * @return boolean
+   * @return bool
    *   TRUE if the context exists, FALSE Otherwise.
    */
   public function hasContextValue(ResolveInfo $info, $name) {

src/GraphQL/Resolver/Context.php

@@ -27,7 +27,7 @@ class Context implements ResolverInterface {
    * Context constructor.
    *
    * @param $name
-   * @param NULL $default
+   * @param $default
    */
   public function __construct($name, $default = NULL) {
     $this->name = $name;

src/GraphQL/Resolver/Path.php

@@ -46,7 +46,7 @@ class Path implements ResolverInterface {
    *
    * @param $type
    * @param $path
-   * @param \Drupal\graphql\GraphQL\Resolver\ResolverInterface|NULL $value
+   * @param \Drupal\graphql\GraphQL\Resolver\ResolverInterface|null $value
    */
   public function __construct($type, $path, ResolverInterface $value = NULL) {
     $this->type = $type;

src/GraphQL/Resolver/SourceContext.php

@@ -26,7 +26,7 @@ class SourceContext implements ResolverInterface {
    * SourceContext constructor.
    *
    * @param $name
-   * @param \Drupal\graphql\GraphQL\Resolver\ResolverInterface|NULL $source
+   * @param \Drupal\graphql\GraphQL\Resolver\ResolverInterface|null $source
    */
   public function __construct($name, ResolverInterface $source = NULL) {
     $this->name = $name;

src/GraphQL/ResolverBuilder.php

@@ -34,7 +34,7 @@ public function produce($id, $config = []) {
   }
 
   /**
-   * @param \Drupal\graphql\GraphQL\Resolver\ResolverInterface[] $resolvers
+   * @param \Drupal\graphql\GraphQL\Resolver\ResolverInterface[]|array $resolvers
    *
    * @return \Drupal\graphql\GraphQL\Resolver\Composite
    */

src/Plugin/GraphQL/DataProducer/DataProducerProxy.php

@@ -142,6 +142,7 @@ public function cached($cached = TRUE) {
    * @param \Drupal\graphql\GraphQL\Execution\FieldContext $field
    *
    * @return mixed
+   *
    * @throws \Drupal\Component\Plugin\Exception\PluginException
    */
   public function resolve($value, $args, ResolveContext $context, ResolveInfo $info, FieldContext $field) {

src/Plugin/GraphQL/DataProducer/Entity/EntityAccess.php

@@ -32,8 +32,8 @@ class EntityAccess extends DataProducerPluginBase {
 
   /**
    * @param \Drupal\Core\Entity\EntityInterface $entity
-   * @param NULL $operation
-   * @param NULL $user
+   * @param $operation
+   * @param $user
    *
    * @return bool|\Drupal\Core\Access\AccessResultInterface
    */

src/Plugin/GraphQL/DataProducer/Entity/EntityLoad.php

@@ -130,11 +130,11 @@ public function __construct(
   /**
    * @param $type
    * @param $id
-   * @param NULL $language
+   * @param $language
    * @param array|null $bundles
-   * @param bool $access
-   * @param \Drupal\Core\Session\AccountInterface|NULL $accessUser
-   * @param string $accessOperation
+   * @param bool|null $access
+   * @param \Drupal\Core\Session\AccountInterface|null $accessUser
+   * @param string|null $accessOperation
    * @param \Drupal\graphql\GraphQL\Execution\FieldContext $context
    *
    * @return \GraphQL\Deferred

src/Plugin/GraphQL/DataProducer/Entity/EntityLoadByUuid.php

@@ -132,9 +132,9 @@ public function __construct(
    * @param $uuid
    * @param array|string $language
    * @param array|string $bundles
-   * @param bool $access
-   * @param \Drupal\Core\Session\AccountInterface|NULL $accessUser
-   * @param string $accessOperation
+   * @param bool|null $access
+   * @param \Drupal\Core\Session\AccountInterface|null $accessUser
+   * @param string|null $accessOperation
    * @param \Drupal\graphql\GraphQL\Execution\FieldContext $context
    *
    * @return \GraphQL\Deferred

src/Plugin/GraphQL/DataProducer/Entity/EntityLoadMultiple.php

@@ -130,16 +130,16 @@ public function __construct(
   /**
    * @param $type
    * @param array $ids
-   * @param NULL $language
+   * @param $language
    * @param array|null $bundles
    * @param bool $access
-   * @param \Drupal\Core\Session\AccountInterface|NULL $accessUser
-   * @param string $accessOperation
+   * @param \Drupal\Core\Session\AccountInterface|null $accessUser
+   * @param string|null $accessOperation
    * @param \Drupal\graphql\GraphQL\Execution\FieldContext $context
    *
    * @return \GraphQL\Deferred
    */
-  public function resolve($type, array $ids, $language, ?array $bundles, ?bool $access, ?AccountInterface $accessUser, ?string $accessOperation, FieldContext $context) {
+  public function resolve($type, array $ids, $language, ?array $bundles, bool $access, ?AccountInterface $accessUser, string $accessOperation, FieldContext $context) {
     $resolver = $this->entityBuffer->add($type, $ids);
 
     return new Deferred(function () use ($type, $ids, $language, $bundles, $resolver, $context, $access, $accessUser, $accessOperation) {

src/Plugin/GraphQL/DataProducer/Entity/EntityTranslation.php

@@ -90,9 +90,9 @@ public function __construct(array $configuration, $pluginId, $pluginDefinition,
   /**
    * @param \Drupal\Core\Entity\EntityInterface $entity
    * @param $language
-   * @param bool $access
-   * @param \Drupal\graphql\Plugin\GraphQL\DataProducer\Entity\AccountInterface|NULL $accessUser
-   * @param string $accessOperation
+   * @param bool|null $access
+   * @param \Drupal\graphql\Plugin\GraphQL\DataProducer\Entity\AccountInterface|null $accessUser
+   * @param string|null $accessOperation
    *
    * @return |null
    */

src/Plugin/GraphQL/DataProducer/Entity/EntityTranslations.php

@@ -89,9 +89,9 @@ public function __construct(array $configuration, $pluginId, $pluginDefinition,
 
   /**
    * @param \Drupal\Core\Entity\EntityInterface $entity
-   * @param bool $access
-   * @param \Drupal\Core\Session\AccountInterface|NULL $accessUser
-   * @param string $accessOperation
+   * @param bool|null $access
+   * @param \Drupal\Core\Session\AccountInterface|null $accessUser
+   * @param string|null $accessOperation
    *
    * @return array|null
    */

src/Plugin/GraphQL/DataProducer/Field/EntityReference.php

@@ -132,11 +132,11 @@ public function __construct(
   /**
    * @param \Drupal\Core\Entity\EntityInterface $entity
    * @param $field
-   * @param NULL $language
+   * @param $language
    * @param array|null $bundles
-   * @param bool $access
-   * @param \Drupal\Core\Session\AccountInterface|NULL $accessUser
-   * @param string $accessOperation
+   * @param bool|null $access
+   * @param \Drupal\Core\Session\AccountInterface|null $accessUser
+   * @param string|null $accessOperation
    * @param \Drupal\graphql\GraphQL\Execution\FieldContext $context
    *
    * @return \GraphQL\Deferred|null

src/Plugin/GraphQL/DataProducer/Field/EntityReferenceLayoutRevisions.php

@@ -147,7 +147,7 @@ public function __construct(
    * @return \GraphQL\Deferred|null
    *   A promise that will return entities or NULL if there aren't any.
    */
-  public function resolve(EntityInterface $entity, string $field, ?string $language, ?array $bundles, ?bool $access, ?AccountInterface $accessUser, ?string $accessOperation, FieldContext $context): ?Deferred {
+  public function resolve(EntityInterface $entity, string $field, ?string $language, ?array $bundles, bool $access, ?AccountInterface $accessUser, string $accessOperation, FieldContext $context): ?Deferred {
     if (!$entity instanceof FieldableEntityInterface || !$entity->hasField($field)) {
       return NULL;
     }

src/Plugin/GraphQL/DataProducer/Field/EntityReferenceRevisions.php

@@ -147,7 +147,7 @@ public function __construct(
    * @return \GraphQL\Deferred|null
    *   A promise that will return entities or NULL if there aren't any.
    */
-  public function resolve(EntityInterface $entity, string $field, ?string $language, ?array $bundles, ?bool $access, ?AccountInterface $accessUser, ?string $accessOperation, FieldContext $context): ?Deferred {
+  public function resolve(EntityInterface $entity, string $field, ?string $language, ?array $bundles, bool $access, ?AccountInterface $accessUser, string $accessOperation, FieldContext $context): ?Deferred {
     if (!$entity instanceof FieldableEntityInterface || !$entity->hasField($field)) {
       return NULL;
     }

src/Plugin/GraphQL/DataProducer/Taxonomy/TaxonomyLoadTree.php

@@ -145,7 +145,7 @@ public function __construct(
    * @return \GraphQL\Deferred|null
    *   A promise that will return entities or NULL if there aren't any.
    */
-  public function resolve(string $vid, ?int $parent, ?int $max_depth, ?string $language, ?bool $access, ?AccountInterface $accessUser, ?string $accessOperation, FieldContext $context): ?Deferred {
+  public function resolve(string $vid, int $parent, ?int $max_depth, ?string $language, bool $access, ?AccountInterface $accessUser, string $accessOperation, FieldContext $context): ?Deferred {
     if (!isset($max_depth)) {
       $max_depth = self::MAX_DEPTH;
     }

tests/src/Kernel/DataProducer/XML/XMLTestBase.php

@@ -23,6 +23,7 @@ public function loadDocument() {
 
   /**
    * Returns the source of the test document.
+   *
    * @return bool|string
    */
   public function getDocumentSource() {

tests/src/Traits/HttpRequestTrait.php

@@ -59,7 +59,7 @@ protected function query($query, $server = NULL, array $variables = [], array $e
    *
    * @param string[] $queries
    *   A set of queries to be executed in one go.
-   * @param \Drupal\graphql\Entity\Server $server
+   * @param \Drupal\graphql\Entity\ServerInterface $server
    *   The server instance.
    *
    * @return \Symfony\Component\HttpFoundation\Response