[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: A doubt about Doxygen style comments in GLOBAL

From: Shigio YAMAGUCHI
Subject: Re: A doubt about Doxygen style comments in GLOBAL
Date: Wed, 17 Jun 2015 05:23:59 +0900

Hi Simon,

2015-06-17 0:05 GMT+09:00 Simon D. <address@hidden>:
> 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?

It is no problem.

> > 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?

I think it isn't necessary. For C source code, both '/*' and '/**' are correct.

> 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:'?

It's my job. I'm sorry that I couldn't utilize your work.

Shigio YAMAGUCHI <address@hidden>
PGP fingerprint: D1CB 0B89 B346 4AB6 5663  C4B6 3CA5 BBB3 57BE DDA3

reply via email to

[Prev in Thread] Current Thread [Next in Thread]