From 3366d9eb8543fb818c257e9722c72e4f41f9ea47 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan=20Jakes=CC=8C?= <jan@jakes.pro>
Date: Thu, 17 Oct 2019 13:19:45 +0200
Subject: [PATCH] Add comments explaining custom PHPStan extensions

[MAILPOET-2429]
---
 tasks/phpstan/extensions/CodeceptionExtension/extension.neon   | 3 +++
 .../phpstan/extensions/PHPUnit5CompatExtension/extension.neon  | 3 +++
 2 files changed, 6 insertions(+)

diff --git a/tasks/phpstan/extensions/CodeceptionExtension/extension.neon b/tasks/phpstan/extensions/CodeceptionExtension/extension.neon
index d3bc4e9070..92777770f1 100644
--- a/tasks/phpstan/extensions/CodeceptionExtension/extension.neon
+++ b/tasks/phpstan/extensions/CodeceptionExtension/extension.neon
@@ -1,8 +1,11 @@
 services:
+  # resolves return type from Stub::make(SomeMockedClass::class) and other Stub methods
   -
     class: MailPoet\PHPStan\Extensions\CodeceptionExtension\Type\StubDynamicReturnTypeExtension
     tags:
       - phpstan.broker.dynamicStaticMethodReturnTypeExtension
+
+  # resolves return type from $this->make(SomeMockedClass::class) and other test case methods
   -
     class: MailPoet\PHPStan\Extensions\CodeceptionExtension\Type\TestCaseDynamicReturnTypeExtension
     tags:
diff --git a/tasks/phpstan/extensions/PHPUnit5CompatExtension/extension.neon b/tasks/phpstan/extensions/PHPUnit5CompatExtension/extension.neon
index 014ce6cee2..11c638ca54 100644
--- a/tasks/phpstan/extensions/PHPUnit5CompatExtension/extension.neon
+++ b/tasks/phpstan/extensions/PHPUnit5CompatExtension/extension.neon
@@ -6,10 +6,13 @@ parameters:
       - markTestSkipped
 
 services:
+  # resolves return type from $this->createMock(SomeMockedClass::class) and other methods in PHPUnit_Framework_TestCase
   -
     class: MailPoet\PHPStan\Extensions\PHPUnit5CompatExtension\Type\CreateMockDynamicReturnTypeExtension
     tags:
       - phpstan.broker.dynamicMethodReturnTypeExtension
+
+  # resolves return type from $this->getMockBuilder(SomeMockedClass::class) in PHPUnit_Framework_TestCase
   -
     class: MailPoet\PHPStan\Extensions\PHPUnit5CompatExtension\Type\GetMockBuilderDynamicReturnTypeExtension
     tags: