[all-commits] [llvm/llvm-project] 1cb15b: Correct Doxygen syntax for inline code

Aaron Puchert via All-commits all-commits at lists.llvm.org
Tue Mar 16 07:18:33 PDT 2021


  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 1cb15b10ea370178871769929ff9690f461191fc
      https://github.com/llvm/llvm-project/commit/1cb15b10ea370178871769929ff9690f461191fc
  Author: Aaron Puchert <aaron.puchert at sap.com>
  Date:   2021-03-16 (Tue, 16 Mar 2021)

  Changed paths:
    M clang/include/clang/Analysis/AnyCall.h
    M clang/include/clang/Analysis/RetainSummaryManager.h
    M clang/lib/Analysis/RetainSummaryManager.cpp
    M clang/lib/Sema/SemaDeclAttr.cpp
    M clang/lib/StaticAnalyzer/Checkers/NonnullGlobalConstantsChecker.cpp
    M clang/lib/StaticAnalyzer/Checkers/ObjCAutoreleaseWriteChecker.cpp
    M clang/lib/StaticAnalyzer/Checkers/RetainCountChecker/RetainCountDiagnostics.cpp
    M clang/lib/StaticAnalyzer/Checkers/RunLoopAutoreleaseLeakChecker.cpp
    M clang/lib/StaticAnalyzer/Core/BugReporter.cpp
    M clang/lib/StaticAnalyzer/Core/BugReporterVisitors.cpp
    M clang/lib/StaticAnalyzer/Core/ExprEngine.cpp
    M clang/lib/StaticAnalyzer/Core/PlistDiagnostics.cpp
    M llvm/include/llvm/Support/GraphWriter.h

  Log Message:
  -----------
  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




More information about the All-commits mailing list