diff options
author | James Dennett <jdennett@google.com> | 2012-06-13 22:07:09 +0000 |
---|---|---|
committer | James Dennett <jdennett@google.com> | 2012-06-13 22:07:09 +0000 |
commit | 809d1be9820039b4cf6efa48246a0d70ffa13394 (patch) | |
tree | dd2a3d5ac8ce7729f0ecf9b4fc01c6c3a60d14db /include/clang/Frontend/FrontendOptions.h | |
parent | 4ef2f6a95146423a1947b98458cc95c00a8b3ebd (diff) |
More doxygen/documentation cleanups.
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.
This patch touches documentation/comments only.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@158422 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/clang/Frontend/FrontendOptions.h')
-rw-r--r-- | include/clang/Frontend/FrontendOptions.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/clang/Frontend/FrontendOptions.h b/include/clang/Frontend/FrontendOptions.h index 78d3adfc6b..84b600d742 100644 --- a/include/clang/Frontend/FrontendOptions.h +++ b/include/clang/Frontend/FrontendOptions.h @@ -42,8 +42,8 @@ namespace frontend { PrintDeclContext, ///< Print DeclContext and their Decls. PrintPreamble, ///< Print the "preamble" of the input file PrintPreprocessedInput, ///< -E mode. - RewriteMacros, ///< Expand macros but not #includes. - RewriteIncludes, ///< Expand #includes but not macros. + RewriteMacros, ///< Expand macros but not \#includes. + RewriteIncludes, ///< Expand \#includes but not macros. RewriteObjC, ///< ObjC->C Rewriter. RewriteTest, ///< Rewriter playground RunAnalysis, ///< Run one or more source code analyses. |