From d4582b8e6d056f5d991f1b8372e89a6aae58feae Mon Sep 17 00:00:00 2001 From: Jordan Rose Date: Wed, 3 Apr 2013 01:39:23 +0000 Subject: [PATCH] Escape more @ signs in Doxygen comments. Doxygen treats "@command" the same as "\command" in a doc comment, so whenever we talk about Objective-C things like "@interface" we have to make sure to escape them. Let's try to keep Clang -Wdocumentation-clean! git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@178603 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/clang/AST/CommentCommandTraits.h | 4 ++-- include/clang/AST/DeclBase.h | 2 +- include/clang/AST/ExprObjC.h | 10 +++++++--- lib/Sema/SemaDecl.cpp | 4 ++-- 4 files changed, 12 insertions(+), 8 deletions(-) diff --git a/include/clang/AST/CommentCommandTraits.h b/include/clang/AST/CommentCommandTraits.h index 9eb99d506b..d1f5209d1e 100644 --- a/include/clang/AST/CommentCommandTraits.h +++ b/include/clang/AST/CommentCommandTraits.h @@ -105,10 +105,10 @@ struct CommandInfo { unsigned IsFunctionDeclarationCommand : 1; /// \brief True if block command is further describing a container API; such - /// as @coclass, @classdesign, etc. + /// as \@coclass, \@classdesign, etc. unsigned IsRecordLikeDetailCommand : 1; - /// \brief True if block command is a container API; such as @interface. + /// \brief True if block command is a container API; such as \@interface. unsigned IsRecordLikeDeclarationCommand : 1; /// \brief True if this command is unknown. This \c CommandInfo object was diff --git a/include/clang/AST/DeclBase.h b/include/clang/AST/DeclBase.h index 3248d23f42..852bb9ab04 100644 --- a/include/clang/AST/DeclBase.h +++ b/include/clang/AST/DeclBase.h @@ -135,7 +135,7 @@ public: /// or member ends up here. IDNS_Ordinary = 0x0020, - /// Objective C @protocol. + /// Objective C \@protocol. IDNS_ObjCProtocol = 0x0040, /// This declaration is a friend function. A friend function diff --git a/include/clang/AST/ExprObjC.h b/include/clang/AST/ExprObjC.h index 5211171541..dfd45279dd 100644 --- a/include/clang/AST/ExprObjC.h +++ b/include/clang/AST/ExprObjC.h @@ -417,9 +417,13 @@ public: child_range children() { return child_range(); } }; -/// ObjCProtocolExpr used for protocol expression in Objective-C. This is used -/// as: @protocol(foo), as in: -/// obj conformsToProtocol:@protocol(foo)] +/// ObjCProtocolExpr used for protocol expression in Objective-C. +/// +/// This is used as: \@protocol(foo), as in: +/// \code +/// [obj conformsToProtocol:@protocol(foo)] +/// \endcode +/// /// The return type is "Protocol*". class ObjCProtocolExpr : public Expr { ObjCProtocolDecl *TheProtocol; diff --git a/lib/Sema/SemaDecl.cpp b/lib/Sema/SemaDecl.cpp index beae217e01..16887da457 100644 --- a/lib/Sema/SemaDecl.cpp +++ b/lib/Sema/SemaDecl.cpp @@ -10807,8 +10807,8 @@ Decl *Sema::ActOnIvar(Scope *S, } /// ActOnLastBitfield - This routine handles synthesized bitfields rules for -/// class and class extensions. For every class @interface and class -/// extension @interface, if the last ivar is a bitfield of any type, +/// class and class extensions. For every class \@interface and class +/// extension \@interface, if the last ivar is a bitfield of any type, /// then add an implicit `char :0` ivar to the end of that interface. void Sema::ActOnLastBitfield(SourceLocation DeclLoc, SmallVectorImpl &AllIvarDecls) { -- 2.40.0