Re: [eigen] documentation: the long tutorial

[ Thread Index | Date Index | More Archives ]

I think it is a good idea. I believe it would be nice to have some sort of 'yellow-highlighted text' so it becomes more obvious, even though there might be reasons to avoid that too.

So far I am sticking to the FIXME format, but I am open to any changes regarding that. Usually I use \hl{something} in latex so I can spot the TODO's easily while reading the output. Anyways, this is not latex :(

On Sat, Jun 19, 2010 at 11:50 PM, Robert Lupton the Good <rhl@xxxxxxxxxxxxxxxxxxx> wrote:
> Just write FIXME in plain text, as we do in the code, no particular
> dox/html tag.

The doxy tag to use would be \todo:

> \todo { paragraph describing what is to be done }
> Starts a paragraph where a TODO item is described. The description will also add an item to a separate TODO list. The two instances of the description will be cross-referenced. Each item in the TODO list will be preceded by a header that indicates the origin of the item.

Wouldn't it be worth using it?


Mail converted by MHonArc 2.6.19+