Doctrine 2 - ORM
  1. Doctrine 2 - ORM
  2. DDC-2116

[GH-498] Improve DocBlock annotations of generated entities

    Details

    • Type: Bug Bug
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.3.1
    • Component/s: None
    • Security Level: All
    • 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;
        ```

        Activity

          People

          • Assignee:
            Benjamin Eberlei
            Reporter:
            Benjamin Eberlei
          • Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: