remove text in Class phpdoc saying this is a class

silverleague / silverstripe-ideannotator

Generate docblocks for DataObjects, Page, PageControllers and (Data)Extensions

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

46 stars 25 forks source link

remove text in Class phpdoc saying this is a class #127

Closed JakubDolba closed 4 years ago

JakubDolba commented 4 years ago

it is not a phpdoc so it does not helping IDE anyhow
unnecessary cognitive load for developer
unnecessary changes(mess) in git

JakubDolba commented 4 years ago

... I'm not sure why Scrutinizer is failing, perhaps an issue on their end?

there was some warning for 5.6 [Warning]: Installing Pear alongside of Pyrus is still experimental. but also [Success]: Built 5.6.40 successfully. later there is [Info]: The Log File is not empty, but the Build did not fail. Maybe just warnings got logged. You can review the log in /tmp/php-build.5.6.40.20191217044945.log

Firesphere commented 4 years ago

Some docblock-to-API-docs generators rely on it, or on @package. PHPDocumentor, for example, will complain it's missing a class declaration.

I don't really care much, but I fail to see how it generates "noise in git"

robbieaverill commented 4 years ago

Okay. Thanks @JakubDolba for the contribution, but we'll close this for now. Instead, we'd welcome a PR that makes the code more extensible so you can achieve something like this in your own project (if it's not already).