Escape < and > in parameter descriptions, could be PHPStan templates

Author: phpfui

src/PHPFUI/InstaDoc/Section/CodeCommon.php

@@ -189,7 +189,7 @@ public function getValueString(mixed $value) : string
 	/**
 	 * Format comments without indentation
 	 * @template T of \ReflectionClass
-	 * @param \ReflectionMethod | \ReflectionClass<T> | null $reflection
+	 * @param \ReflectionMethod | \ReflectionClass<T> | null $reflection if \ReflectionClass, then grab the comments from the class header
 	 */
 	protected function formatComments(?\phpDocumentor\Reflection\DocBlock $docBlock, \ReflectionMethod | \ReflectionClass | null $reflection = null) : string
 		{
@@ -285,7 +285,7 @@ protected function formatComments(?\phpDocumentor\Reflection\DocBlock $docBlock,
 						$body .= $this->getColor('variable', '$' . $varname) . ' ';
 						}
 					}
-				$body .= $this->parsedown->html($description);
+				$body .= $this->parsedown->html(\str_replace(['<', '>'], ['&lt;', '&gt;'], $description));
 				$ul->addItem(new \PHPFUI\ListItem($this->getColor('name', $name) . ' ' . $this->getColor('description', $body)));
 				}
 
@@ -420,7 +420,7 @@ protected function getHtmlClass(string $class) : string
 
 	/**
 	 * @template T of \ReflectionClass
-	 * @param \ReflectionMethod | \ReflectionClass<T> | null $reflection
+	 * @param \ReflectionMethod | \ReflectionClass<T> | null $reflection if \ReflectionClass, then grab the comments from the class header
 	 */
 	protected function getInheritedText(\phpDocumentor\Reflection\DocBlock $docBlock, \ReflectionMethod | \ReflectionClass | null $reflection = null, string $textType = 'getDescription') : string
 		{
@@ -494,7 +494,7 @@ 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
+	 * @param \ReflectionMethod | \ReflectionClass<T> | null $reflection if \ReflectionClass, then grab the comments from the class header
 	 *
 	 * @return array<int, \phpDocumentor\Reflection\DocBlock\Tag>
 	 */
@@ -646,36 +646,6 @@ protected function formatAttribute(\ReflectionAttribute $attribute) : string
 			}
 
 		$targeting = '';
-		/*
-
-		Not sure how useful this is, so commenting out for now.
-
-		$target = $attribute->getTarget();
-		$targets = [];
-		$definedTargets = [
-			"CLASS" => \Attribute::TARGET_CLASS,
-			"FUNCTION" => \Attribute::TARGET_FUNCTION,
-			"METHOD" => \Attribute::TARGET_METHOD,
-			"PROPERTY" => \Attribute::TARGET_PROPERTY,
-			"CLASS_CONSTANT" => \Attribute::TARGET_CLASS_CONSTANT,
-			"PARAMETER" => \Attribute::TARGET_PARAMETER,
-			];
-		foreach ($definedTargets as $name => $value)
-			{
-			if ($target & $value)
-				{
-				$targets[] = '\\Attribute::TARGET_' . $name;
-				}
-			}
-		if ($attribute->isRepeated())
-			{
-			$targets[] = '\\Attribute::IS_REPEATABLE';
-			}
-		if ($targets)
-			{
-			$targeting = ' ' . implode(' | ', $targets);
-			}
-		 */
 
 		return $this->getClassName($attribute->getName()) . $parameters . $targeting;
 		}

src/PHPFUI/InstaDoc/Tests/Test81.php

@@ -5,7 +5,7 @@
 /**
  * A test class with no functionality.
  *
- * It is just to test InstaDoc
+ * <b>It is just to test InstaDoc</b>
  *
  * @author bruce (11/27/2021)
  */