Problem/Motivation

In #2572635: Fix 'Drupal.Commenting.DocComment.LongFullStop' coding standard we are trying to implement "Drupal.Commenting.DocComment.LongFullStop", only a number of suggested changes are wrong.

1) Expects 'Calling' to have a full stop.

  * This is the main entry point to the configuration API. Calling
  * @code \Drupal::config('my_module.admin') @endcode will return a

2) Passes if only the last item in a list has a full stop.

   * - CSS_BASE
   * - CSS_LAYOUT  
   * - CSS_COMPONENT
   * - CSS_STATE
   * - CSS_THEME.

Proposed resolution

Fix "Drupal.Commenting.DocComment.LongFullStop", so that the wrong suggestion are fixed.

Remaining tasks

User interface changes

API changes

Data model changes

Comments

daffie created an issue. See original summary.

quietone’s picture

quietone commented
Issue summary: View changes

Added examples.

quietone’s picture

quietone commented
Related issues: +#3207426: Problem with Drupal.Commenting.FunctionComment.ParamCommentFullStop: Lists

The first case here isn't how @code/@endcode is supposed to be used. The Drupal standard states

Drupal standards: Put the @code and @endcode tags on their own lines. Do not use a blank line between the text that explains the code sample and the code sample itself.

So, I think that should be re-written.