Supports @todo tag

[jwerre]

Sometimes a class or method needs a little more work. An @todo might be a nice addition.

[dnutels]

Supported 👍

[alcidesqueiroz]

+1

[ryanrolds]

+1

[thomaspons]

+1 really

[dnordstrom]

+1

Indeed.

Update

Although after a quick search, I notice that @todo is actually already listed in an array of tags in the parser script (on line 167), and described with a comment as 0..n things to revisit eventually (hopefully).

Perhaps it's implemented; I haven't tested it to find out yet.

[Flowkap]

+1 quite indeed!

[hal-gh]

Please, guys, revisit this. :( +1

[limikael]

Hi,

I have a an implementation for custom tags here:

#222

With this it would be possible to create support for different kind of tags as "plug-ins" , either on project level to separate code as @client or @server for example, or @internal or @external. It would also be possible to create reusable tags such as @todo, which would not have to be put in the core of yuidoc, but rather as a reusable and installable plug-ins.

Please take a look and if you like it give it some support to get it merged... :) It would be a good thing to have the preprocessor functionality in the main line since it is already used for a couple of projects by several people in the company where I work...

[hal-gh]

@limikael your work on #222 looks really promising, and I think the author, @caridy, agrees. :)

[limikael]

@hal-gh Ah yep, heard back from him so it seems to be progressing. 👍

Also, once it gets merged it would be nice to create a plugin for the @todo tag since it seems to be a requested feature. But I would like to ask, what should the @todo tag actually do?

A suggestion would be that the text from the @todo tag will be included the description for the class/method/property where it appears in italics (don't know exactly what is possible with the theming and so), and then also all the todos for the project would be exported to a suitable xml format for interoperability with other interesting tools. But which xml format and which tools?

And are there more suggestions or ideas related to the todo tag?

[martinambrus]

I'd suggest to actually create a new tab with all TODOs listed, although I'm not sure how that would work with the plugin stuff. I'd love to see all TODOs in one place and it would probably be more beneficial than seeing them next to items, as you'd still need to search for them - which could be done in an editor as well.

[arw180]

+1 for a TODOs tab