phpDocumentor/ReflectionDocBlock

[DEPRECATION] Param tags without name

jaapio opened this issue · 5 comments

jaapio commented

@param tag should always have a variable name in it's body, support for params without variable names will be dropped.

Supported formats will be: (option 3 does not really make any sense, but will be covered)

@param $var your description here
@param MyType $var your description
@param $var
@param MyType $var

Unsupported after this deprecation has been removed:

@param MyType your description here
@param MyType
williamdes commented

And reported as invalid items I guess ?

jaapio commented

Yes these will be reported as InvalidTag

  • 👍1
norkunas commented

support for params without type ... will be dropped.

so basically this is opposite to symfony/symfony#54523 ?

williamdes commented

support for params without type ... will be dropped.

so basically this is opposite to symfony/symfony#54523 ?

the linked PR feels wrong, the types should always be present
If the param do not document anything (type hints exist), drop them
But if they do have a description, keep them in sync with native hints

Anyway, that's only my point of view 😁

jaapio commented

Types are optional. I just noticed that the description of this issue is wrong. Thanks for the headsup @norkunas

  • 👍1