DDC-2116: [GH-498] Improve DocBlock annotations of generated entities #2802

Closed
doctrinebot opened this Issue Nov 2, 2012 · 5 comments

2 participants

@doctrinebot

Jira issue originally created by user @beberlei:

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

Url: #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;
@doctrinebot

Comment created by lanthaler:

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 :-)

@doctrinebot

Comment created by @beberlei:

A related Github Pull-Request [GH-498] was closed
#498

@doctrinebot

Comment created by @FabioBatSilva:

Merged : 515847b

@doctrinebot

Issue was closed with resolution "Fixed"

@doctrinebot

Comment created by @doctrinebot:

A related Github Pull-Request [GH-498] was closed:
doctrine/dbal#498

@beberlei beberlei was assigned by doctrinebot Dec 6, 2015
@doctrinebot doctrinebot added this to the 2.3.1 milestone Dec 6, 2015
@doctrinebot doctrinebot closed this Dec 6, 2015
@doctrinebot doctrinebot added the Bug label Dec 7, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment