v0.9.0

Author: gmazzap

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.9.0
+- `ReturnTypeDeclarationSniff` do no warn for missing return type when a docbloc like:
+  `@return {aType}|null` exists for the function.
+
 ## 0.8.0
 - Fix bug in `NoAccessorsSniff` and allow for a few method names related to PHP core interfaces.
 - Exclude `ArrayAccess` methods from `ReturnTypeDeclarationSniff` and `ArgumentTypeDeclarationSniff`.

README.md

@@ -146,6 +146,19 @@ Customs rules are:
 
 The tree of used rules are listed in the `/docs/rules-list/custom.md` file in this repo.
 
+### Notes
+
+#### Skip `InpsydeCodingStandard.CodeQuality.ReturnTypeDeclaration.NoReturnType` via doc bloc
+
+As of v0.9, when there's no return type declared for a function, but it has a docbloc like:
+`@return {$type}|null` and the function _actually_ contains both `null` and not-null return
+points **no** warning is shown.
+However, if min PHP version is set to 7.1 via php-compatibility `testVersion` config, the warning
+**is** shown, because in PHP 7.1 there's the availability for nullable return types.
+Also note that the warning **is** shown in case:
+ - the `@return` docbloc declares more than one not-null types, e.g. `@return Foo|Bar|null`
+ - the `@return` docbloc types contains "mixed", e.g. `@return mixed|null`.
+
 -------------
 
 # Removing or Disabling Rules