[cfe-commits] PATCH: Fix another bunch of Doxygen-formatting gremlins

[Chandler Carruth]

On Tue, Jun 12, 2012 at 11:59 PM, Sean Silva <silvas at purdue.edu> wrote:

> I'm kind of against the backslash-escaping because it makes the comments
> uglier to read in the source. What does doxygen do with @ and # anyway? Is
> there a way to tell doxygen "don't give @ and # the special meaning"?


I really don't think this is the priority. Instead I think the priority of
making our web-based documentation significantly more usable is correct.

Also, '@' is used in several parts of the codebase for doxygen.

Finally, I think you're overestimating how hard it is to read
backslash-escaping. It's something C++ developers should be pretty familiar
with...


> Another thing to consider is that if programmer awareness of this isn't
> raised, then all of these changes are "going against the grain" of new
> comments, and will suffer a kind of "rot" in that respect.
>

This is what code review is for.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20120613/5f86ef29/attachment.html>