peej/phpdoctor

Create todo list based on @todo tag

roland-d opened this issue · 7 comments

roland-d commented

Hello,

I also have come from PhpDocumentor and I like to use the @todo tag in my code for reminding myself what to do. In PhpDocumentor this creates a single todo page but phpdoctor doesn't seem to support it yet. I would think to create an HTML file like readme.html that would show up under the All Items link will be perfect.

Thanks.

beikov commented

That is a really nice feature, Doxygen has is too but it has not such a good PHP support like PHPdoctor

peej commented

I've added a todo writer to the standard doclet. It's basically a clone of the deprecated writer but picking up the @todo tag instead.

roland-d commented

@peej, that is good news. Thanks for that.

Ari-McBrown commented

I love the @todo tag, but it doesn't show the string I feed it. I've also noticed the TODO link is not available in the following pages:

  • Overview
  • Files
  • Package (Instead it shows Index twice)

Hope it's useful

peej commented

Thanks McBrown, I've updated the standard doclet to include these todo tag fixes. You should find this fix in 1ef0c51.

beikov commented

For me it works properly, really nice feature!

Ari-McBrown commented

It works great now!