Problem/Motivation

As a part of https://www.drupal.org/project/redirect/issues/2850121 we should fix the coding standard issues for:

  • Missing function doc comment
  • Missing class doc comment
  • Missing file doc comment

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

Release notes snippet

CommentFileSizeAuthor
#10 interdiff-4-10.txt24.14 KBnitin_lama
#10 3136894-missing_doc_comment-10.patch47.42 KBnitin_lama
#8 phpcs-redirect-8-august-2023.txt41.44 KBkristen pol
#4 3136894-missing_doc_comment-4.patch23.4 KBandralex
#2 3136894-missing_doc_comment-2.patch48.41 KBandralex

Issue fork redirect-3136894

Command icon Show commands

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

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

About issue forks

Comments

andralex created an issue. See original summary.

andralex’s picture

andralex commented
Title: Missing function doc comment » Missing doc comment
Issue summary: View changes
StatusFileSize
new 3136894-missing_doc_comment-2.patch48.41 KB

Attaching the patch that fixes listed errors.

andralex’s picture

andralex commented
Status: Active » Needs review
andralex’s picture

andralex commented
StatusFileSize
new 3136894-missing_doc_comment-4.patch23.4 KB

Fixed line endings in the patch file.

andralex’s picture

andralex commented
Version: 7.x-2.x-dev » 7.x-1.x-dev

Changed target version to 7.1 as was pointed in parent issue. The last patch is still relevant and needs to be reviewed.

ysamoylenko’s picture

ysamoylenko commented
Status: Needs review » Reviewed & tested by the community

The #4 looks good for me.
Please commit the changes.

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented
Assigned: Unassigned » kristen pol

Assigning to myself as I'm triaging all RTBC issues.

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented
Assigned: kristen pol » Unassigned
Category: Bug report » Task
Status: Reviewed & tested by the community » Needs work
StatusFileSize
new phpcs-redirect-8-august-2023.txt41.44 KB

Thanks for the issue, patch, and review.

Normally, we'd like one patch with all code standard fixes. See the guidelines on avoiding gaming the issue credit system:

https://www.drupal.org/drupalorg/docs/marketplace/abuse-of-the-contribut...

That said, there are a lot of PHPCS violations found with:

phpcs --standard=Drupal --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml .

See the attached file.

So, at minimum for this issue, it would be good to fix all doc comment and related issues. There are some in the attached file, such as Missing member variable doc comment in redirect.test.

nitin_lama’s picture

nitin_lama
he/him
Location India
commented
Assigned: Unassigned » nitin_lama
nitin_lama’s picture

nitin_lama
he/him
Location India
commented
StatusFileSize
new 3136894-missing_doc_comment-10.patch47.42 KB
new interdiff-4-10.txt24.14 KB

Providing updated patch.

nitin_lama opened merge request !53

nitin_lama’s picture

nitin_lama
he/him
Location India
commented
Assigned: nitin_lama » Unassigned

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

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

shruu_rao’s picture

shruu_rao commented

Hi,
Applied MR!53, can still see some errors.

FILE: C:\redirect\redirect.admin.inc
-----------------------------------------------------------------------------------------------------------------------------------------
FOUND 16 ERRORS AND 2 WARNINGS AFFECTING 17 LINES
-----------------------------------------------------------------------------------------------------------------------------------------
  85 | ERROR   | The array declaration extends to column 152 (the limit is 80). The array content should be split up over multiple lines
 220 | ERROR   | Missing parameter type
 222 | ERROR   | Missing parameter type
 284 | ERROR   | The array declaration extends to column 119 (the limit is 80). The array content should be split up over multiple lines
 285 | ERROR   | The array declaration extends to column 173 (the limit is 80). The array content should be split up over multiple lines
 310 | ERROR   | The array declaration extends to column 97 (the limit is 80). The array content should be split up over multiple lines
 370 | WARNING | Translatable strings must not begin or end with white spaces, use placeholders with t() for variables
 370 | ERROR   | The array declaration extends to column 299 (the limit is 80). The array content should be split up over multiple lines
 434 | ERROR   | The array declaration extends to column 422 (the limit is 80). The array content should be split up over multiple lines
 493 | ERROR   | The array declaration extends to column 299 (the limit is 80). The array content should be split up over multiple lines
 575 | ERROR   | The array declaration extends to column 316 (the limit is 80). The array content should be split up over multiple lines
 599 | ERROR   | The array declaration extends to column 111 (the limit is 80). The array content should be split up over multiple lines
 630 | ERROR   | The array declaration extends to column 158 (the limit is 80). The array content should be split up over multiple lines
 671 | ERROR   | The array declaration extends to column 422 (the limit is 80). The array content should be split up over multiple lines
 675 | WARNING | Avoid backslash escaping in translatable strings when possible, use "" quotes instead
 695 | ERROR   | The array declaration extends to column 384 (the limit is 80). The array content should be split up over multiple lines
 702 | ERROR   | The array declaration extends to column 165 (the limit is 80). The array content should be split up over multiple lines
 935 | ERROR   | The array declaration extends to column 152 (the limit is 80). The array content should be split up over multiple lines
