Patch for \todo command in comment.

[Dmitri Gribenko]

On Fri, Feb 1, 2013 at 3:09 AM, Dmitri Gribenko <gribozavr at gmail.com> wrote:
> On Fri, Feb 1, 2013 at 2:38 AM, jahanian <fjahanian at apple.com> wrote:
>> This is similar to the last patch and supports doxygen's \todo command.
>> In this patch I place the <Todo> named tag at the very end after the <Discussion> tags
>> (which are for rando comment blocks). Once, placement of this tag is agreed on, I will add test cases.
>
> I don't think this is the correct way to model \todo.  Two points:
>
> (1) we definitely don't want to warn for multiple \todos -- and we
> need a test for that.  (So there's no need to change TableGen to add
> IsTodoCommand to command properties, and no need to do anything extra
> in CommentSema.)
>
> (2) I think that \todo is just a special kind of a paragraph, so we
> should not reshuffle it within the long comment.  And what is
> important -- Doxygen does not reorder \todos and normal paragraphs.

Oh, and there's one more (imaginary?) example to support this.
Developers might annotate TODO items that consist of multiple
paragraphs with a single todo.

\todo Implement foo.

Foo should be implemented in this way: ...

\todo Implement bar.

Dmitri

-- 
main(i,j){for(i=2;;i++){for(j=2;j<i;j++){if(!(i%j)){j=0;break;}}if
(j){printf("%d\n",i);}}} /*Dmitri Gribenko <gribozavr at gmail.com>*/