Skip to content

Commit 21dd433

Browse files
authored
A few FunctionComment Rules removed (#1064)
1 parent 557a925 commit 21dd433

18 files changed

Lines changed: 53 additions & 20 deletions

File tree

phpcs.xml.dist

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,9 @@
3636
<exclude name="Drupal.Commenting.FunctionComment.IncorrectTypeHint"/>
3737
<exclude name="Drupal.Commenting.FunctionComment.InvalidNoReturn"/>
3838
<exclude name="Drupal.Commenting.FunctionComment.InvalidReturn"/>
39-
<exclude name="Drupal.Commenting.FunctionComment.Missing"/>
4039
<exclude name="Drupal.Commenting.FunctionComment.MissingParamComment"/>
41-
<exclude name="Drupal.Commenting.FunctionComment.MissingParamName"/>
4240
<exclude name="Drupal.Commenting.FunctionComment.MissingParamType"/>
4341
<exclude name="Drupal.Commenting.FunctionComment.MissingReturnComment"/>
44-
<exclude name="Drupal.Commenting.FunctionComment.ParamCommentIndentation"/>
45-
<exclude name="Drupal.Commenting.FunctionComment.ParamMissingDefinition"/>
46-
<exclude name="Drupal.Commenting.FunctionComment.ParamNameNoMatch"/>
47-
<exclude name="Drupal.Commenting.FunctionComment.ReturnCommentIndentation"/>
4842
</rule>
4943

5044
</ruleset>

src/Entity/ServerInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public function addPersistedQueryInstance(PersistedQueryPluginInterface $queryPl
4141
* Removes a Persisted Query plugin instance from the persisted queries set.
4242
*
4343
* @param string $queryPluginId
44-
* The plugin id to be removed.
44+
* The plugin id to be removed.
4545
*/
4646
public function removePersistedQueryInstance($queryPluginId);
4747

src/Form/ServerForm.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,9 @@ public function validateForm(array &$form, FormStateInterface $formState) {
227227
}
228228
}
229229

230+
/**
231+
* {@inheritdoc}
232+
*/
230233
public function submitForm(array &$form, FormStateInterface $formState) {
231234
parent::submitForm($form, $formState);
232235

src/Plugin/DataProducerPluginManager.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ class DataProducerPluginManager extends DefaultPluginManager {
3434
* @param \Traversable $namespaces
3535
* An object that implements \Traversable which contains the root paths
3636
* keyed by the corresponding namespace to look for plugin implementations.
37+
* @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
38+
* * The module handler.
39+
* @param \Drupal\Core\Cache\CacheBackendInterface $definitionCacheBackend
3740
* @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
3841
* @param \Drupal\Core\Cache\Context\CacheContextsManager $contextsManager
3942
* @param \Drupal\Core\Cache\CacheBackendInterface $resultCacheBackend
40-
* @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
41-
* The module handler.
42-
* @param \Drupal\Core\Cache\CacheBackendInterface $definitionCacheBackend
4343
* @param string|null $pluginInterface
4444
* The interface each plugin should implement.
4545
* @param string $pluginAnnotationName

src/Plugin/GraphQL/DataProducer/Utility/Seek.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ class Seek extends DataProducerPluginBase {
2727

2828
/**
2929
* @param array $input
30-
* The input array.
31-
* @param int position
32-
* The position to seek.
30+
* The input array.
31+
* @param int $position
32+
* The position to seek.
3333
* @return mixed
34-
* The element at the specified position.
34+
* The element at the specified position.
3535
*/
3636
public function resolve(array $input, $position) {
3737
$array_object = new \ArrayObject($input);

src/Plugin/GraphQL/DataProducer/XML/XMLAttribute.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ class XMLAttribute extends DataProducerPluginBase {
2727

2828
/**
2929
* @param \DOMElement $dom
30-
* The source (root) DOM element.
30+
* The source (root) DOM element.
3131
* @param string $name
32-
* The name of the attribute.
32+
* The name of the attribute.
3333
* @return string
3434
*/
3535
public function resolve(\DOMElement $dom, $name) {

src/Plugin/GraphQL/DataProducer/XML/XMLContent.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class XMLContent extends DataProducerPluginBase {
2424

2525
/**
2626
* @param \DOMElement $dom
27-
* The source (root) DOM element.
27+
* The source (root) DOM element.
2828
* @return string
2929
*/
3030
public function resolve(\DOMElement $dom) {

src/Plugin/GraphQL/DataProducer/XML/XMLParse.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class XMLParse extends DataProducerPluginBase {
2424

2525
/**
2626
* @param string $input
27-
* The source input.
27+
* The source input.
2828
* @return \DOMElement
2929
*/
3030
public function resolve($input) {

src/Plugin/GraphQL/DataProducer/XML/XMLXpath.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ class XMLXpath extends DataProducerPluginBase {
2828

2929
/**
3030
* @param \DOMElement $dom
31-
* The source (root) DOM element.
31+
* The source (root) DOM element.
3232
* @param string $query
33-
* The xpath query.
33+
* The xpath query.
3434
* @return \DOMElement
3535
*/
3636
public function resolve(\DOMElement $dom, $query) {

tests/modules/graphql_persisted_queries_test/src/Plugin/GraphQL/PersistedQuery/PersistedQueryPluginOne.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ public function getQuery($id, OperationParams $operation) {
2525
return $queryMap[$id] ?? NULL;
2626
}
2727

28+
/**
29+
* Map between persisted query IDs and corresponding GraphQL queries.
30+
*/
2831
protected function queryMap() {
2932
return [
3033
'query_1' => 'query { field_one }',

0 commit comments

Comments
 (0)