@inheritdoc for class level docblock

Author: phpfui

src/PHPFUI/InstaDoc/Controller.php

@@ -167,6 +167,7 @@ public function display(array $classPagesToShow = Controller::VALID_CLASS_PAGES,
 			$callout->addClass('small');
 			$parameters = $this->getConstructorParameters($fullClassName);
 			$parameters = \str_replace("\n", '', $parameters);
+			// @phpstan-ignore-next-line hack for now
 			$page->addCopyToClipboard("new \\{$fullClassName}({$parameters});", $icon, $callout);
 			$div->add($callout);
 			$mainColumn->add($div);

src/PHPFUI/InstaDoc/Section/CodeCommon.php

@@ -188,18 +188,19 @@ public function getValueString(mixed $value) : string
 
 	/**
 	 * Format comments without indentation
+	 * @template T of \ReflectionClass
+	 * @param \ReflectionMethod | \ReflectionClass<T> | null $reflection
 	 */
-	protected function formatComments(?\phpDocumentor\Reflection\DocBlock $docBlock, ?\ReflectionMethod $reflectionMethod = null) : string
+	protected function formatComments(?\phpDocumentor\Reflection\DocBlock $docBlock, \ReflectionMethod | \ReflectionClass | null $reflection = null) : string
 		{
 		if (! $docBlock)
 			{
 			return '';
 			}
 
 		$container = new \PHPFUI\Container();
-
-		$container->add($this->parsedown->text($this->getInheritedText($docBlock, $reflectionMethod, 'getSummary')));
-		$desc = $this->getInheritedText($docBlock, $reflectionMethod, 'getDescription');
+		$container->add($this->parsedown->text($this->getInheritedText($docBlock, $reflection, 'getSummary')));
+		$desc = $this->getInheritedText($docBlock, $reflection);
 
 		if ($desc)
 			{
@@ -211,9 +212,9 @@ protected function formatComments(?\phpDocumentor\Reflection\DocBlock $docBlock,
 
 		$tags = $docBlock->getTags();
 		// if we are in a method, inheritdoc makes sense, and we should get the correct doc block comments
-		if ($reflectionMethod)
+		if ($reflection instanceof \ReflectionMethod)
 			{
-			$tags = $this->getInheritedDocBlock($tags, $reflectionMethod);
+			$tags = $this->getInheritedDocBlock($tags, $reflection);
 			}
 
 		if ($tags)
@@ -288,7 +289,7 @@ protected function formatComments(?\phpDocumentor\Reflection\DocBlock $docBlock,
 				$ul->addItem(new \PHPFUI\ListItem($this->getColor('name', $name) . ' ' . $this->getColor('description', $body)));
 				}
 
-			$attributes = $this->getAttributes($reflectionMethod);
+			$attributes = $this->getAttributes($reflection);
 
 			foreach ($attributes as $attribute)
 				{
@@ -367,7 +368,7 @@ protected function getColor(string $class, string $name) : string
 	/**
 	 * Get comments indented
 	 */
-	protected function getComments(?\phpDocumentor\Reflection\DocBlock $docBlock, ?\ReflectionMethod $reflectionMethod = null) : string
+	protected function getComments(?\phpDocumentor\Reflection\DocBlock $docBlock, ?\ReflectionMethod $reflection = null) : string
 		{
 		if (! $docBlock)
 			{
@@ -379,7 +380,7 @@ protected function getComments(?\phpDocumentor\Reflection\DocBlock $docBlock, ?\
 		$cell1->add('&nbsp;');
 		$gridX->add($cell1);
 		$cell11 = new \PHPFUI\Cell(11);
-		$cell11->add($this->formatComments($docBlock, $reflectionMethod));
+		$cell11->add($this->formatComments($docBlock, $reflection));
 		$gridX->add($cell11);
 
 		return $gridX;
@@ -417,11 +418,15 @@ protected function getHtmlClass(string $class) : string
 		return \str_replace('\\', '-', $class);
 		}
 
-	protected function getInheritedText(\phpDocumentor\Reflection\DocBlock $docBlock, ?\ReflectionMethod $reflectionMethod = null, string $textType = 'getDescription') : string
+	/**
+	 * @template T of \ReflectionClass
+	 * @param \ReflectionMethod | \ReflectionClass<T> | null $reflection
+	 */
+	protected function getInheritedText(\phpDocumentor\Reflection\DocBlock $docBlock, \ReflectionMethod | \ReflectionClass | null $reflection = null, string $textType = 'getDescription') : string
 		{
 		$summary = $docBlock->{$textType}();
 
-		if (! $reflectionMethod)
+		if (! $reflection || 'getSummary' == $textType)
 			{
 			return $summary;
 			}
@@ -430,35 +435,54 @@ protected function getInheritedText(\phpDocumentor\Reflection\DocBlock $docBlock
 
 		foreach ($tags as $index => $tag)
 			{
-			$pos = \stripos($tag->getName(), 'inheritdoc');
-
-			if (false !== $pos && 0 <= $pos)
+			if (false !== \stripos($tag->getName(), 'inheritdoc'))
 				{
-				$reflectionClass = $reflectionMethod->getDeclaringClass();
-				$parent = $reflectionClass->getParentClass();
-
-				while ($parent)
+				if ($reflection instanceof \ReflectionMethod)
 					{
-					try
-						{
-						$method = $parent->getMethod($reflectionMethod->name);
-						}
-					catch (\Throwable)
+					$reflectionClass = $reflection->getDeclaringClass();
+					$parent = $reflectionClass->getParentClass();
+
+					while ($parent)
 						{
-						$method = null;
+						try
+							{
+							$method = $parent->getMethod($reflection->name);
+							}
+						catch (\Throwable)
+							{
+							$method = null;
+							}
+
+						if ($method)
+							{
+							$docBlock = $this->getDocBlock($method);
+
+							if ($docBlock)
+								{
+								return $this->getInheritedText($docBlock, $method) . $summary;
+								}
+							}
+						$parent = $parent->getParentClass();
 						}
 
-					if ($method)
+					break;
+					}
+
+
+					$parent = $reflection->getParentClass();
+
+					while ($parent)
 						{
-						$docBlock = $this->getDocBlock($method);
+						$comments = $parent->getDocComment();
 
-						if ($docBlock)
+						if ($comments)
 							{
-							return $this->getInheritedText($docBlock, $method, $textType) . $summary;
+							$comments = \str_replace('{@inheritdoc}', '@inheritdoc', $comments);
+							$docblock = $this->factory->create($comments);
+							$summary = $this->formatComments($docblock, $parent) . $summary;
 							}
+						$parent = $parent->getParentClass();
 						}
-					$parent = $parent->getParentClass();
-					}
 
 				break;
 				}
@@ -469,23 +493,25 @@ protected function getInheritedText(\phpDocumentor\Reflection\DocBlock $docBlock
 
 	/**
 	 * @param array<int, \phpDocumentor\Reflection\DocBlock\Tag> $tags
+	 * @template T of \ReflectionClass
+	 * @param \ReflectionMethod | \ReflectionClass<T> | null $reflection
 	 *
 	 * @return array<int, \phpDocumentor\Reflection\DocBlock\Tag>
 	 */
-	protected function getInheritedDocBlock(array $tags, \ReflectionMethod $reflectionMethod) : array
+	protected function getInheritedDocBlock(array $tags, \ReflectionMethod | \ReflectionClass | null $reflection) : array
 		{
 		foreach ($tags as $index => $tag)
 			{
-			if (0 >= \stripos($tag->getName(), 'inheritdoc'))
+			if (false !== \stripos($tag->getName(), 'inheritdoc'))
 				{
-				$reflectionClass = $reflectionMethod->getDeclaringClass();
+				$reflectionClass = ($reflection instanceof \ReflectionMethod) ? $reflection->getDeclaringClass() : $reflection;
 				$parent = $reflectionClass->getParentClass();
 
 				while ($parent)
 					{
 					try
 						{
-						$method = $parent->getMethod($reflectionMethod->name);
+						$method = $parent->getMethod($reflection->name);
 						}
 					catch (\Throwable)
 						{

src/PHPFUI/InstaDoc/Section/Doc.php

@@ -47,7 +47,7 @@ public function generate(\PHPFUI\InstaDoc\PageInterface $page, string $fullClass
 			{
 			$docblock = $this->factory->create($comments);
 			$callout = new \PHPFUI\Callout('secondary');
-			$callout->add($this->formatComments($docblock));
+			$callout->add($this->formatComments($docblock, $this->reflection));
 			$container->add($callout);
 			}