diff options
author | Salman Javed <mail@salmanjaved.org> | 2021-12-23 10:18:45 +1300 |
---|---|---|
committer | Salman Javed <mail@salmanjaved.org> | 2021-12-23 10:25:05 +1300 |
commit | d840f3edf0297699e750413e629543c2a9271b90 (patch) | |
tree | ffa81d8dc7affdb2ebad8652b54dc4b9263aa760 | |
parent | 90d1786ba0c233456b7785fe4b93eca835d56028 (diff) | |
download | llvm-d840f3edf0297699e750413e629543c2a9271b90.zip llvm-d840f3edf0297699e750413e629543c2a9271b90.tar.gz llvm-d840f3edf0297699e750413e629543c2a9271b90.tar.bz2 |
Resolve -Wdocumentation warning in ClangTidyDiagnosticConsumer (NFC)
Change to comments only; NFC.
```
ClangTidyDiagnosticConsumer.h:245:6: warning: '\param' command used in a
comment that is not attached to a function declaration [-Wdocumentation]
```
See this build for an example:
https://lab.llvm.org/buildbot/#/builders/109/builds/27293/steps/5/logs/warnings__702_
-rw-r--r-- | clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.h | 6 |
1 files changed, 2 insertions, 4 deletions
diff --git a/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.h b/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.h index 23800f5..69f1ced 100644 --- a/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.h +++ b/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.h @@ -241,14 +241,12 @@ getFixIt(const tooling::Diagnostic &Diagnostic, bool AnyFix); /// A diagnostic consumer that turns each \c Diagnostic into a /// \c SourceManager-independent \c ClangTidyError. -/// -/// \param EnableNolintBlocks Enables diagnostic-disabling inside blocks of -/// code, delimited by NOLINTBEGIN and NOLINTEND. -// // FIXME: If we move away from unit-tests, this can be moved to a private // implementation file. class ClangTidyDiagnosticConsumer : public DiagnosticConsumer { public: + /// \param EnableNolintBlocks Enables diagnostic-disabling inside blocks of + /// code, delimited by NOLINTBEGIN and NOLINTEND. ClangTidyDiagnosticConsumer(ClangTidyContext &Ctx, DiagnosticsEngine *ExternalDiagEngine = nullptr, bool RemoveIncompatibleErrors = true, |