-----------------------------------------------------------------------------------------------------------------------------------------


FILE: C:\redirect\redirect.api.php
-------------------------------------------------------------------------
FOUND 18 ERRORS AND 3 WARNINGS AFFECTING 21 LINES
-------------------------------------------------------------------------
  26 | WARNING | Line exceeds 80 characters; contains 85 characters
  36 | WARNING | Line exceeds 80 characters; contains 83 characters
  74 | ERROR   | Missing parameter type
  76 | ERROR   | Missing parameter type
  88 | ERROR   | Missing parameter type
  90 | ERROR   | Missing parameter type
  92 | ERROR   | Missing parameter type
 117 | WARNING | Line exceeds 80 characters; contains 81 characters
 126 | ERROR   | Missing parameter type
 129 | ERROR   | Missing parameter type
 134 | ERROR   | Missing parameter type
 138 | ERROR   | Return type missing for @return tag in function comment
 176 | ERROR   | Missing parameter type
 199 | ERROR   | Missing parameter type
 201 | ERROR   | Missing parameter type
 203 | ERROR   | Missing parameter type
 219 | ERROR   | Missing parameter type
 235 | ERROR   | Missing parameter type
 251 | ERROR   | Missing parameter type
 267 | ERROR   | Missing parameter type
 283 | ERROR   | Missing parameter type
-------------------------------------------------------------------------


FILE: C:\redirect\redirect.drush.inc
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  9 | WARNING | Format should be "* Implements hook_foo().", "* Implements hook_foo_BAR_ID_bar() for xyz_bar().",, "* Implements hook_foo_BAR_ID_bar() for
    |         | xyz-bar.html.twig.", "* Implements hook_foo_BAR_ID_bar() for xyz-bar.tpl.php.", or "* Implements hook_foo_BAR_ID_bar() for block templates."
 79 | ERROR   | The array declaration extends to column 139 (the limit is 80). The array content should be split up over multiple lines
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------


FILE: C:\redirect\redirect.generate.inc
-----------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
-----------------------------------------------------------------------------------------------------------------------------------------
 166 | WARNING | Line exceeds 80 characters; contains 88 characters
 185 | ERROR   | The array declaration extends to column 185 (the limit is 80). The array content should be split up over multiple lines
-----------------------------------------------------------------------------------------------------------------------------------------


FILE: C:\redirect\redirect.info
------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------------------------------------------------------------
 7 | ERROR | It's only necessary to declare files[] if they declare a class or interface.
------------------------------------------------------------------------------------------


FILE: C:\redirect\redirect.module
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 70 ERRORS AND 12 WARNINGS AFFECTING 78 LINES
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
   18 | ERROR   | Doc comment short description must be on a single line, further text should be a separate paragraph
   24 | ERROR   | Doc comment short description must be on a single line, further text should be a separate paragraph
   30 | ERROR   | Doc comment short description must be on a single line, further text should be a separate paragraph
  259 | WARNING | Line exceeds 80 characters; contains 83 characters
  259 | ERROR   | Comment indentation error, expected only 1 spaces
  260 | ERROR   | Comment indentation error, expected only 2 spaces
  261 | WARNING | Line exceeds 80 characters; contains 129 characters
  261 | ERROR   | Comment indentation error, expected only 4 spaces
  299 | ERROR   | Missing parameter type
  302 | ERROR   | Return type missing for @return tag in function comment
  512 | ERROR   | The array declaration extends to column 112 (the limit is 80). The array content should be split up over multiple lines
  523 | ERROR   | The array declaration extends to column 112 (the limit is 80). The array content should be split up over multiple lines
  534 | ERROR   | The array declaration extends to column 96 (the limit is 80). The array content should be split up over multiple lines
  541 | ERROR   | Missing parameter type
  543 | ERROR   | Missing parameter type
  546 | ERROR   | Return type missing for @return tag in function comment
  565 | ERROR   | Missing parameter type
  567 | ERROR   | Missing parameter type
  570 | ERROR   | Return type missing for @return tag in function comment
  583 | ERROR   | Missing parameter type
  585 | ERROR   | Missing parameter type
  587 | ERROR   | Missing parameter type
  624 | ERROR   | Missing parameter type
  626 | ERROR   | Missing parameter type
  628 | ERROR   | Missing parameter type
  630 | ERROR   | Missing parameter type
  633 | ERROR   | Return type missing for @return tag in function comment
  664 | WARNING | Line exceeds 80 characters; contains 91 characters
  678 | ERROR   | Missing parameter type
  680 | ERROR   | Missing parameter type
  683 | ERROR   | Missing parameter type
  686 | ERROR   | Return type missing for @return tag in function comment
  697 | ERROR   | Doc comment short description must be on a single line, further text should be a separate paragraph
  699 | ERROR   | Missing parameter type
  704 | ERROR   | Missing parameter type
  707 | ERROR   | Missing parameter type
  711 | ERROR   | Return type missing for @return tag in function comment
  731 | WARNING | Line exceeds 80 characters; contains 82 characters
  748 | WARNING | Line exceeds 80 characters; contains 81 characters
  776 | ERROR   | The array declaration extends to column 313 (the limit is 80). The array content should be split up over multiple lines
  817 | ERROR   | Missing parameter type
  916 | ERROR   | Missing parameter type
  931 | ERROR   | Missing parameter type
  960 | ERROR   | Missing parameter type
  963 | ERROR   | Parameter tags must be grouped together in a doc comment
  963 | ERROR   | Missing parameter name
  982 | ERROR   | Missing parameter type
  984 | ERROR   | Missing parameter type
  997 | ERROR   | Comment indentation error, expected only 1 spaces
 1000 | ERROR   | Comment indentation error, expected only 2 spaces
 1050 | ERROR   | Missing parameter type
 1085 | ERROR   | Missing parameter type
 1089 | ERROR   | Missing parameter type
 1093 | ERROR   | Return type missing for @return tag in function comment
 1133 | ERROR   | Missing parameter type
 1142 | ERROR   | The array declaration extends to column 140 (the limit is 80). The array content should be split up over multiple lines
 1160 | WARNING | Line exceeds 80 characters; contains 81 characters
 1175 | ERROR   | Comment indentation error, expected only 1 spaces
 1199 | WARNING | Line exceeds 80 characters; contains 84 characters
 1278 | ERROR   | Missing parameter type
 1281 | ERROR   | Return type missing for @return tag in function comment
 1320 | ERROR   | Return type missing for @return tag in function comment
 1360 | ERROR   | Missing parameter type
 1362 | ERROR   | Missing parameter type
 1365 | ERROR   | Return type missing for @return tag in function comment
 1392 | ERROR   | Missing parameter type
 1394 | ERROR   | Missing parameter type
 1397 | ERROR   | Return type missing for @return tag in function comment
 1415 | ERROR   | Missing parameter type
 1418 | ERROR   | Return type missing for @return tag in function comment
 1507 | ERROR   | Doc comment short description must end with a full stop
 1507 | ERROR   | Doc comment short description must be on a single line, further text should be a separate paragraph
 1579 | WARNING | Line exceeds 80 characters; contains 93 characters
 1612 | ERROR   | Return type missing for @return tag in function comment
 1648 | WARNING | Format should be "* Implements hook_foo().", "* Implements hook_foo_BAR_ID_bar() for xyz_bar().",, "* Implements hook_foo_BAR_ID_bar() for
      |         | xyz-bar.html.twig.", "* Implements hook_foo_BAR_ID_bar() for xyz-bar.tpl.php.", or "* Implements hook_foo_BAR_ID_bar() for block templates."
 1650 | ERROR   | All functions defined in a module file must be prefixed with the module's name, found "locale_form_redirect_edit_form_alter" but expected
      |         | "redirect_locale_form_redirect_edit_form_alter"
 1705 | ERROR   | The array declaration extends to column 100 (the limit is 80). The array content should be split up over multiple lines
 1726 | ERROR   | The array declaration extends to column 97 (the limit is 80). The array content should be split up over multiple lines
 1744 | WARNING | Line exceeds 80 characters; contains 82 characters
 1745 | WARNING | Line exceeds 80 characters; contains 82 characters
 1805 | WARNING | Format should be "* Implements hook_foo().", "* Implements hook_foo_BAR_ID_bar() for xyz_bar().",, "* Implements hook_foo_BAR_ID_bar() for
      |         | xyz-bar.html.twig.", "* Implements hook_foo_BAR_ID_bar() for xyz-bar.tpl.php.", or "* Implements hook_foo_BAR_ID_bar() for block templates."
 1807 | ERROR   | All functions defined in a module file must be prefixed with the module's name, found "mpac_form_redirect_edit_form_alter" but expected
      |         | "redirect_mpac_form_redirect_edit_form_alter"
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------


FILE: C:\redirect\redirect.test
-----------------------------------------------------------------------------------------------------------------------------------------
FOUND 21 ERRORS AND 5 WARNINGS AFFECTING 22 LINES
-----------------------------------------------------------------------------------------------------------------------------------------
  10 | WARNING | The class short comment should describe what the class does and not simply repeat the class name
  31 | ERROR   | The array declaration extends to column 163 (the limit is 80). The array content should be split up over multiple lines
  51 | ERROR   | Parameter $source_path is not described in comment
  51 | ERROR   | Parameter $redirect_path is not described in comment
  54 | ERROR   | Missing parameter type
  56 | ERROR   | Missing parameter type
 140 | WARNING | The class short comment should describe what the class does and not simply repeat the class name
 158 | ERROR   | The array declaration extends to column 91 (the limit is 80). The array content should be split up over multiple lines
 158 | ERROR   | The array declaration extends to column 90 (the limit is 80). The array content should be split up over multiple lines
 164 | ERROR   | The array declaration extends to column 86 (the limit is 80). The array content should be split up over multiple lines
 165 | ERROR   | The array declaration extends to column 94 (the limit is 80). The array content should be split up over multiple lines
 166 | ERROR   | The array declaration extends to column 89 (the limit is 80). The array content should be split up over multiple lines
 179 | ERROR   | The array declaration extends to column 92 (the limit is 80). The array content should be split up over multiple lines
 180 | ERROR   | The array declaration extends to column 95 (the limit is 80). The array content should be split up over multiple lines
 180 | ERROR   | The array declaration extends to column 94 (the limit is 80). The array content should be split up over multiple lines
 214 | ERROR   | The array declaration extends to column 197 (the limit is 80). The array content should be split up over multiple lines
 221 | ERROR   | Public method name "RedirectUnitTest::testParseURL" is not in lowerCamel format
 268 | WARNING | The class short comment should describe what the class does and not simply repeat the class name
 270 | ERROR   | Missing member variable doc comment
 270 | ERROR   | Class property $admin_user should use lowerCamel naming without underscores
 289 | ERROR   | The array declaration extends to column 194 (the limit is 80). The array content should be split up over multiple lines
 364 | ERROR   | The array declaration extends to column 105 (the limit is 80). The array content should be split up over multiple lines
 366 | WARNING | Line exceeds 80 characters; contains 96 characters
 390 | ERROR   | The array declaration extends to column 111 (the limit is 80). The array content should be split up over multiple lines
 391 | WARNING | Line exceeds 80 characters; contains 96 characters
 396 | ERROR   | The array declaration extends to column 112 (the limit is 80). The array content should be split up over multiple lines
-----------------------------------------------------------------------------------------------------------------------------------------


FILE: C:\redirect\views\redirect_handler_field_redirect_link_delete.inc
------------------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 3 LINES
------------------------------------------------------------------------------------------------------------------------------
 11 | ERROR | Class name must begin with a capital letter
 11 | ERROR | Class name must use UpperCamel naming without underscores
 24 | ERROR | Public method name "redirect_handler_field_redirect_link_delete::option_definition" is not in lowerCamel format
 33 | ERROR | Public method name "redirect_handler_field_redirect_link_delete::options_form" is not in lowerCamel format
------------------------------------------------------------------------------------------------------------------------------


FILE: C:\redirect\views\redirect_handler_field_redirect_link_edit.inc
----------------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------------------------------------------------------------
 11 | ERROR | Class name must begin with a capital letter
 11 | ERROR | Class name must use UpperCamel naming without underscores
 24 | ERROR | Public method name "redirect_handler_field_redirect_link_edit::option_definition" is not in lowerCamel format
 33 | ERROR | Public method name "redirect_handler_field_redirect_link_edit::options_form" is not in lowerCamel format
----------------------------------------------------------------------------------------------------------------------------


FILE: C:\redirect\views\redirect_handler_field_redirect_operations.inc
--------------------------------------------------------------------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 4 LINES
--------------------------------------------------------------------------------------------------------------------------------------
 11 | ERROR | Class name must begin with a capital letter
 11 | ERROR | Class name must use UpperCamel naming without underscores
 24 | ERROR | Public method name "redirect_handler_field_redirect_operations::option_definition" is not in lowerCamel format
 34 | ERROR | Public method name "redirect_handler_field_redirect_operations::options_form" is not in lowerCamel format
 81 | ERROR | The array declaration extends to column 127 (the limit is 80). The array content should be split up over multiple lines
 81 | ERROR | The array declaration extends to column 125 (the limit is 80). The array content should be split up over multiple lines
--------------------------------------------------------------------------------------------------------------------------------------


FILE: C:\redirect\views\redirect_handler_field_redirect_redirect.inc
---------------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 3 LINES
---------------------------------------------------------------------------------------------------------------------------
 11 | ERROR | Class name must begin with a capital letter
 11 | ERROR | Class name must use UpperCamel naming without underscores
 25 | ERROR | Public method name "redirect_handler_field_redirect_redirect::option_definition" is not in lowerCamel format
 36 | ERROR | Public method name "redirect_handler_field_redirect_redirect::options_form" is not in lowerCamel format
---------------------------------------------------------------------------------------------------------------------------


FILE: C:\redirect\views\redirect_handler_field_redirect_source.inc
-------------------------------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 3 LINES
-------------------------------------------------------------------------------------------------------------------------
 11 | ERROR | Class name must begin with a capital letter
 11 | ERROR | Class name must use UpperCamel naming without underscores
 25 | ERROR | Public method name "redirect_handler_field_redirect_source::option_definition" is not in lowerCamel format
 36 | ERROR | Public method name "redirect_handler_field_redirect_source::options_form" is not in lowerCamel format
-------------------------------------------------------------------------------------------------------------------------


FILE: C:\redirect\views\redirect_handler_filter_redirect_type.inc
--------------------------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AND 1 WARNING AFFECTING 3 LINES
--------------------------------------------------------------------------------------------------------------------------
 11 | ERROR   | Class name must begin with a capital letter
 11 | ERROR   | Class name must use UpperCamel naming without underscores
 16 | ERROR   | Public method name "redirect_handler_filter_redirect_type::get_value_options" is not in lowerCamel format
 22 | WARNING | Only string literals should be passed to t() where possible
--------------------------------------------------------------------------------------------------------------------------
wylbur’s picture

wylbur commented
Status: Needs work » Closed (outdated)

Closing this as Outdated as Drupal 7 is EOL.