PHPStorm Squawks on @return void for __construct()

Question

I'm using PHPStorm and trying to figure out how to make it stop squawking when a __construct() has @return void in its PHPDocs...

According the PHPDocs, void is valid, or the @return may be omitted. That being said, is there a way to fix this or is it a bug?

Answer 1

See this document for how to suppress the warning for a statement. You can hover the portion of code and select the option from the drop-down. You will have to do this for each affected constructor though.

I don't see an Inspection Tool option to suppress this warning in a way that won't expose other issues.

Answer 2

Unfortunately you can not turn off just this one very specific inspection. The whole PHPDoc method signature inspection would need to be turned off. Fortunately you can set the scope of the inspection to be only your own project code, ignoring 3rd party libraries and frameworks. See the scopes dropdown on the right under the description.

Also on a case-by-case basis you can turn off the inspection above each PHPDoc comment:

/** @noinspection PhpDocSignatureInspection */
/**
 * @return void
 */
public function __construct() ...