Improve DocBlock annotations of generated entities #498

Merged
merged 1 commit into from Nov 3, 2012

3 participants

@lanthaler

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;
@lanthaler lanthaler Improve DocBlock annotations of generated entities
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.
1b7ca67
@doctrinebot

Hello,

thank you for positing this Pull Request. I have automatically opened an issue on our Jira Bug Tracker for you with the details of this Pull-Request. See the Link:

http://doctrine-project.org/jira/browse/DDC-2116

@guilhermeblanco guilhermeblanco merged commit 515847b into doctrine:master Nov 3, 2012

1 check passed

Details default The Travis build passed
@lanthaler lanthaler deleted the lanthaler:improve-generated-entity-doc branch Jan 8, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment