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

        Hide
        Doctrine Bot added a comment -

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

        Show
        Doctrine Bot added a comment - A related Github Pull-Request [GH-498] was closed: https://github.com/doctrine/dbal/pull/498
        Show
        Fabio B. Silva added a comment - Merged : https://github.com/doctrine/doctrine2/commit/515847bece281fe6a04f49b9a65fd10102c44f80
        Hide
        Benjamin Eberlei added a comment -

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

        Show
        Benjamin Eberlei added a comment - A related Github Pull-Request [GH-498] was closed https://github.com/doctrine/doctrine2/pull/498
        Hide
        Markus Lanthaler added a comment -

        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

        Show
        Markus Lanthaler added a comment - 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

          People

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

            Dates

            • Created:
              Updated:
              Resolved: