improved phpDoc

nette · Aug 29, 2023 · 163c5e9 · 163c5e9
1 parent 290bbb7
commit 163c5e9
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 5 deletions.
diff --git a/src/PhpGenerator/Extractor.php b/src/PhpGenerator/Extractor.php
@@ -357,7 +357,10 @@ private function addEnumCaseToClass(EnumType $class, Node\Stmt\EnumCase $node):
 	}
 
 
-	private function addCommentAndAttributes($element, Node $node): void
+	private function addCommentAndAttributes(
+		PhpFile|ClassLike|Constant|Property|GlobalFunction|Method|Parameter|EnumCase|TraitUse $element,
+		Node $node,
+	): void
 	{
 		if ($node->getDocComment()) {
 			$comment = $node->getDocComment()->getReformattedText();

diff --git a/src/PhpGenerator/Parameter.php b/src/PhpGenerator/Parameter.php
@@ -52,6 +52,7 @@ public function setType(?string $type): static
 	}
 
 
+	/** @return ($asObject is true ? ?Type : ?string) */
 	public function getType(bool $asObject = false): Type|string|null
 	{
 		return $asObject && $this->type

diff --git a/src/PhpGenerator/PhpFile.php b/src/PhpGenerator/PhpFile.php
@@ -97,7 +97,7 @@ public function getNamespaces(): array
 	}
 
 
-	/** @return ClassLike[] */
+	/** @return (ClassType|InterfaceType|TraitType|EnumType)[] */
 	public function getClasses(): array
 	{
 		$classes = [];

diff --git a/src/PhpGenerator/PhpNamespace.php b/src/PhpGenerator/PhpNamespace.php
@@ -50,7 +50,7 @@ final class PhpNamespace
 		self::NameConstant => [],
 	];
 
-	/** @var ClassLike[] */
+	/** @var (ClassType|InterfaceType|TraitType|EnumType)[] */
 	private array $classes = [];
 
 	/** @var GlobalFunction[] */
@@ -253,7 +253,7 @@ public function simplifyName(string $name, string $of = self::NameNormal): strin
 	}
 
 
-	public function add(ClassLike $class): static
+	public function add(ClassType|InterfaceType|TraitType|EnumType $class): static
 	{
 		$name = $class->getName();
 		if ($name === null) {
@@ -327,7 +327,7 @@ public function removeFunction(string $name): static
 	}
 
 
-	/** @return ClassLike[] */
+	/** @return (ClassType|InterfaceType|TraitType|EnumType)[] */
 	public function getClasses(): array
 	{
 		$res = [];

diff --git a/src/PhpGenerator/Property.php b/src/PhpGenerator/Property.php
@@ -68,6 +68,7 @@ public function setType(?string $type): static
 	}
 
 
+	/** @return ($asObject is true ? ?Type : ?string) */
 	public function getType(bool $asObject = false): Type|string|null
 	{
 		return $asObject && $this->type

diff --git a/src/PhpGenerator/Traits/FunctionLike.php b/src/PhpGenerator/Traits/FunctionLike.php
@@ -141,6 +141,7 @@ public function setReturnType(?string $type): static
 	}
 
 
+	/** @return ($asObject is true ? ?Type : ?string) */
 	public function getReturnType(bool $asObject = false): Type|string|null
 	{
 		return $asObject && $this->returnType
-Original file line number
+Diff line change
@@ Expand Up / @@ -52,6 +52,7 @@ public function setType(?string $type): static @@
     	}
+    	/** @return ($asObject is true ? ?Type : ?string) */
     	public function getType(bool $asObject = false): Type|string|null
     	{
     		return $asObject && $this->type
@@ Expand Down @@