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 | 1355bd17c6974ec0f1949409f9b521df9916ee44 (patch) | |
| tree | 85685ec8b49bcda71d8d470a251e06a6a5888292 /clang/lib | |
| parent | ff32674d3ad676d3cb23e9ca2f592a4fff729c1f (diff) | |
| download | bcm5719-llvm-1355bd17c6974ec0f1949409f9b521df9916ee44.tar.gz bcm5719-llvm-1355bd17c6974ec0f1949409f9b521df9916ee44.zip | |
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.
llvm-svn: 158299
Diffstat (limited to 'clang/lib')
| -rw-r--r-- | clang/lib/CodeGen/CGObjCRuntime.h | 2 | ||||
| -rw-r--r-- | clang/lib/Parse/ParseObjc.cpp | 10 |
2 files changed, 6 insertions, 6 deletions
diff --git a/clang/lib/CodeGen/CGObjCRuntime.h b/clang/lib/CodeGen/CGObjCRuntime.h index ccf4d4dfca5..135a080ce6f 100644 --- a/clang/lib/CodeGen/CGObjCRuntime.h +++ b/clang/lib/CodeGen/CGObjCRuntime.h @@ -179,7 +179,7 @@ public: const ObjCMethodDecl *Method = 0) = 0; /// Emit the code to return the named protocol as an object, as in a - /// @protocol expression. + /// \@protocol expression. virtual llvm::Value *GenerateProtocolRef(CGBuilderTy &Builder, const ObjCProtocolDecl *OPD) = 0; diff --git a/clang/lib/Parse/ParseObjc.cpp b/clang/lib/Parse/ParseObjc.cpp index bd1866febec..4e5b6728048 100644 --- a/clang/lib/Parse/ParseObjc.cpp +++ b/clang/lib/Parse/ParseObjc.cpp @@ -1347,15 +1347,15 @@ void Parser::ParseObjCClassInstanceVariables(Decl *interfaceDecl, /// objc-protocol-forward-reference /// /// objc-protocol-definition: -/// @protocol identifier +/// \@protocol identifier /// objc-protocol-refs[opt] /// objc-interface-decl-list -/// @end +/// \@end /// /// objc-protocol-forward-reference: -/// @protocol identifier-list ';' +/// \@protocol identifier-list ';' /// -/// "@protocol identifier ;" should be resolved as "@protocol +/// "\@protocol identifier ;" should be resolved as "\@protocol /// identifier-list ;": objc-interface-decl-list may not start with a /// semicolon in the first alternative if objc-protocol-refs are omitted. Parser::DeclGroupPtrTy @@ -2730,7 +2730,7 @@ Parser::ParseObjCEncodeExpression(SourceLocation AtLoc) { } /// objc-protocol-expression -/// @protocol ( protocol-name ) +/// \@protocol ( protocol-name ) ExprResult Parser::ParseObjCProtocolExpression(SourceLocation AtLoc) { SourceLocation ProtoLoc = ConsumeToken(); |

