Better inheritdoc processing

Author: phpfui

src/PHPFUI/InstaDoc/Section/CodeCommon.php

@@ -29,7 +29,7 @@ protected function formatComments(?\phpDocumentor\Reflection\DocBlock $docBlock,
 
 		$container = new \PHPFUI\Container();
 
-		$container->add($this->parsedown->text($docBlock->getSummary()));
+		$container->add($this->parsedown->text($this->getInheritedSummary($docBlock, $reflectionMethod)));
 		$desc = $docBlock->getDescription();
 
 		if ($desc)
@@ -57,15 +57,25 @@ protected function formatComments(?\phpDocumentor\Reflection\DocBlock $docBlock,
 				$description = \method_exists($tag, 'getDescription') ? \trim($tag->getDescription()) : '';
 				$body = '';
 				// punt on useless tags
-				if (\in_array($name, ['method', 'param', 'inheritdoc']))
+				if (\in_array($name, ['method', 'inheritdoc']))
 					{
 					continue;
 					}
 
-				if ('var' == $name)
+				if (\method_exists($tag, 'getType'))
+					{
+					$type = $tag->getType();
+					}
+				else
+					{
+					$type = '';
+					}
+
+
+				if ('var' == $name || 'param' == $name)
 					{
 					// useless if no description or type
-					if (! $description && ! $tag->getType())
+					if (! $description && ! $type)
 						{
 						continue;
 						}
@@ -91,14 +101,9 @@ protected function formatComments(?\phpDocumentor\Reflection\DocBlock $docBlock,
 					$body .= new \PHPFUI\Link($tag->getLink(), '', false);
 					}
 
-				if (\method_exists($tag, 'getType'))
+				if ($type)
 					{
-					$type = $tag->getType();
-
-					if ($type)
-						{
-						$body .= $this->getClassName($type) . ' ';
-						}
+					$body .= $this->getClassName($type) . ' ';
 					}
 
 				if (\method_exists($tag, 'getVariableName'))
@@ -116,6 +121,10 @@ protected function formatComments(?\phpDocumentor\Reflection\DocBlock $docBlock,
 
 			$container->add($ul);
 			}
+		else
+			{
+			$container->add('no tags<br>');
+			}
 
 		return $container;
 		}
@@ -207,6 +216,7 @@ protected function getComments(?\phpDocumentor\Reflection\DocBlock $docBlock, ?\
 	protected function getDocBlock($method) : ?\phpDocumentor\Reflection\DocBlock
 		{
 		$comments = $method->getDocComment();
+		$comments = \str_replace('{@inheritdoc}', '@inheritdoc', $comments);
 
 		if (! $comments)
 			{
@@ -233,37 +243,72 @@ protected function getHtmlClass(string $class) : string
 		return \str_replace('\\', '-', $class);
 		}
 
-	protected function getInheritedDocBlock(array $tags, \ReflectionMethod $reflectionMethod) : array
+	protected function getInheritedSummary(\phpDocumentor\Reflection\DocBlock $docBlock, ?\ReflectionMethod $reflectionMethod = null) : string
 		{
+		$summary = $docBlock->getSummary();
+		if (! $reflectionMethod)
+			{
+			return $summary;
+			}
+
+		$tags = $docBlock->getTags();
 		foreach ($tags as $index => $tag)
 			{
 			if (0 == \strcasecmp($tag->getName(), 'inheritDoc'))
 				{
 				$reflectionClass = $reflectionMethod->getDeclaringClass();
 				$parent = $reflectionClass->getParentClass();
 
-				if (! $parent)
+				while ($parent)
 					{
-					return [];	// no parent, at top of tree, and no tags, go figure
-					}
-				$method = $parent->getMethod($reflectionMethod->name);
+					$method = $parent->getMethod($reflectionMethod->name);
+					if ($method)
+						{
+						$docBlock = $this->getDocBlock($method);
 
-				if (! $method)
-					{
-					return [];	// no method here, kinda strange
+						if ($docBlock)
+							{
+							return $summary . "\n" . $this->getInheritedSummary($docBlock, $method);
+							}
+						}
+					$parent = $parent->getParentClass();
 					}
-				$docBlock = $this->getDocBlock($method);
 
-				if ($docBlock)
+				break;
+				}
+			}
+
+		return $summary;
+		}
+
+	protected function getInheritedDocBlock(array $tags, \ReflectionMethod $reflectionMethod) : array
+		{
+		foreach ($tags as $index => $tag)
+			{
+			if (0 == \strcasecmp($tag->getName(), 'inheritDoc'))
+				{
+				$reflectionClass = $reflectionMethod->getDeclaringClass();
+				$parent = $reflectionClass->getParentClass();
+
+				while ($parent)
 					{
-					// add in the new tags and check parent
-					\array_splice($tags, $index, 1, $docBlock->getTags());
+					$method = $parent->getMethod($reflectionMethod->name);
+					if ($method)
+						{
+						$docBlock = $this->getDocBlock($method);
+
+						if ($docBlock)
+							{
+							// add in the new tags and check parent
+							\array_splice($tags, $index, 1, $docBlock->getTags());
 
-					return $this->getInheritedDocBlock($tags, $method);
+							return $this->getInheritedDocBlock($tags, $method);
+							}
+						}
+					$parent = $parent->getParentClass();
 					}
 
-				// Nothing at this level, but go up one and try the parent method
-				return $this->getInheritedDocBlock($tags, $method);
+				break;
 				}
 			}
 

src/PHPFUI/InstaDoc/Section/Doc.php

@@ -31,6 +31,7 @@ public function generate(\PHPFUI\Instadoc\PageInterface $page, string $fullClass
 			}
 
 		$comments = $this->reflection->getDocComment();
+		$comments = \str_replace('{@inheritdoc}', '@inheritdoc', $comments);
 
 		if ($comments)
 			{

src/PHPFUI/InstaDoc/Tests/Test80A.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace PHPFUI\InstaDoc\Tests;
+
+/**
+ * A test class with no functionality.
+ *
+ * It is just to test InstaDoc
+ *
+ * @author bruce (1/3/2020)
+ */
+class Test80A extends Test80
+	{
+
+	}

src/PHPFUI/InstaDoc/Tests/Test80B.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace PHPFUI\InstaDoc\Tests;
+
+/**
+ * A test class with no functionality.
+ *
+ * It is just to test InstaDoc
+ *
+ * @author bruce (1/3/2020)
+ */
+class Test80B extends Test80A
+	{
+	/**
+	 * @inheritDoc
+	 */
+	protected function protected_function_no_return(?string $fred, $unknown = 3.14) : void {}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	private function private_function_no_return(string | Test80 | null $fred = 'Eythel') : void {}
+	}