We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
7.x
There are several methods to add a description to a property:
/** * This is a description for property */ public string $property;
@var
/** * @var float this should be included in the description if no other description is provided */ public float $property;
@param
/** * @param string $property Some short description here */ public function __construct( public string $property, ) { }
First two work, third one does not because of this line: https://github.com/symfony/property-info/blob/f00fd9685ecdbabe82ca25c7b739ce7bba99302c/Extractor/PhpDocExtractor.php#L95 which considers only a @var annotation instead of also @param annotation if this is a promoted property. Param annotation is successfully extracted by the findDocBlock, but it remains unused here.
findDocBlock
Have a class with constructor like this:
And extract the summary:
$description = $propertyInfoExtractor->getShortDescription($className, $propertyName);
Consider also @param annotations in the aforementioned place in the code.
No response
The text was updated successfully, but these errors were encountered:
see #59540
Sorry, something went wrong.
Ok guess didn't search well enough. Closing as duplicate of #59540
No branches or pull requests
Symfony version(s) affected
7.x
Description
There are several methods to add a description to a property:
@var
annotation describing type and giving short description:@param
annotation of the constructor comment:First two work, third one does not because of this line: https://github.com/symfony/property-info/blob/f00fd9685ecdbabe82ca25c7b739ce7bba99302c/Extractor/PhpDocExtractor.php#L95 which considers only a
@var
annotation instead of also @param annotation if this is a promoted property. Param annotation is successfully extracted by thefindDocBlock
, but it remains unused here.How to reproduce
Have a class with constructor like this:
And extract the summary:
Possible Solution
Consider also
@param
annotations in the aforementioned place in the code.Additional Context
No response
The text was updated successfully, but these errors were encountered: