Problem/Motivation

Rector inadvertently moved some def groups for the following files:

  • core/modules/field/src/Hook/FieldHooks.php
  • core/modules/system/src/Hook/SystemHooks.php
  • core/modules/node/src/Hook/NodeHooks1.php
  • core/modules/taxonomy/src/Hook/TaxonomyHooks.php

Check against 11.0 and see what those defgroups used to wrap and add the open and close in the right place.

e.g. in SystemHooks there is

 /**
   * @} End of "defgroup authorize".
   */

But in system.module there is:

/**
 * @defgroup authorize Authorized operations
 * @{

Steps to reproduce

Proposed resolution

  • Update the def groups to open and close in the appropriate files

Remaining tasks

Revert last commit
Add a phpcs ignore line
Make an issue in the Coder project for the problem of 'end of @defgoup' at the end of a class.
Make an issue in Core for removing the ignore line when the Coder issue is resolved.

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

Issue fork drupal-3488681

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:

Comments

nicxvan created an issue. See original summary.

m.gaebler’s picture

I am starting to work on this issue during Dictus Drupal Dev Day.

m.gaebler’s picture

Assigned: Unassigned » m.gaebler
avpaderno’s picture

Assigned: m.gaebler » Unassigned

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

juandhr’s picture

Status: Active » Needs review

needs-review-queue-bot’s picture

Status: Needs review » Needs work
StatusFileSize
new91 bytes

The Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

mradcliffe’s picture

I performed Novice Triage on this issue. I am leaving the Novice tag on this issue because there is a clearly defined task for resolution. The issue summary could use an update as well.

There were some test failures in the merge request, but I think those are false positives.

A waving hand indicating a greeting. Novice issue reserved for the Mentored Contribution during the DrupalCon Atlanta 2025 contribution day. After 2025.03.27, this issue returns to being open to all. Thanks
jazzsequence’s picture

I am looking at this issue at DrupalCon Atlanta. I am working with @heilop

jazzsequence’s picture

Issue summary: View changes
jazzsequence’s picture

Status: Needs work » Needs review

Reviewed the patch and confirmed that the def groups were opened and closed appropriately and the orphaned opens and closes were removed.

Automated testing is failing, I created new merge request to rerun tests.

heilop’s picture

As @jazzsequence mentioned, the MR request shows that the defgroup are looking good now.

After the new MR has been opened to re-run the tests, we can now confirm that the test passed. Also, the tests were run locally and passed as well.

mradcliffe’s picture

It looks like the issue summary has been updated. When updating the issue summary, we want to remember to remove the tag as well.

It would be nice to get another person to do a code review.

mmenavas’s picture

Status: Needs review » Reviewed & tested by the community

I verified that the functions grouped by @defgroup and @addtogroup are correctly placed and no missing opening and closing doxygen exist.

estebanvalerio.h’s picture

Just took a look to the MR at https://git.drupalcode.org/project/drupal/-/merge_requests/11653 and it looks good to me

needs-review-queue-bot’s picture

Status: Reviewed & tested by the community » Needs work
StatusFileSize
new91 bytes

The Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

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

dcam changed the visibility of the branch 11.x to hidden.

dcam’s picture

Status: Needs work » Reviewed & tested by the community

Rebased.

quietone’s picture

Issue summary: View changes
Status: Reviewed & tested by the community » Needs work
Issue tags: +Needs followup

I reviewed the change and there is nice work here to make sure the 'end group' is in the correct place. Unfortunately, this found a bug in the sniff, Drupal.Commenting.InlineComment.DocBlock. For that, there is a few more steps here. They are in my comment on the MR and I have added that to the issue summary.

Each of the steps are suitable for the 'Novice' tag, so I am leaving the tag.

I also was to pass on that it is not necessary to open a NR to run tests. Tests can be re-run using the GitLab UI.

dcam’s picture

Status: Needs work » Needs review

Sorry, should have set it to NR before instead of back to RTBC.

I followed the instructions to revert my earlier changes and add the ignore directive.

The Coder module follow-up has been created at #3517312: "@} End" doc comments should be allowed at the end of classes.

I figure that the Core queue follow-up should wait until this one is committed, but I can make it now if someone wants.

mradcliffe’s picture

Issue tags: -Needs followup

Do we need to add a @todo with the issue url for the coder issue above the ignore?

I removed the Needs followup tag since @dcam created the issue.

quietone’s picture

I don't think an @todo is needed, a followup, tagged 'Coding standards', is sufficient.

smustgrave’s picture

Status: Needs review » Reviewed & tested by the community

Tried my best to review this one. Based on the files mentioned in the summary believe they have been fixed, If I'm wrong I apologize now.

  • catch committed b1240e88 on 11.2.x
    Issue #3488681 by dcam, jazzsequence, mradcliffe, nicxvan, quietone,...

  • catch committed 1cf121ba on 11.x
    Issue #3488681 by dcam, jazzsequence, mradcliffe, nicxvan, quietone,...
catch’s picture

Version: 11.x-dev » 11.2.x-dev
Status: Reviewed & tested by the community » Fixed
Issue tags: +Needs followup

Committed/pushed to 11.x and cherry-picked to 11.2.x ,thanks!

Tagging needs follow-up for the core follow-up issue to remove the phpcs:ignore, which will need to be postponed on the coder issue.

dcam’s picture

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

nicxvan’s picture