From 9fb64599de3a336ef8c59754c0a95d6eca1c15bb Mon Sep 17 00:00:00 2001 From: Sarfaraz Muhammad Sajib <50302555+Muhammad-Sarfaraz@users.noreply.github.com> Date: Mon, 16 Oct 2023 10:56:06 +0600 Subject: [PATCH 1/2] Polishing Up "TestDox.php' PHPDoc Blocks for Clarity Added the missing parenthesis and period for proper punctuation and formatted the doc block to meet PHPDocumentor standards. --- src/Factories/Annotations/TestDox.php | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/Factories/Annotations/TestDox.php b/src/Factories/Annotations/TestDox.php index 83e12d60..d9583991 100644 --- a/src/Factories/Annotations/TestDox.php +++ b/src/Factories/Annotations/TestDox.php @@ -14,13 +14,12 @@ final class TestDox implements AddsAnnotations */ public function __invoke(TestCaseMethodFactory $method, array $annotations): array { - /* - * escapes docblock according to + /* + * Escapes docblock according to * https://manual.phpdoc.org/HTMLframesConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#basics.desc * - * note: '@' escaping is not needed as it cannot be the first character of the line (it always starts with @testdox + * note: '@' escaping is not needed as it cannot be the first character of the line (it always starts with @testdox). */ - assert($method->description !== null); $methodDescription = str_replace('*/', '{@*}', $method->description); From b8cd563569d949762eb4c1d9612ca840706d2202 Mon Sep 17 00:00:00 2001 From: Sarfaraz Muhammad Sajib <50302555+Muhammad-Sarfaraz@users.noreply.github.com> Date: Mon, 16 Oct 2023 16:23:09 +0600 Subject: [PATCH 2/2] Update src/Factories/Annotations/TestDox.php Co-authored-by: Owen Voke --- src/Factories/Annotations/TestDox.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Factories/Annotations/TestDox.php b/src/Factories/Annotations/TestDox.php index d9583991..5998f5b8 100644 --- a/src/Factories/Annotations/TestDox.php +++ b/src/Factories/Annotations/TestDox.php @@ -18,7 +18,7 @@ final class TestDox implements AddsAnnotations * Escapes docblock according to * https://manual.phpdoc.org/HTMLframesConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#basics.desc * - * note: '@' escaping is not needed as it cannot be the first character of the line (it always starts with @testdox). + * Note: '@' escaping is not needed as it cannot be the first character of the line (it always starts with @testdox). */ assert($method->description !== null); $methodDescription = str_replace('*/', '{@*}', $method->description);