Commit fededda

committed

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

1 parent 1dad3a1 commit fededdaCopy full SHA for fededda

File tree

2 files changed

-35

lines changed

src/PHPFUI/InstaDoc
- Section
  - CodeCommon.php
- Tests
  - Test81.php

2 files changed

-35

lines changed

`‎src/PHPFUI/InstaDoc/Section/CodeCommon.php‎`

Lines changed: 4 additions & 34 deletions

Original file line number	Diff line number	Diff line change
`@@ -189,7 +189,7 @@ public function getValueString(mixed $value) : string`
`189`	`189`	`/**`
`190`	`190`	`* Format comments without indentation`
`191`	`191`	`* @template T of \ReflectionClass`
`192`		`- * @param \ReflectionMethod \| \ReflectionClass<T> \| null $reflection`
	`192`	`+ * @param \ReflectionMethod \| \ReflectionClass<T> \| null $reflection if \ReflectionClass, then grab the comments from the class header`
`193`	`193`	`*/`
`194`	`194`	`protected function formatComments(?\phpDocumentor\Reflection\DocBlock $docBlock, \ReflectionMethod \| \ReflectionClass \| null $reflection = null) : string`
`195`	`195`	`{`
`@@ -285,7 +285,7 @@ protected function formatComments(?\phpDocumentor\Reflection\DocBlock $docBlock,`
`285`	`285`	`$body .= $this->getColor('variable', '$' . $varname) . '';`
`286`	`286`	`}`
`287`	`287`	`}`
`288`		`- $body .= $this->parsedown->html($description);`
	`288`	`+ $body .= $this->parsedown->html(\str_replace(['<', '>'], ['<', '>'], $description));`
`289`	`289`	`$ul->addItem(new \PHPFUI\ListItem($this->getColor('name', $name) . '' . $this->getColor('description', $body)));`
`290`	`290`	`}`
`291`	`291`
`@@ -420,7 +420,7 @@ protected function getHtmlClass(string $class) : string`
`420`	`420`
`421`	`421`	`/**`
`422`	`422`	`* @template T of \ReflectionClass`
`423`		`- * @param \ReflectionMethod \| \ReflectionClass<T> \| null $reflection`
	`423`	`+ * @param \ReflectionMethod \| \ReflectionClass<T> \| null $reflection if \ReflectionClass, then grab the comments from the class header`
`424`	`424`	`*/`
`425`	`425`	`protected function getInheritedText(\phpDocumentor\Reflection\DocBlock $docBlock, \ReflectionMethod \| \ReflectionClass \| null $reflection = null, string $textType = 'getDescription') : string`
`426`	`426`	`{`
`@@ -494,7 +494,7 @@ protected function getInheritedText(\phpDocumentor\Reflection\DocBlock $docBlock`
`494`	`494`	`/**`
`495`	`495`	`* @param array<int, \phpDocumentor\Reflection\DocBlock\Tag> $tags`
`496`	`496`	`* @template T of \ReflectionClass`
`497`		`- * @param \ReflectionMethod \| \ReflectionClass<T> \| null $reflection`
	`497`	`+ * @param \ReflectionMethod \| \ReflectionClass<T> \| null $reflection if \ReflectionClass, then grab the comments from the class header`
`498`	`498`	`*`
`499`	`499`	`* @return array<int, \phpDocumentor\Reflection\DocBlock\Tag>`
`500`	`500`	`*/`
`@@ -646,36 +646,6 @@ protected function formatAttribute(\ReflectionAttribute $attribute) : string`
`646`	`646`	`}`
`647`	`647`
`648`	`648`	`$targeting = '';`
`649`		`- /*`
`650`		`-`
`651`		`- Not sure how useful this is, so commenting out for now.`
`652`		`-`
`653`		`- $target = $attribute->getTarget();`
`654`		`- $targets = [];`
`655`		`- $definedTargets = [`
`656`		`- "CLASS" => \Attribute::TARGET_CLASS,`
`657`		`- "FUNCTION" => \Attribute::TARGET_FUNCTION,`
`658`		`- "METHOD" => \Attribute::TARGET_METHOD,`
`659`		`- "PROPERTY" => \Attribute::TARGET_PROPERTY,`
`660`		`- "CLASS_CONSTANT" => \Attribute::TARGET_CLASS_CONSTANT,`
`661`		`- "PARAMETER" => \Attribute::TARGET_PARAMETER,`
`662`		`- ];`
`663`		`- foreach ($definedTargets as $name => $value)`
`664`		`- {`
`665`		`- if ($target & $value)`
`666`		`- {`
`667`		`- $targets[] = '\\Attribute::TARGET_' . $name;`
`668`		`- }`
`669`		`- }`
`670`		`- if ($attribute->isRepeated())`
`671`		`- {`
`672`		`- $targets[] = '\\Attribute::IS_REPEATABLE';`
`673`		`- }`
`674`		`- if ($targets)`
`675`		`- {`
`676`		`- $targeting = ' ' . implode(' \| ', $targets);`
`677`		`- }`
`678`		`- */`
`679`	`649`
`680`	`650`	`return $this->getClassName($attribute->getName()) . $parameters . $targeting;`
`681`	`651`	`}`

`‎src/PHPFUI/InstaDoc/Tests/Test81.php‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`/**`
`6`	`6`	`* A test class with no functionality.`
`7`	`7`	`*`
`8`		`- * It is just to test InstaDoc`
	`8`	`+ * <b>It is just to test InstaDoc</b>`
`9`	`9`	`*`
`10`	`10`	`* @author bruce (11/27/2021)`
`11`	`11`	`*/`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit fededda

File tree

2 files changed

2 files changed

`‎src/PHPFUI/InstaDoc/Section/CodeCommon.php‎`

`‎src/PHPFUI/InstaDoc/Tests/Test81.php‎`

0 commit comments