Updated the DocBlocks of the Entities

[cafferata]

Updated the DocBlocks of the Entities from consistency point of view.

[javiereguiluz]

@cafferata thanks for this improvement. In 49d6ded I've removed the empty PHPdoc comments for __construct() methods because it's not a Symfony practice to do that. Thanks!

[bocharsky-bw]

@javiereguiluz Sorry, it's probably too late, but we don't need these @return statements for getters since we already have it on properties and PhpStorm could resolve them by itself: https://github.com/cafferata/symfony-demo/blob/e039e604a31754e371811b5dba2b0eb738af07fc/src/AppBundle/Entity/Comment.php#L33

But we need them for setters which do not have type hints though.

Some discussion about it here: #394

[cafferata]

@bocharsky-bw Thanks for pointing this out! Your feedback is appreciated.
@javiereguiluz What to do with this feedback?

[javiereguiluz]

@cafferata yes, we should remove those statements as suggested by @bocharsky-bw.

[cafferata]

@javiereguiluz I removed the @return statements based on @bocharsky-bw feedback, and push the code to the same branch after an upstream merge. Can you merge this branch again or do I need to do something else?

[javiereguiluz]

@cafferata we use a custom tool for merging Symfony PRs ... and I'm afraid I cannot merge the PR again. Maybe you can create a new PR and "cherrypick" your new commit? Thanks!

[bocharsky-bw]

I think we can just revert this merged PR, since annotations like @param \DateTime $publishedAt we don't need as well - we have type hints for arrays/objects which make this annotation pointless, and IDEs already do autocompletion based on type hints.