[clang] f3f0672 - [Clang] Fix several `-Wdocumentation` warnings (NFC)
via cfe-commits
cfe-commits at lists.llvm.org
Thu Oct 26 08:14:26 PDT 2023
Author: Egor Zhdan
Date: 2023-10-26T16:14:23+01:00
New Revision: f3f0672039f42610101db8bbe97f521a65ede413
URL: https://github.com/llvm/llvm-project/commit/f3f0672039f42610101db8bbe97f521a65ede413
DIFF: https://github.com/llvm/llvm-project/commit/f3f0672039f42610101db8bbe97f521a65ede413.diff
LOG: [Clang] Fix several `-Wdocumentation` warnings (NFC)
```
clang/include/clang/Lex/Preprocessor.h:2893:14: warning: parameter 'isEnter:' not found in the function declaration [-Wdocumentation]
/// \param isEnter: true if this PP is entering a region; otherwise, this PP
^~~~~~~~
clang/include/clang/Lex/Preprocessor.h:2895:14: warning: parameter 'Loc:' not found in the function declaration [-Wdocumentation]
/// \param Loc: the location of the entry or exit of a
^~~~
clang/include/clang/Lex/Preprocessor.h:2907:14: warning: parameter 'StartLoc:' not found in the function declaration [-Wdocumentation]
/// \param StartLoc: output argument. It will be set to the start location of
^~~~~~~~~
```
Added:
Modified:
clang/include/clang/Lex/Preprocessor.h
Removed:
################################################################################
diff --git a/clang/include/clang/Lex/Preprocessor.h b/clang/include/clang/Lex/Preprocessor.h
index 18d88407ae12c90..4a99447e757c6ac 100644
--- a/clang/include/clang/Lex/Preprocessor.h
+++ b/clang/include/clang/Lex/Preprocessor.h
@@ -2879,9 +2879,9 @@ class Preprocessor {
/// Alter the state of whether this PP currently is in a
/// "-Wunsafe-buffer-usage" opt-out region.
///
- /// \param isEnter: true if this PP is entering a region; otherwise, this PP
+ /// \param isEnter true if this PP is entering a region; otherwise, this PP
/// is exiting a region
- /// \param Loc: the location of the entry or exit of a
+ /// \param Loc the location of the entry or exit of a
/// region
/// \return true iff it is INVALID to enter or exit a region, i.e.,
/// attempt to enter a region before exiting a previous region, or exiting a
@@ -2893,7 +2893,7 @@ class Preprocessor {
/// opt-out region
bool isPPInSafeBufferOptOutRegion();
- /// \param StartLoc: output argument. It will be set to the start location of
+ /// \param StartLoc output argument. It will be set to the start location of
/// the current "-Wunsafe-buffer-usage" opt-out region iff this function
/// returns true.
/// \return true iff this PP is currently in a "-Wunsafe-buffer-usage"
More information about the cfe-commits
mailing list