[cfe-dev] Random, tiny question about doxygen comment style

Chandler Carruth chandlerc at google.com
Thu Jun 14 22:25:14 PDT 2012

Figured it was good to ask this as James is busy making sure the Clang
doxygen is actually all well formed, and reasonably linked together so we
have proper docs for the ever growing number of Clang library users...

There are two ways to use doxygen directives:

/// \brief ...


/// @brief ...

I'd like to pick one form and be consistent going forward (with no real
intention or need to clean up existing comments) just so the bikeshed stays
a consistent hue.

I prefer '\brief' by a small margin, mostly because I read all of the @foo
things as either email stuff, twitter stuff, or ObjC stuff. Does anyone
care passionately about this bikeshed being painted the other color? If so,
I cede the field. I'm much more interested in having a single preferred
form than which one it is. The mixture kills me. =]

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-dev/attachments/20120614/7cf41ecb/attachment.html>

More information about the cfe-dev mailing list