diff options
author | James Dennett <jdennett@google.com> | 2012-06-11 06:19:40 +0000 |
---|---|---|
committer | James Dennett <jdennett@google.com> | 2012-06-11 06:19:40 +0000 |
commit | 17d26a6c1f2cb921d0000c337b4967699dc928fd (patch) | |
tree | 5dd1815e0f5e5a978f8991581972328cd3003249 /include/clang/Serialization/ASTBitCodes.h | |
parent | 7ed25df166c68a3d67f0f05b0b7dd802c57adfb8 (diff) |
Documentation cleanup, fixing Doxygen markup. Mostly this avoids common terms
such as "protocol" and "expression" being implicitly turned into links to
mistakenly-generated Doxygen pages:
- Escaping @ symbols when Doxygen would otherwise incorrectly interpret them;
- Escaping # symbols when they're not intended as explicit Doxygen link
requests, such as when discussing preprocessor directives;
- In one odd case, unescaping @ in @__experimental_modules_import, because
Doxygen wrote '\@' to the output in that case, causing the example in the
description of ImportDecl to be wrong; and
- Fixing a typo: @breif -> @brief.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@158299 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/clang/Serialization/ASTBitCodes.h')
-rw-r--r-- | include/clang/Serialization/ASTBitCodes.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/clang/Serialization/ASTBitCodes.h b/include/clang/Serialization/ASTBitCodes.h index f177b2fd59..ec6775e94f 100644 --- a/include/clang/Serialization/ASTBitCodes.h +++ b/include/clang/Serialization/ASTBitCodes.h @@ -405,7 +405,7 @@ namespace clang { /// sets. CXX_BASE_SPECIFIER_OFFSETS = 37, - /// \brief Record code for #pragma diagnostic mappings. + /// \brief Record code for \#pragma diagnostic mappings. DIAG_PRAGMA_MAPPINGS = 38, /// \brief Record code for special CUDA declarations. @@ -417,7 +417,7 @@ namespace clang { /// \brief The directory that the PCH was originally created in. ORIGINAL_PCH_DIR = 41, - /// \brief Record code for floating point #pragma options. + /// \brief Record code for floating point \#pragma options. FP_PRAGMA_OPTIONS = 42, /// \brief Record code for enabled OpenCL extensions. @@ -441,7 +441,7 @@ namespace clang { MODULE_OFFSET_MAP = 47, /// \brief Record code for the source manager line table information, - /// which stores information about #line directives. + /// which stores information about \#line directives. SOURCE_MANAGER_LINE_TABLE = 48, /// \brief Record code for map of Objective-C class definition IDs to the @@ -1089,7 +1089,7 @@ namespace clang { EXPR_OBJC_MESSAGE_EXPR, /// \brief An ObjCIsa Expr record. EXPR_OBJC_ISA, - /// \breif An ObjCIndirectCopyRestoreExpr record. + /// \brief An ObjCIndirectCopyRestoreExpr record. EXPR_OBJC_INDIRECT_COPY_RESTORE, /// \brief An ObjCForCollectionStmt record. |