[llvm-commits] [PATCH] Coding Standards: Doxygen guidelines
Hal Finkel
hfinkel at anl.gov
Wed Sep 19 14:10:56 PDT 2012
Dmitri,
Quick comment: Please include a comma after an introductory clause.
Specifically (commas added):
To refer to parameter names inside a paragraph, use the
To document a function parameter, start a new paragraph
To describe function return value, use the
-Hal
On Wed, 19 Sep 2012 23:15:23 +0300
Dmitri Gribenko <gribozavr at gmail.com> wrote:
> On Fri, Sep 14, 2012 at 6:27 PM, Dmitri Gribenko
> <gribozavr at gmail.com> wrote:
> > Hello,
> >
> > @Chris, Chandler: CC'ing you since this an addition to the policies
> > and I feel like I need your review.
> >
> > The attached patch documents current Doxygen use practices in Coding
> > Standards. Mostly it is obvious stuff and most new code being
> > committed conforms to that. Some old code does not; this might
> > cause confusion and this is the motivation to document the correct
> > guidelines.
>
> Ping.
>
--
Hal Finkel
Postdoctoral Appointee
Leadership Computing Facility
Argonne National Laboratory
More information about the llvm-commits
mailing list