Fix phpcs Drupal.Commenting issues [#3411808]

Problem/Motivation

Fix phpcs errors for

Drupal.Commenting.DocComment
Drupal.Commenting.FunctionComment
Drupal.Commenting.InlineVariableComment
Drupal.Commenting.ClassComment
Drupal.Commenting.DataTypeNamespace
Drupal.Commenting.Deprecated
Drupal.Commenting.FileComment
Drupal.Commenting.InlineComment

Command:

phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,info,txt,md,yml,twig modules/custom/pathauto/ --sniffs="Drupal.Commenting.DocComment,Drupal.Commenting.FunctionComment,Drupal.Commenting.InlineVariableComment,Drupal.Commenting.ClassComment,Drupal.Commenting.DataTypeNamespace,Drupal.Commenting.Deprecated,Drupal.Commenting.FileComment,Drupal.Commenting.InlineComment"

Result:


FILE: /tests/modules/pathauto_custom_punctuation_test/pathauto_custom_punctuation_test.module
-------------------
FOUND 1 ERROR AFFECTING 1 LINE
-------------------
 1 | ERROR | [x] Missing file doc comment
-------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------


FILE: /tests/src/Functional/PathautoNodeWebTest.php
--------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------
 182 | ERROR | Missing short description in doc comment
--------------


FILE: /tests/src/Functional/PathautoBulkUpdateTest.php
-----------------
FOUND 1 ERROR AFFECTING 1 LINE
-----------------
 73 | ERROR | [x] Missing function doc comment
-----------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------


FILE: /tests/src/Functional/PathautoEnablingEntityTypesTest.php
---
FOUND 1 ERROR AFFECTING 1 LINE
---
 61 | ERROR | Doc comment short description must be on a single line, further text should be a separate paragraph
---


FILE: /tests/src/Kernel/PathautoTokenTest.php
--------
FOUND 2 ERRORS AND 1 WARNING AFFECTING 3 LINES
--------
  23 | ERROR   | [x] Missing function doc comment
  39 | WARNING | [x] Inline @var declarations should use the /** */ delimiters
 124 | ERROR   | [x] Missing function doc comment
--------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------


FILE: /tests/src/Kernel/PathautoEntityWithStringIdTest.php
---------------------
FOUND 2 ERRORS AFFECTING 2 LINES
---------------------
 78 | ERROR | [ ] Parameter tags must be defined first in a doc comment
 79 | ERROR | [x] Parameter comment must end with a full stop
---------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------


FILE: /tests/src/FunctionalJavascript/PathautoLocaleTest.php
---
FOUND 1 ERROR AFFECTING 1 LINE
---
 45 | ERROR | Doc comment short description must be on a single line, further text should be a separate paragraph
---


FILE: /tests/src/FunctionalJavascript/PathautoUiTest.php
-------------------
FOUND 2 ERRORS AFFECTING 2 LINES
-------------------
 60 | ERROR | [x] Missing function doc comment
 70 | ERROR | [x] Missing function doc comment
-------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------


FILE: /pathauto.api.php
---------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------
 10 | ERROR | Missing short description in doc comment
---------------------------------


FILE: /pathauto.module
----
FOUND 1 ERROR AFFECTING 1 LINE
----
 151 | ERROR | Doc comment short description must be on a single line, further text should be a separate paragraph
----


FILE: /src/PathautoGeneratorInterface.php
-------
FOUND 10 ERRORS AFFECTING 7 LINES
-------
 13 | ERROR | [ ] Doc comment short description must start with a capital letter
 13 | ERROR | [ ] Doc comment short description must end with a full stop
 18 | ERROR | [ ] Doc comment short description must start with a capital letter
 18 | ERROR | [ ] Doc comment short description must end with a full stop
 23 | ERROR | [ ] Doc comment short description must start with a capital letter
 23 | ERROR | [ ] Doc comment short description must end with a full stop
 53 | ERROR | [ ] Description for the @return value is missing
 76 | ERROR | [x] Data types in @param tags need to be fully namespaced
 81 | ERROR | [ ] Parameter comment must start with a capital letter
 82 | ERROR | [x] Parameter comment must end with a full stop
-------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------


FILE: /src/Entity/PathautoPattern.php

FOUND 4 ERRORS AFFECTING 4 LINES

 101 | ERROR | [ ] Missing short description in doc comment
 127 | ERROR | [ ] Missing short description in doc comment
 132 | ERROR | [ ] Missing short description in doc comment
 410 | ERROR | [x] Parameter comment must end with a full stop

PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY



FILE: /src/Form/PatternEditForm.php
-----------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
-----------------------------------
  25 | ERROR | [ ] Missing short description in doc comment
 112 | ERROR | [x] Inline comments must start with a capital letter
-----------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------


FILE: /src/Plugin/Deriver/EntityAliasTypeDeriver.php
---------------
FOUND 2 ERRORS AFFECTING 2 LINES
---------------
 23 | ERROR | Missing short description in doc comment
 35 | ERROR | Missing short description in doc comment
---------------


FILE: /src/Plugin/pathauto/AliasType/EntityAliasTypeBase.php

FOUND 2 ERRORS AFFECTING 1 LINE

 300 | ERROR | The text '@deprecated Use \Drupal\pathauto\PathautoState::bulkDelete() instead.' does not match the standard format: @deprecated in %deprecation-version% and is removed from %removal-version%. %extra-info%.
 300 | ERROR | Each @deprecated tag must have a @see tag immediately following it



FILE: /src/EventSubscriber/PathautoSettingsCacheTag.php
------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------
 16 | ERROR | Missing short description in doc comment
------------------


FILE: /src/AliasStorageHelperInterface.php
-----
FOUND 1 ERROR AFFECTING 1 LINE
-----
 105 | ERROR | Missing parameter type
-----


FILE: /src/PathautoFieldItemList.php
------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
------------------------------------
  7 | ERROR | [x] Missing class doc comment
  9 | ERROR | [ ] Missing short description in doc comment
 29 | ERROR | [ ] Missing short description in doc comment
------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------


FILE: /src/PathautoState.php
---------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
---------------------------------
  30 | ERROR | Missing short description in doc comment
 123 | ERROR | Description for the @return value is missing
---------------------------------


FILE: /src/PathautoPatternInterface.php
--
FOUND 11 ERRORS AFFECTING 11 LINES
--
  15 | ERROR | Description for the @return value is missing
  22 | ERROR | Missing parameter comment
  31 | ERROR | Description for the @return value is missing
  35 | ERROR | Missing short description in doc comment
  36 | ERROR | Description for the @return value is missing
  43 | ERROR | Description for the @return value is missing
  60 | ERROR | Description for the @return value is missing
 128 | ERROR | Description for the @return value is missing
 149 | ERROR | Description for the @return value is missing
 174 | ERROR | Missing parameter type
 177 | ERROR | Description for the @return value is missing
--


FILE: /src/PathautoPatternListBuilder.php
----
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
----
 40 | WARNING | [x] Inline @var declarations should use the /** */ delimiters
----
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----


FILE: /src/AliasCleanerInterface.php
------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------
 5 | ERROR | Missing short description in doc comment
------------------------------------


FILE: /src/Commands/PathautoCommands.php
--------
FOUND 11 ERRORS AFFECTING 11 LINES
--------
  65 | ERROR | [ ] Doc comment short description must start with a capital letter
  69 | ERROR | [ ] Parameter tags must be defined first in a doc comment
 107 | ERROR | [ ] Parameter $options is not described in comment
 108 | ERROR | [x] Doc comment short description must end with a full stop
 112 | ERROR | [ ] Parameter tags must be defined first in a doc comment
 170 | ERROR | [ ] Missing short description in doc comment
 183 | ERROR | [ ] Missing short description in doc comment
 197 | ERROR | [ ] Missing short description in doc comment
 201 | ERROR | [ ] @throws tag comment must end with a full stop
 216 | ERROR | [ ] Missing short description in doc comment
 220 | ERROR | [ ] @throws tag comment must end with a full stop
--------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

Comment	File	Size	Author
#19	pathauto_MR67.png	130.17 KB	roberttabigue

Issue fork pathauto-3411808

Show commands

Start within a Git clone of the project using the version control instructions.

Add & fetch this issue fork’s repository

Or, if you do not have SSH keys set up on git.drupalcode.org:

Add & fetch this issue fork’s repository

3411808-fix-phpcs-drupal.commenting changes, plain diff MR !67
Check out this branch for the first time

Check out existing branch, if you already have it locally

About issue forks

Comments

Comment #1

1 January 2024 at 23:35

Nikolay Shapovalov created an issue. See original summary.

Comment #2

2 January 2024 at 04:42

Anjali Mehta made their first commit to this issue’s fork.

Comment #3

2 January 2024 at 13:00

sakthi_dev made their first commit to this issue’s fork.

Comment #4

2 January 2024 at 13:01

sakthi_dev opened merge request !67

Comment #5

sakthi_dev commented 2 January 2024 at 13:01

Status:

Needs work

» Needs review

Please review.

Comment #6

nikolay shapovalov commented 2 January 2024 at 13:36

Status:

Needs review

» Needs work

Thanks for you contribution, I didn't check changes yet.
There are 2 issues left in the tests/src/Functional/PathautoBulkUpdateTest.php.

FILE: ...es/custom/pathauto-3411808/tests/src/Functional/PathautoBulkUpdateTest.php
--------------------------------------------------------------------------------
 20 | ERROR   | [x] Expected 2 space(s) before asterisk; 3 found
    |         |     (Drupal.Commenting.DocCommentAlignment.SpaceBeforeStar)
 21 | ERROR   | [x] Expected 2 space(s) before asterisk; 3 found
    |         |     (Drupal.Commenting.DocCommentAlignment.SpaceBeforeStar)

And 6 new violations of type Squiz.WhiteSpace.SuperfluousWhitespace.EndLine were introduced in current MR state.

Source https://git.drupalcode.org/issue/pathauto-3411808/-/jobs/558800

Comment #8

berdir

German

Switzerland

commented 3 January 2024 at 23:03

Tests are currently failing, I will not commit low prio things like coding standard fixes until they pass again. The test fails are likely caused by Drupal 10.2 changes. I suggest opening a separate issue to investigate and fix those first.

Comment #9

nikolay shapovalov commented 11 January 2024 at 22:50

Tests fixed now, ready for review.

Comment #10

nikolay shapovalov commented 18 January 2024 at 07:40

Update MR, add phpcs.xml file and exclude rules that will be fixed in different issues.
Gitlab CI check phpcs passed.

Comment #11

berdir

German

Switzerland

commented 23 January 2024 at 22:17

Status:

Needs review

» Needs work

Comment #12

sakthi_dev commented 30 January 2024 at 14:44

Addressed some comments in MR. Please fix others.

Comment #13

nikolay shapovalov commented 30 January 2024 at 20:50

Issue summary:

View changes

Update phpcs report.

Comment #14

akshaydalvi212 commented 1 April 2024 at 11:57

Assigned:

Unassigned

» akshaydalvi212

Comment #15

akshaydalvi212 commented 1 April 2024 at 13:07

Assigned:	akshaydalvi212	» Unassigned
Status:	Needs work	» Needs review

Resolved the remaining phpcs issues.
kindly review.

Comment #16

nikolay shapovalov commented 20 June 2024 at 06:22

Assigned:	Unassigned	» nikolay shapovalov
Status:	Needs review	» Needs work

@akshaydalvi212 thanks for your contribution, this issue is only about to fix Drupal.Commenting violations.
I will revert commit b043409c, because it contains changes not related to these cs rules.
And I will resolve merge conflict.

Comment #17

nikolay shapovalov commented 20 June 2024 at 08:49

Assigned:	nikolay shapovalov	» Unassigned
Issue summary:	View changes
Status:	Needs work	» Needs review

I resolved merge conflict and updated some comments.
CS Report updated in the IS.
Ready for review.

During review please take a closer look at order of @hook, @throws, @annotation in src/Commands/PathautoCommands.php not sure, that this is correct order, welcome for suggestions.

And I don't know how to fix "Missing short description in doc comment" at pathauto.api.php:10. This is last one from Drupal.Commenting in code base for now,

Comment #18

28 October 2025 at 17:00

jeremy1606 made their first commit to this issue’s fork.

Comment #19

roberttabigue commented 20 January 2026 at 16:50

Status:

Needs review

» Reviewed & tested by the community

Status	File	Size
new	pathauto_MR67.png	130.17 KB

Hi,

I have applied the latest MR!67 to the Pathauto module (8.x-1.x-dev) on my local Drupal setup, confirmed all PHPCS errors have been fixed.

I ran this command on the module:
phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,info,txt,md,yml,twig pathauto/ --sniffs="Drupal.Commenting.DocComment,Drupal.Commenting.FunctionComment,Drupal.Commenting.InlineVariableComment,Drupal.Commenting.ClassComment,Drupal.Commenting.DataTypeNamespace,Drupal.Commenting.Deprecated,Drupal.Commenting.FileComment,Drupal.Commenting.InlineComment"

Please see the attached file for reference.

I'm moving this now to "RTBC".

Thank you!

Comment #20

mably commented 11 February 2026 at 22:24

Status:

Reviewed & tested by the community

» Fixed

Comment #21

11 February 2026 at 22:24

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Comment #22

mably commented 11 February 2026 at 22:34

Status:

Fixed

» Closed (fixed)

Fix phpcs Drupal.Commenting issues

Problem/Motivation

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

Issue fork pathauto-3411808

Comments

Comment #1

Comment #2

Comment #3

Comment #4

Comment #5

Comment #6

Comment #7

Comment #8

Comment #9

Comment #10

Comment #11

Comment #12

Comment #13

Comment #14

Comment #15

Comment #16

Comment #17

Comment #18

Comment #19

Comment #20

Comment #21

Comment #22

Parent issue

News items

Our community

Documentation

Drupal code base

Governance of community