[TASK] Deprecate ParserState::comsumeWhitespace (#670)

ziegenberg · ziegenberg · commit d53d9bab5f24 · 2024-08-25T19:19:18.000+02:00
Signed-off-by: Daniel Ziegenberg &lt;daniel@ziegenberg.at&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,8 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ### Deprecated
 
+- Deprecate `ParserState::consumeWhiteSpace()` in favor of `ParserState::consumeWhiteSpaceWithComments()` (#670)
+
 ### Removed
 
 ### Fixed
diff --git a/src/Parsing/ParserState.php b/src/Parsing/ParserState.php
@@ -232,6 +232,14 @@ public function parseCharacter($bIsForIdentifier)
      *
      * @throws UnexpectedEOFException
      * @throws UnexpectedTokenException
+     *
+     * @deprecated From version 9.0.0 onwards this method will be undergo a breaking
+     *      change. This method will no longer consume comments, only whitespace.
+     *      Use `ParserState::consumeWhiteSpaceWithComments` as a replacement if you
+     *      need the former behaviour of consuming whitespace and comments.
+     *
+     * @see `ParserState::consumeWhiteSpaceWithComments` for a version that also
+     *      returns comments.
      */
     public function consumeWhiteSpace()
     {
