Address code sniffer issues

Created on 17 September 2025, 2 days ago

Problem/Motivation

phpcs reports,

FILE: .../web/modules/custom/services/tests/src/Unit/Entity/ServiceResourceTest.php
--------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 4 LINES
--------------------------------------------------------------------------------
15 | ERROR | [x] Missing function doc comment
| | (Drupal.Commenting.FunctionComment.Missing)
34 | ERROR | [x] Missing function doc comment
| | (Drupal.Commenting.FunctionComment.Missing)
50 | ERROR | [x] Missing function doc comment
| | (Drupal.Commenting.FunctionComment.Missing)
66 | ERROR | [x] Missing function doc comment
| | (Drupal.Commenting.FunctionComment.Missing)
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------
FILE: ...t/services/web/modules/custom/services/src/ServiceResourceOptionsTrait.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
7 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------
FILE: ...ject/services/web/modules/custom/services/src/ServiceResourceInterface.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
--------------------------------------------------------------------------------
9 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
31 | ERROR | Description for the @return value is missing
| | (Drupal.Commenting.FunctionComment.MissingReturnComment)
--------------------------------------------------------------------------------
FILE: ...ject/services/web/modules/custom/services/src/ServiceEndpointInterface.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
15 | ERROR | Description for the @return value is missing
| | (Drupal.Commenting.FunctionComment.MissingReturnComment)
--------------------------------------------------------------------------------
FILE: ...ervices/web/modules/custom/services/src/ServiceDefinitionPluginManager.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
9 | ERROR | [x] Missing class doc comment
| | (Drupal.Commenting.ClassComment.Missing)
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------
FILE: ...ct/services/web/modules/custom/services/src/ServiceDefinitionInterface.php
--------------------------------------------------------------------------------
FOUND 7 ERRORS AND 1 WARNING AFFECTING 8 LINES
--------------------------------------------------------------------------------
15 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
21 | ERROR | Description for the @return value is missing
| | (Drupal.Commenting.FunctionComment.MissingReturnComment)
28 | ERROR | Description for the @return value is missing
| | (Drupal.Commenting.FunctionComment.MissingReturnComment)
35 | ERROR | Description for the @return value is missing
| | (Drupal.Commenting.FunctionComment.MissingReturnComment)
42 | ERROR | Description for the @return value is missing
| | (Drupal.Commenting.FunctionComment.MissingReturnComment)
49 | ERROR | Description for the @return value is missing
| | (Drupal.Commenting.FunctionComment.MissingReturnComment)
56 | ERROR | Description for the @return value is missing
| | (Drupal.Commenting.FunctionComment.MissingReturnComment)
63 | ERROR | Description for the @return value is missing
| | (Drupal.Commenting.FunctionComment.MissingReturnComment)
--------------------------------------------------------------------------------
FILE: .../modules/custom/services/src/ServiceDefinitionEntityRequestContentBase.php
--------------------------------------------------------------------------------
FOUND 7 ERRORS AND 1 WARNING AFFECTING 8 LINES
--------------------------------------------------------------------------------
14 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
17 | ERROR | Missing short description in doc comment
| | (Drupal.Commenting.DocComment.MissingShort)
29 | ERROR | Missing short description in doc comment
| | (Drupal.Commenting.DocComment.MissingShort)
30 | ERROR | Missing parameter comment
| | (Drupal.Commenting.FunctionComment.MissingParamComment)
31 | ERROR | Missing parameter comment
| | (Drupal.Commenting.FunctionComment.MissingParamComment)
32 | ERROR | Missing parameter comment
| | (Drupal.Commenting.FunctionComment.MissingParamComment)
33 | ERROR | Missing parameter comment
| | (Drupal.Commenting.FunctionComment.MissingParamComment)
43 | ERROR | Description for the @return value is missing
| | (Drupal.Commenting.FunctionComment.MissingReturnComment)
--------------------------------------------------------------------------------
FILE: ...project/services/web/modules/custom/services/src/ServiceDefinitionBase.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
12 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------
FILE: .../services/web/modules/custom/services/src/StackMiddleware/FormatSetter.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
16 | ERROR | Doc comment short description must be on a single line, further
| | text should be a separate paragraph
| | (Drupal.Commenting.DocComment.ShortSingleLine)
--------------------------------------------------------------------------------
FILE: ...oject/services/web/modules/custom/services/src/Routing/ServiceEndpoint.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
9 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------
FILE: ...modules/custom/services/src/Plugin/ServiceDefinition/VocabularyTreeGet.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
12 | ERROR | Missing short description in doc comment
| | (Drupal.Commenting.DocComment.MissingShort)
--------------------------------------------------------------------------------
FILE: ...es/web/modules/custom/services/src/Plugin/ServiceDefinition/UserLogout.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
13 | ERROR | Missing short description in doc comment
| | (Drupal.Commenting.DocComment.MissingShort)
--------------------------------------------------------------------------------
FILE: ...ces/web/modules/custom/services/src/Plugin/ServiceDefinition/UserLogin.php
--------------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 3 LINES
--------------------------------------------------------------------------------
22 | ERROR | Missing short description in doc comment
| | (Drupal.Commenting.DocComment.MissingShort)
73 | ERROR | Parameter $configuration is not described in comment
| | (Drupal.Commenting.FunctionComment.ParamMissingDefinition)
73 | ERROR | Parameter $plugin_id is not described in comment
| | (Drupal.Commenting.FunctionComment.ParamMissingDefinition)
73 | ERROR | Parameter $plugin_definition is not described in comment
| | (Drupal.Commenting.FunctionComment.ParamMissingDefinition)
84 | ERROR | Missing parameter comment
| | (Drupal.Commenting.FunctionComment.MissingParamComment)
--------------------------------------------------------------------------------
FILE: ...es/web/modules/custom/services/src/Plugin/ServiceDefinition/EntityView.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
17 | ERROR | Missing short description in doc comment
| | (Drupal.Commenting.DocComment.MissingShort)
--------------------------------------------------------------------------------
FILE: ...ces/web/modules/custom/services/src/Plugin/ServiceDefinition/EntityPut.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
13 | ERROR | Missing short description in doc comment
| | (Drupal.Commenting.DocComment.MissingShort)
--------------------------------------------------------------------------------
FILE: ...es/web/modules/custom/services/src/Plugin/ServiceDefinition/EntityPost.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
14 | ERROR | Missing short description in doc comment
| | (Drupal.Commenting.DocComment.MissingShort)
--------------------------------------------------------------------------------
FILE: ...s/web/modules/custom/services/src/Plugin/ServiceDefinition/EntityIndex.php
--------------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 6 LINES
--------------------------------------------------------------------------------
13 | ERROR | Missing short description in doc comment
| | (Drupal.Commenting.DocComment.MissingShort)
44 | ERROR | Missing short description in doc comment
| | (Drupal.Commenting.DocComment.MissingShort)
45 | ERROR | Missing parameter comment
| | (Drupal.Commenting.FunctionComment.MissingParamComment)
46 | ERROR | Missing parameter comment
| | (Drupal.Commenting.FunctionComment.MissingParamComment)
47 | ERROR | Missing parameter comment
| | (Drupal.Commenting.FunctionComment.MissingParamComment)
48 | ERROR | Missing parameter comment
| | (Drupal.Commenting.FunctionComment.MissingParamComment)
--------------------------------------------------------------------------------
FILE: ...ces/web/modules/custom/services/src/Plugin/ServiceDefinition/EntityGet.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
11 | ERROR | Missing short description in doc comment
| | (Drupal.Commenting.DocComment.MissingShort)
--------------------------------------------------------------------------------
FILE: .../web/modules/custom/services/src/Plugin/ServiceDefinition/EntityDelete.php
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
11 | ERROR | Missing short description in doc comment
| | (Drupal.Commenting.DocComment.MissingShort)
--------------------------------------------------------------------------------
FILE: ...ices/web/modules/custom/services/src/Plugin/ServiceDefinition/AliasGet.php
--------------------------------------------------------------------------------
FOUND 11 ERRORS AFFECTING 10 LINES
--------------------------------------------------------------------------------
17 | ERROR | Missing short description in doc comment
| | (Drupal.Commenting.DocComment.MissingShort)
29 | ERROR | Missing short description in doc comment
| | (Drupal.Commenting.DocComment.MissingShort)
34 | ERROR | Missing member variable doc comment
| | (Drupal.Commenting.VariableComment.Missing)
43 | ERROR | Missing short description in doc comment
| | (Drupal.Commenting.DocComment.MissingShort)
44 | ERROR | Missing parameter comment
| | (Drupal.Commenting.FunctionComment.MissingParamComment)
45 | ERROR | Missing parameter comment
| | (Drupal.Commenting.FunctionComment.MissingParamComment)
46 | ERROR | Missing parameter comment
| | (Drupal.Commenting.FunctionComment.MissingParamComment)
47 | ERROR | Missing parameter comment
| | (Drupal.Commenting.FunctionComment.MissingParamComment)
71 | ERROR | Missing parameter comment
| | (Drupal.Commenting.FunctionComment.MissingParamComment)
71 | ERROR | Missing parameter type
| | (Drupal.Commenting.FunctionComment.MissingParamType)
73 | ERROR | Description for the @return value is missing
| | (Drupal.Commenting.FunctionComment.MissingReturnComment)
--------------------------------------------------------------------------------
FILE: ...ect/services/web/modules/custom/services/src/Plugin/Deriver/EntityView.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
--------------------------------------------------------------------------------
10 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
28 | WARNING | Translatable strings must not begin or end with white spaces,
| | use placeholders with t() for variables
| | (Drupal.Semantics.FunctionT.WhiteSpace)
--------------------------------------------------------------------------------
FILE: ...ject/services/web/modules/custom/services/src/Plugin/Deriver/EntityPut.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
10 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------
FILE: ...ect/services/web/modules/custom/services/src/Plugin/Deriver/EntityPost.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
9 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------
FILE: ...ct/services/web/modules/custom/services/src/Plugin/Deriver/EntityIndex.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
9 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------
FILE: ...ject/services/web/modules/custom/services/src/Plugin/Deriver/EntityGet.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
10 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------
FILE: ...t/services/web/modules/custom/services/src/Plugin/Deriver/EntityDelete.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
10 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------
FILE: ...oject/services/web/modules/custom/services/src/Plugin/Deriver/AliasGet.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
9 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------
FILE: ...ject/services/web/modules/custom/services/src/Form/ServiceSettingsForm.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
11 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------
FILE: ...ervices/web/modules/custom/services/src/Form/ServiceResourceDeleteForm.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
11 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------
FILE: ...ervices/web/modules/custom/services/src/Form/ServiceResourceConfigForm.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
10 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------
FILE: .../services/web/modules/custom/services/src/Form/ServiceResourceBaseForm.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
11 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------
FILE: ...ject/services/web/modules/custom/services/src/Form/ServiceEndpointForm.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
12 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------
FILE: ...web/modules/custom/services/src/Entity/ServicesEntityCreateAccessCheck.php
--------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
--------------------------------------------------------------------------------
25 | ERROR | Missing member variable doc comment
| | (Drupal.Commenting.VariableComment.Missing)
27 | ERROR | Missing member variable doc comment
| | (Drupal.Commenting.VariableComment.Missing)
36 | ERROR | Parameter $serializer is not described in comment
| | (Drupal.Commenting.FunctionComment.ParamMissingDefinition)
--------------------------------------------------------------------------------
FILE: ...s/project/services/web/modules/custom/services/src/Controller/Services.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
16 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------
FILE: ...t/services/web/modules/custom/services/src/Access/CSRFTokenAccessCheck.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------
14 | WARNING | The class short comment should describe what the class does and
| | not simply repeat the class name
| | (Drupal.Commenting.ClassComment.Short)
--------------------------------------------------------------------------------

Steps to reproduce

see https://git.drupalcode.org/project/services/-/jobs/1759209

Remaining tasks

make a MR with these changes.

πŸ“Œ Task
Status

Active

Version

5.0

Component

Code

Created by

πŸ‡ΊπŸ‡ΈUnited States BenStallings

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Merge request !19address phpcs warnings β†’ (Open) created by BenStallings
  • Pipeline finished with Success
    2 days ago
    Total: 192s
    #601689
  • Pipeline finished with Success
    2 days ago
    Total: 191s
    #601698
  • Pipeline finished with Success
    2 days ago
    Total: 124s
    #601705
Production build 0.71.5 2024