[clang] [Clang] Fix several `-Wdocumentation` warnings (NFC) (PR #70333)
via cfe-commits
cfe-commits at lists.llvm.org
Thu Oct 26 06:53:40 PDT 2023
llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-clang
Author: Egor Zhdan (egorzhdan)
<details>
<summary>Changes</summary>
```
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
^~~~~~~~~
```
---
Full diff: https://github.com/llvm/llvm-project/pull/70333.diff
1 Files Affected:
- (modified) clang/include/clang/Lex/Preprocessor.h (+3-3)
``````````diff
diff --git a/clang/include/clang/Lex/Preprocessor.h b/clang/include/clang/Lex/Preprocessor.h
index bc1d94a61508d8d..77e0c04eef6a321 100644
--- a/clang/include/clang/Lex/Preprocessor.h
+++ b/clang/include/clang/Lex/Preprocessor.h
@@ -2875,9 +2875,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
@@ -2889,7 +2889,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"
``````````
</details>
https://github.com/llvm/llvm-project/pull/70333
More information about the cfe-commits
mailing list