docs(class): Add class doc comments (#1136)

Author: klausi

examples/graphql_example/src/Wrappers/QueryConnection.php

@@ -5,6 +5,9 @@
 use Drupal\Core\Entity\Query\QueryInterface;
 use GraphQL\Deferred;
 
+/**
+ * Helper class that wraps entity queries.
+ */
 class QueryConnection {
 
   /**

phpcs.xml.dist

@@ -17,66 +17,6 @@
     <exclude-pattern>src/GraphQL/ResolverBuilder.php</exclude-pattern>
   </rule>
 
-  <!-- TODO: those rules are disabled for now until we fix the coding standards for them. -->
-  <rule ref="Drupal.Commenting.ClassComment.Missing">
-    <exclude-pattern>src/PermissionProvider.php</exclude-pattern>
-    <exclude-pattern>src/GraphqlServiceProvider.php</exclude-pattern>
-    <exclude-pattern>src/RouteProvider.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Resolver/ResolverInterface.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Resolver/SourceContext.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Resolver/Callback.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Resolver/Composite.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Resolver/Argument.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Resolver/Value.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Resolver/Context.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Resolver/ParentValue.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Resolver/Map.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Resolver/Tap.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/ResolverRegistryInterface.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Execution/Executor.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Execution/FieldContext.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Execution/ExecutorFactory.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Execution/ExecutionResult.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Execution/ResolveContext.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/ResolverBuilder.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Utility/DocumentSerializer.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Utility/Introspection.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Utility/DeferredUtility.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Utility/JsonHelper.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/ResolverRegistry.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Buffers/EntityUuidBuffer.php</exclude-pattern>
-    <exclude-pattern>src/GraphQL/Buffers/EntityBuffer.php</exclude-pattern>
-    <exclude-pattern>src/Event/OperationEvent.php</exclude-pattern>
-    <exclude-pattern>src/Access/VoyagerAccessCheck.php</exclude-pattern>
-    <exclude-pattern>src/Access/ExplorerAccessCheck.php</exclude-pattern>
-    <exclude-pattern>src/Access/QueryAccessCheck.php</exclude-pattern>
-    <exclude-pattern>src/Form/PersistedQueriesForm.php</exclude-pattern>
-    <exclude-pattern>src/EventSubscriber/OperationSubscriber.php</exclude-pattern>
-    <exclude-pattern>src/EventSubscriber/CurrentLanguageResetTrait.php</exclude-pattern>
-    <exclude-pattern>src/EventSubscriber/SubrequestSubscriber.php</exclude-pattern>
-    <exclude-pattern>src/Cache/Context/StaticCacheContext.php</exclude-pattern>
-    <exclude-pattern>src/Routing/QueryRouteEnhancer.php</exclude-pattern>
-    <exclude-pattern>src/Entity/ServerInterface.php</exclude-pattern>
-    <exclude-pattern>src/Plugin/PersistedQueryPluginManager.php</exclude-pattern>
-    <exclude-pattern>src/Plugin/SchemaExtensionPluginInterface.php</exclude-pattern>
-    <exclude-pattern>src/Plugin/DataProducerPluginInterface.php</exclude-pattern>
-    <exclude-pattern>src/Plugin/GraphQL/DataProducer/DataProducerPluginBase.php</exclude-pattern>
-    <exclude-pattern>src/Plugin/GraphQL/DataProducer/DataProducerPluginCachingTrait.php</exclude-pattern>
-    <exclude-pattern>src/Plugin/GraphQL/Schema/SdlSchemaPluginBase.php</exclude-pattern>
-    <exclude-pattern>src/Plugin/GraphQL/SchemaExtension/SdlSchemaExtensionPluginBase.php</exclude-pattern>
-    <exclude-pattern>src/Plugin/DataProducerPluginManager.php</exclude-pattern>
-    <exclude-pattern>src/Plugin/PersistedQueryPluginInterface.php</exclude-pattern>
-    <exclude-pattern>src/Plugin/SchemaPluginInterface.php</exclude-pattern>
-    <exclude-pattern>src/Plugin/DataProducerPluginCachingInterface.php</exclude-pattern>
-    <exclude-pattern>src/Controller/RequestController.php</exclude-pattern>
-    <exclude-pattern>src/SubRequestResponse.php</exclude-pattern>
-    <exclude-pattern>src/PersistedQuery/PersistedQueryPluginBase.php</exclude-pattern>
-    <exclude-pattern>examples/graphql_example/src/Wrappers/QueryConnection.php</exclude-pattern>
-    <exclude-pattern>tests/src/Traits/MockingTrait.php</exclude-pattern>
-    <exclude-pattern>tests/src/Traits/DataProducerExecutionTrait.php</exclude-pattern>
-    <exclude-pattern>tests/src/Kernel/GraphQLTestBase.php</exclude-pattern>
-  </rule>
-
   <rule ref="Drupal.Commenting.DocComment.MissingShort">
     <exclude-pattern>src/GraphQL/Resolver/Path.php</exclude-pattern>
     <exclude-pattern>src/GraphQL/ResolverRegistryInterface.php</exclude-pattern>

src/Access/ExplorerAccessCheck.php

@@ -7,6 +7,9 @@
 use Drupal\Core\Session\AccountInterface;
 use Drupal\graphql\Entity\ServerInterface;
 
+/**
+ * Grants access to the GraphQL explorer for admins.
+ */
 class ExplorerAccessCheck implements AccessInterface {
 
   /**

src/Access/QueryAccessCheck.php

@@ -8,6 +8,9 @@
 use Drupal\graphql\Entity\ServerInterface;
 use Symfony\Component\HttpFoundation\RequestStack;
 
+/**
+ * Grants access to executing arbitrary GraphQL queries on the defined servers.
+ */
 class QueryAccessCheck implements AccessInterface {
 
   /**

src/Access/VoyagerAccessCheck.php

@@ -7,6 +7,9 @@
 use Drupal\Core\Session\AccountInterface;
 use Drupal\graphql\Entity\ServerInterface;
 
+/**
+ * Grants access to the GraphQL voyager for admins.
+ */
 class VoyagerAccessCheck implements AccessInterface {
 
   /**

src/Cache/Context/StaticCacheContext.php

@@ -5,6 +5,11 @@
 use Drupal\Core\Cache\CacheableMetadata;
 use Drupal\Core\Cache\Context\CalculatedCacheContextInterface;
 
+/**
+ * Helper class, not sure for what.
+ *
+ * @todo This class and service seems unused, can we remove it?
+ */
 class StaticCacheContext implements CalculatedCacheContextInterface {
 
   /**

src/Controller/RequestController.php

@@ -8,6 +8,9 @@
 use GraphQL\Server\OperationParams;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
+/**
+ * The main GraphQL request handler that will forward to the responsible server.
+ */
 class RequestController implements ContainerInjectionInterface {
 
   /**

src/Entity/Server.php

@@ -27,6 +27,11 @@
 use GraphQL\Validator\DocumentValidator;
 
 /**
+ * The main GraphQL configuration and request entry point.
+ *
+ * Multiple GraphQL servers can be defined on different routing paths with
+ * different GraphQL schemas.
+ *
  * @ConfigEntityType(
  *   id = "graphql_server",
  *   label = @Translation("Server"),

src/Entity/ServerInterface.php

@@ -6,6 +6,9 @@
 use Drupal\graphql\Plugin\PersistedQueryPluginInterface;
 use GraphQL\Server\OperationParams;
 
+/**
+ * Defines a GraphQL server that has configuration and executes queries.
+ */
 interface ServerInterface extends ConfigEntityInterface {
 
   /**

src/Event/OperationEvent.php

@@ -6,6 +6,9 @@
 use GraphQL\Executor\ExecutionResult;
 use Symfony\Component\EventDispatcher\Event;
 
+/**
+ * Represents an event that is triggered before and after a GraphQL operation.
+ */
 class OperationEvent extends Event {
 
   /**