Doctrine Common
  1. Doctrine Common
  2. DCOM-106

Add @todo and @fixme to AnnotationReader::$globalIgnoredNames

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 2.3
    • Fix Version/s: 2.4
    • Component/s: Annotations
    • Labels:
      None

      Description

      I was wondering if you would consider adding @todo and @fixme

      After doing some research, I'm not sure if @fixme is used anywhere other than being in Eclipse's PDT. However, @todo is definitely on the common tags of wiki page about PHPdoc as well as the phpDoc manual.

      http://en.wikipedia.org/wiki/PHPDoc#Tags
      http://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.todo.pkg.html

        Activity

        Show
        Marco Pivetta added a comment - Todo is already built in: https://github.com/doctrine/common/blob/master/lib/Doctrine/Common/Annotations/AnnotationReader.php#L63
        Hide
        Stephen Ostrow added a comment -

        Sorry about that. I normally write them as @TODO so the standout more. Then when I got that exception and started doing research I swear I had tried @todo. But now looking back, I bet I tried @todo and still got exceptions which were from other bugs I had going on. I guess we can close this unless anyone thinks @fixme should be in there as well.

        But like I said in the description, I'm not sure if @fixme is a common or just from Eclipse.

        Show
        Stephen Ostrow added a comment - Sorry about that. I normally write them as @TODO so the standout more. Then when I got that exception and started doing research I swear I had tried @todo. But now looking back, I bet I tried @todo and still got exceptions which were from other bugs I had going on. I guess we can close this unless anyone thinks @fixme should be in there as well. But like I said in the description, I'm not sure if @fixme is a common or just from Eclipse.
        Hide
        Marco Pivetta added a comment -

        Netbeans matches that one too

        Show
        Marco Pivetta added a comment - Netbeans matches that one too
        Hide
        Paweł Nowak added a comment -

        I've prepared a fix for this issue that makes both @fixme and @TODO ignored. Pull request: https://github.com/doctrine/common/pull/223.

        Show
        Paweł Nowak added a comment - I've prepared a fix for this issue that makes both @fixme and @TODO ignored. Pull request: https://github.com/doctrine/common/pull/223 .

          People

          • Assignee:
            Benjamin Eberlei
            Reporter:
            Stephen Ostrow
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: