Helpers::formatDocComment() added option $forceMultiLine

nette · Oct 4, 2022 · 22c9ed7 · 22c9ed7
1 parent 44a7a51
commit 22c9ed7
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/src/PhpGenerator/Helpers.php b/src/PhpGenerator/Helpers.php
@@ -77,13 +77,13 @@ public static function formatArgs(string $statement, array $args): string
 	}
 
 
-	public static function formatDocComment(string $content): string
+	public static function formatDocComment(string $content, bool $forceMultiLine = false): string
 	{
 		$s = trim($content);
 		$s = str_replace('*/', '* /', $s);
 		if ($s === '') {
 			return '';
-		} elseif (str_contains($content, "\n")) {
+		} elseif ($forceMultiLine || str_contains($content, "\n")) {
 			$s = str_replace("\n", "\n * ", "/**\n$s") . "\n */";
 			return Nette\Utils\Strings::normalize($s) . "\n";
 		} else {

diff --git a/tests/PhpGenerator/Helpers.comments.phpt b/tests/PhpGenerator/Helpers.comments.phpt
@@ -16,6 +16,7 @@ require __DIR__ . '/../bootstrap.php';
 Assert::same('', Helpers::formatDocComment(' '));
 Assert::same("/** @var string */\n", Helpers::formatDocComment('@var string'));
 Assert::same("/**\n * @var string\n */\n", Helpers::formatDocComment("@var string\n"));
+Assert::same("/**\n * @var string\n */\n", Helpers::formatDocComment('@var string', true));
 Assert::same("/**\n * A\n * B\n * C\n */\n", Helpers::formatDocComment("A\nB\nC\n"));
 Assert::same("/**\n * @var string\n */\n", Helpers::formatDocComment("@var string \r\n"));
 Assert::same("/**\n * A\n *\n * B\n */\n", Helpers::formatDocComment("A\n\nB"));