Skip to content
New issue

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

[DEPRECATION] Param tags without name #362

Open
jaapio opened this issue Mar 20, 2024 · 5 comments
Open

[DEPRECATION] Param tags without name #362

jaapio opened this issue Mar 20, 2024 · 5 comments
Milestone

Comments

@jaapio
Copy link
Member

jaapio commented Mar 20, 2024

@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
@jaapio jaapio added this to the v6.0.0 milestone Mar 20, 2024
@williamdes
Copy link
Contributor

And reported as invalid items I guess ?

@jaapio
Copy link
Member Author

jaapio commented Apr 8, 2024

Yes these will be reported as InvalidTag

@norkunas
Copy link

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

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

@williamdes
Copy link
Contributor

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
Copy link
Member Author

jaapio commented Apr 12, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants