At least two files in Core have malformed @defgroup doc blocks. The two I know about right now are:
core/modules/rest/rest.install
core/modules/serialization/serialization.install

Here is the documentation for what a @defgroup doc block is supposed to look like, from https://www.drupal.org/node/1354#defgroup :

/**
 * @defgroup group_identifier Topic title goes here
 * @{
 * Summary line for the group/topic goes here.
 *
 * Additional documentation paragraphs go here.
 */

(functions, classes, etc. that belong as members of the group go here)
...

But the @defgroup doc blocks in these two files (and possibly others that were copy/pasted from the same source) are missing the topic title. They instead look like this:

**
 * @defgroup updates-8.1.x-to-8.2.x
 * @{
 * Update functions from 8.1.x to 8.2.x.
 */

It should be an easy fix. They just need to have a title added to the first line of the @defgroup in the doc block. Please also look for other core/modules/*/*.install files that have defgroups with the same problem. There probably are some.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

jhodgdon created an issue. See original summary.

efrainh’s picture

Assigned: Unassigned » efrainh
efrainh’s picture

Hi, i added the titles and i searched for more missing titles or descriptions but only these 2 files had the @defgroup def blocks malformed.

efrainh’s picture

Status: Active » Needs review
efrainh’s picture

Assigned: efrainh » Unassigned
jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Yes, I think you are correct -- those are the only two.

Patch looks good to me, thanks!

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Committed and pushed 34a3770 to 8.4.x and 881c092 to 8.3.x. Thanks!

  • alexpott committed 34a3770 on 8.4.x
    Issue #2851678 by efrainh, jhodgdon: rest.install and other .install...

  • alexpott committed 881c092 on 8.3.x
    Issue #2851678 by efrainh, jhodgdon: rest.install and other .install...
alexpott’s picture

Created an issue in coder to check for this so we can enforce it - #2851809: @defgroup should always have a topic

Status: Fixed » Closed (fixed)

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