[clang-tools-extra] cb5d0b4 - AST.h - fix Wdocumentation warnings. NFC.

[Simon Pilgrim via cfe-commits]

Author: Simon Pilgrim
Date: 2022-08-01T15:38:06+01:00
New Revision: cb5d0b41baf2f137f377a8d03481d6a5574a31ec

URL: https://github.com/llvm/llvm-project/commit/cb5d0b41baf2f137f377a8d03481d6a5574a31ec
DIFF: https://github.com/llvm/llvm-project/commit/cb5d0b41baf2f137f377a8d03481d6a5574a31ec.diff

LOG: AST.h - fix Wdocumentation warnings. NFC.

But ObjC code examples in quotes to stop confusing the doxygen parser

Added: 
    

Modified: 
    clang-tools-extra/clangd/AST.h

Removed: 
    


################################################################################
diff  --git a/clang-tools-extra/clangd/AST.h b/clang-tools-extra/clangd/AST.h
index f313161b6c60..de03e471be40 100644
--- a/clang-tools-extra/clangd/AST.h
+++ b/clang-tools-extra/clangd/AST.h
@@ -98,22 +98,22 @@ SymbolID getSymbolID(const llvm::StringRef MacroName, const MacroInfo *MI,
 ///
 /// Objective-C classes can have three types of declarations:
 ///
-/// - forward declaration: @class MyClass;
-/// - true declaration (interface definition): @interface MyClass ... @end
-/// - true definition (implementation): @implementation MyClass ... @end
+/// - forward declaration: "@class MyClass;"
+/// - true declaration (interface definition): "@interface MyClass ... @end"
+/// - true definition (implementation): "@implementation MyClass ... @end"
 ///
 /// Objective-C categories are extensions on classes:
 ///
-/// - declaration: @interface MyClass (Ext) ... @end
-/// - definition: @implementation MyClass (Ext) ... @end
+/// - declaration: "@interface MyClass (Ext) ... @end"
+/// - definition: "@implementation MyClass (Ext) ... @end"
 ///
 /// With one special case, a class extension, which is normally used to keep
 /// some declarations internal to a file without exposing them in a header.
 ///
-/// - class extension declaration: @interface MyClass () ... @end
-/// - which really links to class definition: @implementation MyClass ... @end
+/// - class extension declaration: "@interface MyClass () ... @end"
+/// - which really links to class definition: "@implementation MyClass ... @end"
 ///
-/// For Objective-C protocols, e.g. @protocol MyProtocol ... @end this will
+/// For Objective-C protocols, e.g. "@protocol MyProtocol ... @end" this will
 /// return nullptr as protocols don't have an implementation.
 const ObjCImplDecl *getCorrespondingObjCImpl(const ObjCContainerDecl *D);