Re: A doubt about Doxygen style comments in GLOBAL

[Simon D.]

Hi, Shigio.

I admit I was adding some extra (hopefully helpful) notes to some of 
your comments as if the source code wasn't available.
E.g. "mkdir() creates the directory in mode 0775, if doesn't exist." 
in htags.c [make_directory_in_distpath()].
Do you want them removing?

> If they mislead Doxygen, '/**' should be changed to '/*'.
> What do you think?

Yes, that's OK.  But do you think we should add a text marker to the 
'/*' ones, so some unknowing programmer doesn't add the '*' back by 
mistake?

Do you want the '@address@hidden', '@note', '@remark', '@warning' 
and '@attention' sections leaving in?
 (see: makepath(), makedirectories(), libutil/gtagsop.c)

Or do I:
 remove '@code' and '@endcode' lines,
 change '@note' into 'Note:',
 change '@remark' into 'Remark:',
 change '@warning' into 'Warning:',
 change '@attention' into 'Attention:'?

Simon Dommett