[cfe-commits] [PATCH] C++ 11 statement attributes + switch labels fall-through detection

Chandler Carruth chandlerc at google.com
Thu Apr 5 15:35:40 PDT 2012

As a high-level comment, I was skimming this patch and saw a bit of
inconsistency in commenting I would like to see cleaned up for any patches
going in:

New doxygen comments should generally use the more modern style:

/// \brief One sentence summary.
/// A more detailed description here.
void FooBarBaz(...) { ... }

Rather than the more redundant pattern:

/// FooBarBaz - One sentence summary.
/// A more detailed description here.
void FooBarBaz(...) { ... }

I also saw some doxygen comments w/ just a preceding double slash rather
than the necessary triple slash.

Finally, it's useful to check for proper prose in the comments which are
more than a name or some such. They should start with capital letters, use
punctuation, and form complete sentences, etc.

Sorry for the pedantic reminders of the dark corners of the coding
standards, just didn't want them to go unnoticed... I'll get out of your
guys' hair now...

On Fri Apr 06 00:26:29 GMT+200 2012, Richard Smith <richard at metafoo.co.uk>

> On Thu, Apr 5, 2012 at 3:23 PM, Richard Smith <richard at metafoo.co.uk>wrote:
> Hi Alex,
> I think the patch is generally looking pretty good. All of your TODOs seem
> like reasonable things to defer to later patches. I have some specific
> comments below (mostly formatting-related):
> Oh, and -- it would be great if you can come up with some way to test
> these changes. I appreciate that's going to be difficult since we don't
> accept any statement attributes yet, but you should at least be able to
> test that declaration attributes are rejected when applied to statements.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20120405/b6b1b503/attachment.html>

More information about the cfe-commits mailing list