Problem/Motivation

The docblock looks like this:

{#
/**
* @file
…
* @ingroup themeable
*/
#}

This actually makes the page on api.d.o look broken: https://api.drupal.org/api/drupal/core%21modules%21language%21templates%...

Why is this RC eligible?

Because it only changes documentation.

Proposed resolution

It should look like this:

{#
/**
 * @file
…
 * @ingroup themeable
 */
#}

A space needs to be added before each single asterisk after the /** , see https://www.drupal.org/node/1354#general.

Remaining tasks

Patch

User interface changes

n/a

API changes

n/a

Data model changes

n/a

Comments

Cottser created an issue. See original summary.

r_sharma08’s picture

Status: Active » Needs review
FileSize
2.06 KB

Documented now, please review.

Cottser’s picture

Issue summary: View changes
Status: Needs review » Needs work

Thanks @r_sharma08! That patch only adds the spaces, doesn't change anything else (as it should), but this does put the 'description' line over 80 characters, so that should be wrapped now: https://www.drupal.org/node/1354#drupal

Also I don't think what we're doing in this issue is documenting but we're fixing things :)

Normally I'd make this kind of thing minor but it does actually break things on api.d.o, adding that to the issue summary.

Nitesh Pawar’s picture

Nitesh Pawar’s picture

Status: Needs work » Needs review
Cottser’s picture

Status: Needs review » Reviewed & tested by the community

Thank you @Nitesh Pawar, I think this is ready to go now!

Cottser’s picture

Issue tags: +rc eligible

Forgot to tag it.

The last submitted patch, 2: 2607824-2.patch, failed testing.

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Committed 7bef4e6 and pushed to 8.0.x. Thanks!

  • alexpott committed 7bef4e6 on 8.0.x
    Issue #2607824 by Nitesh Pawar, r_sharma08: Asterisks in language-...

  • alexpott committed 7bef4e6 on 8.1.x
    Issue #2607824 by Nitesh Pawar, r_sharma08: Asterisks in language-...

Status: Fixed » Closed (fixed)

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