On Fri, 24 Jun 2005 13:31:11 +0200
Christian Biere wrote:
> You've added "Needs a short description" and then follows what looks
> to me like a short description. Isn't that comment sufficient as a
> short description or is "short description" supposed to be something
> like a headline i.e., shorter than a sentence?
Probably yes, I may wrong at usage 'description', it's better if those
line displayed at file summery contain less than five words (noun
phrase, gerund etc.)
> The TODO list extraction is certainly an advantage. However, I'd
> prefer if TODO, FIXME, XXX are kept nonetheless because these stand
> out in Vim by default.
Thanks for pointing out before messing them up ;) I've just added @todo
as follows,
/** /**
* @todo * @todo
* TODO: [...] * FIXME: [...]
*/ */
as you've noticed, Doxygen doesn't have @fixme command at now but can
FIXME, XXX be considered close to TODO?
And I'd like to ask Raphael if possible, do you mind replacing 'NB:'
with '@note'? I had searched 'NB' at Google, found that it's an
abbreviated Latin phrases. At now they are kept as they are, but if
you say okay, I'll replace them or if you mind about that, I'll just
add '@note' like an above.
Regards,
--
Daichi
-------------------------------------------------------
SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
from IBM. Find simple to follow Roadmaps, straightforward articles,
informative Webcasts and more! Get everything you need to get up to
speed, fast. http://ads.osdn.com/?ad_id=7477&alloc_id=16492&op=click
_______________________________________________
Gtk-gnutella-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gtk-gnutella-devel
