SADM/pest
1
0
Fork 0
mirror of https://github.com/pestphp/pest.git synced 2026-03-06 07:47:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #983 from Muhammad-Sarfaraz/patch-1

Browse Source 
Polishing Up "TestDox.php' PHPDoc Blocks for Clarity
This commit is contained in:
Nuno Maduro
2023-10-17 10:02:08 +01:00
committed by GitHub
parent 502f37d280 b8cd563569
commit b8bb3684a3
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/Factories/Annotations/TestDox.php
View File

@ -14,13 +14,12 @@ final class TestDox implements AddsAnnotations
*/ */
public function __invoke(TestCaseMethodFactory $method, array $annotations): array 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 * 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); assert($method->description !== null);
$methodDescription = str_replace('*/', '{@*}', $method->description); $methodDescription = str_replace('*/', '{@*}', $method->description);