Hi,
On 05/05/2017 01:38 PM, Brad Jorsch (Anomie) wrote:
I ran this over a few repositories and ran into some issues.
Thanks for testing :)
- "@param string $name" seems fine on a method like "getItemByName()",
there's little point in making that "@param string $name The name"
That makes sense. I'm just not sure how we could identify whether a parameter is trivial and doesn't need documentation versus those that do. :/
- It whines if PHP builtins aren't documented. Do we really need to
document __toString() over and over again?
Stuff like __toString()? No. Filed T164650 for that. But documentation is needed for things like __construct. And if you're overriding magic methods like __get you probably want to explain why.
- Doxygen is happy to inherit documentation from the parent class for an
overridden method. Your phpcs check doesn't even honor @inheritdoc, it want everything copied.
Filed as T164649.
-- Legoktm