added Helpers::formatDocComment() & unformatDocComment()

Author: dg

src/PhpGenerator/ClassType.php

@@ -80,7 +80,7 @@ public static function from($from)
 		$class->final = $from->isFinal() && $class->type === 'class';
 		$class->abstract = $from->isAbstract() && $class->type === 'class';
 		$class->implements = $from->getInterfaceNames();
-		$class->comment = $from->getDocComment() ? preg_replace('#^\s*\* ?#m', '', trim($from->getDocComment(), "/* \r\n\t")) : NULL;
+		$class->comment = Helpers::unformatDocComment($from->getDocComment());
 		if ($from->getParentClass()) {
 			$class->extends = $from->getParentClass()->getName();
 			$class->implements = array_diff($class->implements, $from->getParentClass()->getInterfaceNames());
@@ -118,8 +118,7 @@ public function __toString()
 
 		$properties = [];
 		foreach ($this->properties as $property) {
-			$doc = str_replace("\n", "\n * ", $property->getComment());
-			$properties[] = ($doc ? (strpos($doc, "\n") === FALSE ? "/** $doc */\n" : "/**\n * $doc\n */\n") : '')
+			$properties[] = Helpers::formatDocComment($property->getComment())
 				. $property->getVisibility() . ($property->isStatic() ? ' static' : '') . ' $' . $property->getName()
 				. ($property->value === NULL ? '' : ' = ' . Helpers::dump($property->value))
 				. ";\n";
@@ -130,7 +129,7 @@ public function __toString()
 		};
 
 		return Strings::normalize(
-			($this->comment ? str_replace("\n", "\n * ", "/**\n" . $this->comment) . "\n */\n" : '')
+			Helpers::formatDocComment($this->comment . "\n")
 			. ($this->abstract ? 'abstract ' : '')
 			. ($this->final ? 'final ' : '')
 			. $this->type . ' '

src/PhpGenerator/Helpers.php

@@ -206,6 +206,30 @@ public static function formatMember($name)
 	}
 
 
+	/**
+	 * @return string
+	 */
+	public static function formatDocComment($content)
+	{
+		if (($s = trim($content)) === '') {
+			return '';
+		} elseif (strpos($content, "\n") === FALSE) {
+			return "/** $s */\n";
+		} else {
+			return str_replace("\n", "\n * ", "/**\n$s") . "\n */\n";
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function unformatDocComment($comment)
+	{
+		return preg_replace('#^\s*\* ?#m', '', trim(trim(trim($comment), '/*')));
+	}
+
+
 	/**
 	 * @return bool
 	 */

src/PhpGenerator/Method.php

@@ -89,7 +89,7 @@ public static function from($from)
 		}
 		$method->returnReference = $from->returnsReference();
 		$method->variadic = $from->isVariadic();
-		$method->comment = $from->getDocComment() ? preg_replace('#^\s*\* ?#m', '', trim($from->getDocComment(), "/* \r\n\t")) : NULL;
+		$method->comment = Helpers::unformatDocComment($from->getDocComment());
 		if (PHP_VERSION_ID >= 70000 && $from->hasReturnType()) {
 			$method->returnType = (string) $from->getReturnType();
 			$method->returnNullable = $from->getReturnType()->allowsNull();
@@ -127,7 +127,7 @@ public function __toString()
 			$uses[] = ($param->isReference() ? '&' : '') . '$' . $param->getName();
 		}
 
-		return ($this->comment ? str_replace("\n", "\n * ", "/**\n" . $this->comment) . "\n */\n" : '')
+		return Helpers::formatDocComment($this->comment . "\n")
 			. ($this->abstract ? 'abstract ' : '')
 			. ($this->final ? 'final ' : '')
 			. ($this->visibility ? $this->visibility . ' ' : '')

src/PhpGenerator/PhpFile.php

@@ -145,7 +145,7 @@ public function __toString()
 
 		return Strings::normalize(
 			"<?php\n"
-			. ($this->comment ? "\n" . str_replace("\n", "\n * ", "/**\n" . $this->comment) . "\n */\n\n" : '')
+			. ($this->comment ? "\n" . Helpers::formatDocComment($this->comment . "\n") . "\n" : '')
 			. implode("\n\n", $this->namespaces)
 		) . "\n";
 	}

src/PhpGenerator/Property.php

@@ -43,7 +43,7 @@ public static function from(\ReflectionProperty $from)
 		$prop->value = isset($defaults[$prop->name]) ? $defaults[$prop->name] : NULL;
 		$prop->static = $from->isStatic();
 		$prop->visibility = $from->isPrivate() ? 'private' : ($from->isProtected() ? 'protected' : 'public');
-		$prop->comment = $from->getDocComment() ? preg_replace('#^\s*\* ?#m', '', trim($from->getDocComment(), "/* \r\n\t")) : NULL;
+		$prop->comment = Helpers::unformatDocComment($from->getDocComment());
 		return $prop;
 	}
 

tests/PhpGenerator/Helpers.comments.phpt

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * Test: Nette\PhpGenerator\Helpers::formatDocComment() & unformatDocComment()
+ */
+
+use Nette\PhpGenerator\Helpers;
+use Tester\Assert;
+
+
+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 * A\n * B\n * C\n */\n", Helpers::formatDocComment("A\nB\nC\n"));
+
+Assert::same('', Helpers::unformatDocComment(''));
+Assert::same('', Helpers::unformatDocComment("/**  */\n\r\t"));
+Assert::same('@var string', Helpers::unformatDocComment(" /** @var string */ "));
+Assert::same('@var string', Helpers::unformatDocComment("/**\n * @var string\n */"));
+Assert::same("A\nB\nC", Helpers::unformatDocComment("/**\n * A\n * B\n * C\n */\n"));