If you begin a PHPDoc block with {@inheritdoc} (docs at http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutoria...), it is raised as an error since the sentence does not start with a capital letter or end with punctuation.

I think a sensible solution might be to ignore this problem if the doc block starts with the { character, or perhaps just ignore it if it begins with {@inheritdoc}.

Comments

klausi’s picture

Project: Drupal Code Sniffer » Coder
Version: 7.x-1.0 » 7.x-2.x-dev
Component: Code » Coder Sniffer
kim.pepper’s picture

Status: Active » Needs review
StatusFileSize
new1.52 KB

Here's a patch that borrows from Symfony2's codesniff standards https://github.com/opensky/Symfony2-coding-standard/blob/master/Sniffs/C...

kim.pepper’s picture

Status: Needs review » Needs work

Still working on this...

larowlan’s picture

Status: Needs work » Needs review
StatusFileSize
new2.3 KB

This grabs last couple of issues

kim.pepper’s picture

Status: Needs review » Needs work

This last patch stops the code standard checks on all other comments, not just ones with {@inheritdoc}

klausi’s picture

Status: Needs work » Fixed

Status: Fixed » Closed (fixed)

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