[clang] [clang][Lex] Fix conflicting RemoveTopOfLexerStack docs (PR #214679)

[via cfe-commits]

llvmorg-github-actions[bot] wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-clang

Author: richardmilles

<details>
<summary>Changes</summary>

Align the header comment with the implementation: this API is for when the top-of-stack lexer state is unknown.

Fixes #<!-- -->53214

---
Full diff: https://github.com/llvm/llvm-project/pull/214679.diff


1 Files Affected:

- (modified) clang/include/clang/Lex/Preprocessor.h (+1-1) 


``````````diff
diff --git a/clang/include/clang/Lex/Preprocessor.h b/clang/include/clang/Lex/Preprocessor.h
index e752010dd2062..6b91a622961c4 100644
--- a/clang/include/clang/Lex/Preprocessor.h
+++ b/clang/include/clang/Lex/Preprocessor.h
@@ -1747,7 +1747,7 @@ class Preprocessor {
   /// Pop the current lexer/macro exp off the top of the lexer stack.
   ///
   /// This should only be used in situations where the current state of the
-  /// top-of-stack lexer is known.
+  /// top-of-stack lexer is unknown.
   void RemoveTopOfLexerStack();
 
   /// From the point that this method is called, and until

``````````

</details>


https://github.com/llvm/llvm-project/pull/214679