[clang-tools-extra] c283c8d - Rewrite Doxygen comment to resolve -Wdocumentation warning (NFC)

[Salman Javed via cfe-commits]

Author: Salman Javed
Date: 2022-01-27T02:21:05+13:00
New Revision: c283c8dfb5a9770126f06f55644c6208b5582c19

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

LOG: Rewrite Doxygen comment to resolve -Wdocumentation warning (NFC)

Comment change only, no functional change intended.
Example of warning:
https://lab.llvm.org/buildbot/#/builders/188/builds/8696/steps/4/logs/warnings__2_

Added: 
    

Modified: 
    clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.h

Removed: 
    


################################################################################
diff  --git a/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.h b/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.h
index e41003262ccc..3b5f82033d25 100644
--- a/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.h
+++ b/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.h
@@ -110,8 +110,8 @@ class ClangTidyContext {
   /// This does not handle suppression of notes following a suppressed
   /// diagnostic; that is left to the caller as it requires maintaining state in
   /// between calls to this function.
-  /// If any NOLINT is malformed, e.g. a BEGIN without a subsequent END, an
-  /// error about it will be returned in output \param NoLintErrors.
+  /// If any NOLINT is malformed, e.g. a BEGIN without a subsequent END, output
+  /// \param NoLintErrors will return an error about it.
   /// If \param AllowIO is false, the function does not attempt to read source
   /// files from disk which are not already mapped into memory; such files are
   /// treated as not containing a suppression comment.