Updated Outdated PHP Docblocks

squizlabs / PHP_CodeSniffer

PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.

BSD 3-Clause "New" or "Revised" License

10.66k stars 1.48k forks source link

Updated Outdated PHP Docblocks #3703

Closed AndrewDawes closed 10 months ago

AndrewDawes commented 1 year ago

I saw that quite a few PHP Docblocks were showing the wrong return type and one with a throw tag which was no longer relevant. I updated the comments, please let me know if I missed something here or made some other mistake and I'm happy to fix it 🙂

I also noticed that the codebase uses a mix short and long names for types e.g. int vs integer, bool vs boolean. Which is the correct one to use? I'm happy to create another PR to make them the same throughout the codebase!

jrfnl commented 10 months ago

@AndrewDawes I'm sorry to see you closed this PR instead of responding to the provided feedback as I would have liked to be able to merge the majority of these fixes.

I will copy the correct fixes in another branch I have open with other docfixes now and will give you credit for the fixes from this PR.

AndrewDawes commented 10 months ago

@jrfnl Oh sorry about that, it wasn't my intention. I had forgotten about this PR and I was just going through removing some forks yesterday not realising I still had a PR on this one :(

Thanks very much for taking care of it though! :)