[Config] Fix generated comment for multiline "info" #60400
[Config] Fix generated comment for multiline "info"
- Loading branch information
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -413,39 +413,39 @@ private function getComment(BaseNode $node): string | |
| { | ||
| $comment = ''; | ||
| if ('' !== $info = (string) $node->getInfo()) { | ||
| $comment .= $info."\n"; | ||
| } | ||
|
|
||
| if (!$node instanceof ArrayNode) { | ||
| foreach ((array) ($node->getExample() ?? []) as $example) { | ||
| $comment .= '@example '.$example."\n"; | ||
| } | ||
|
|
||
| if ('' !== $default = $node->getDefaultValue()) { | ||
| $comment .= '@default '.(null === $default ? 'null' : var_export($default, true))."\n"; | ||
| } | ||
|
|
||
| if ($node instanceof EnumNode) { | ||
| $comment .= sprintf('@param ParamConfigurator|%s $value', implode('|', array_unique(array_map(fn ($a) => !$a instanceof \UnitEnum ? var_export($a, true) : '\\'.ltrim(var_export($a, true), '\\'), $node->getValues()))))."\n"; | ||
|
There was a problem hiding this comment. When up-merging into 7.2, a backslash is added before |
||
| } else { | ||
| $parameterTypes = $this->getParameterTypes($node); | ||
| $comment .= '@param ParamConfigurator|'.implode('|', $parameterTypes).' $value'."\n"; | ||
| } | ||
| } else { | ||
| foreach ((array) ($node->getExample() ?? []) as $example) { | ||
| $comment .= '@example '.json_encode($example)."\n"; | ||
| } | ||
|
|
||
| if ($node->hasDefaultValue() && [] != $default = $node->getDefaultValue()) { | ||
| $comment .= '@default '.json_encode($default)."\n"; | ||
| } | ||
| } | ||
|
|
||
| if ($node->isDeprecated()) { | ||
| $comment .= '@deprecated '.$node->getDeprecation($node->getName(), $node->getParent()->getName())['message']."\n"; | ||
| } | ||
|
|
||
| return $comment ? ' * '.str_replace("\n", "\n * ", rtrim($comment, "\n"))."\n" : ''; | ||
| } | ||
|
|
||
| /** | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we want a smaller fix applied only to the
$infopart, it would be: