[cfe-commits] PATCH: Fix another bunch of Doxygen-formatting gremlins
James Dennett
jdennett at google.com
Tue Jun 12 16:57:17 PDT 2012
I'll commit this in the next day or two if there are no objections;
this is sent in case anyone somehow feels that this is a bad approach
to fixing up Clang's documentation, or can spot any bad edits. The
diff touches comments only.
This reduces the number of warnings generated by Doxygen by about 100
(roughly 10%). Issues addressed:
(1) Primarily, backslash-escaped "@foo" and "#bah" in Doxygen comments
when they're not supposed to be Doxygen commands or links, and
similarly for "<baz>" when it's not intended as as HTML tag;
(2) Changed some \t commands (which don't exist) to \c ("to refer to a
word of code", as the Doxygen manual says);
(3) \precondition becomes \pre;
(4) When touching comments, deleted a couple of spurious spaces in them;
(5) Changed some \n and \r to \\n and \\r;
(6) Fixed one tiny typo: #pragms -> #pragma.
TIA for any comments.
-- James
-------------- next part --------------
A non-text attachment was scrubbed...
Name: doxydocs-2.patch
Type: application/octet-stream
Size: 34909 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20120612/675c0999/attachment.obj>
More information about the cfe-commits
mailing list