aboutsummaryrefslogtreecommitdiff
path: root/clang/lib/StaticAnalyzer/Checkers/ObjCAutoreleaseWriteChecker.cpp
diff options
context:
space:
mode:
authorAaron Puchert <aaron.puchert@sap.com>2021-03-16 15:17:43 +0100
committerAaron Puchert <aaron.puchert@sap.com>2021-03-16 15:17:45 +0100
commit1cb15b10ea370178871769929ff9690f461191fc (patch)
tree7788324aa729aa6dea6496e12ccbd99a014c0d3d /clang/lib/StaticAnalyzer/Checkers/ObjCAutoreleaseWriteChecker.cpp
parent70aa319ee729227d036806fbfd00860db4565aec (diff)
downloadllvm-1cb15b10ea370178871769929ff9690f461191fc.zip
llvm-1cb15b10ea370178871769929ff9690f461191fc.tar.gz
llvm-1cb15b10ea370178871769929ff9690f461191fc.tar.bz2
Correct Doxygen syntax for inline code
There is no syntax like {@code ...} in Doxygen, @code is a block command that ends with @endcode, and generally these are not enclosed in braces. The correct syntax for inline code snippets is @c <code>. Reviewed By: aaron.ballman Differential Revision: https://reviews.llvm.org/D98665
Diffstat (limited to 'clang/lib/StaticAnalyzer/Checkers/ObjCAutoreleaseWriteChecker.cpp')
-rw-r--r--clang/lib/StaticAnalyzer/Checkers/ObjCAutoreleaseWriteChecker.cpp2
1 files changed, 1 insertions, 1 deletions
diff --git a/clang/lib/StaticAnalyzer/Checkers/ObjCAutoreleaseWriteChecker.cpp b/clang/lib/StaticAnalyzer/Checkers/ObjCAutoreleaseWriteChecker.cpp
index 7fd6e2a..c8eab32 100644
--- a/clang/lib/StaticAnalyzer/Checkers/ObjCAutoreleaseWriteChecker.cpp
+++ b/clang/lib/StaticAnalyzer/Checkers/ObjCAutoreleaseWriteChecker.cpp
@@ -8,7 +8,7 @@
//
// This file defines ObjCAutoreleaseWriteChecker which warns against writes
// into autoreleased out parameters which cause crashes.
-// An example of a problematic write is a write to {@code error} in the example
+// An example of a problematic write is a write to @c error in the example
// below:
//
// - (BOOL) mymethod:(NSError *__autoreleasing *)error list:(NSArray*) list {