[DDC-2116] [GH-498] Improve DocBlock annotations of generated entities Created: 02/Nov/12  Updated: 08/Jan/14  Resolved: 05/Nov/12

Status: Resolved
Project: Doctrine 2 - ORM
Component/s: None
Affects Version/s: None
Fix Version/s: 2.3.1
Security Level: All

Type: Bug Priority: Major
Reporter: Benjamin Eberlei Assignee: Benjamin Eberlei
Resolution: Fixed Votes: 0
Labels: None


 Description   

This issue is created automatically through a Github pull request on behalf of lanthaler:

Url: https://github.com/doctrine/doctrine2/pull/498

Message:

Currently, the DocBlock annotations for member variables contain the variable name as description which is redundant and should be removed. Furthermore the class is annotated with the FQN instead of just the name. This makes automatically generated documentation quite ugly.

These changes will result in entities that as follows

```
/**

  • User
    *
  • @ORM\Table()
  • @ORM\Entity
    */
    class User
    {
    /**
  • @var string
    *
  • @ORM\Column(name="name", type="string", length=255)
    */
    private $name;
    ```

instead of this:

```
/**

  • Some\Completely\Random\Namespace\User <--- FQN is not needed here
    *
  • @ORM\Table()
  • @ORM\Entity
    */
    class User
    {
    /**
  • @var string $name <--- description is better left blank instead of using variable name
    *
  • @ORM\Column(name="name", type="string", length=255)
    */
    private $name;
    ```


 Comments   
Comment by Markus Lanthaler [ 02/Nov/12 ]

Just noticed that the message the doctrinebot posts on GitHub contains a typo: "thank you for **positing** this Pull Request". Don't know where to report this so I do it directly here

Comment by Benjamin Eberlei [ 03/Nov/12 ]

A related Github Pull-Request [GH-498] was closed
https://github.com/doctrine/doctrine2/pull/498

Comment by Fabio B. Silva [ 05/Nov/12 ]

Merged : https://github.com/doctrine/doctrine2/commit/515847bece281fe6a04f49b9a65fd10102c44f80

Comment by Doctrine Bot [ 08/Jan/14 ]

A related Github Pull-Request [GH-498] was closed:
https://github.com/doctrine/dbal/pull/498

Generated at Sun Dec 21 23:58:53 UTC 2014 using JIRA 6.2.3#6260-sha1:63ef1d6dac3f4f4d7db4c1effd405ba38ccdc558.