Internal API notes.

Author: e3ndr

src/main/java/co/casterlabs/rakurai/json/lex/JsonParser.java

@@ -33,6 +33,20 @@ public static JsonElement parse(char[] json) {
         return parsed;
     }
 
+    /**
+     * Consumes the next token from the queue and parses it into a JsonElement. This
+     * method is recursive and will call itself when parsing nested structures
+     * (objects and arrays).
+     * 
+     * When done, the queue may contain tokens that were not consumed during
+     * parsing.
+     * 
+     * For example, when parsing an object, the method will consume tokens until it
+     * finds the closing brace, but it will not consume any tokens that come after
+     * the closing brace. The caller is responsible for ensuring that the queue
+     * contains the correct tokens for parsing and for handling any remaining tokens
+     * after parsing is complete.
+     */
     private static JsonElement parseTokens(Queue<JsonToken> tokens) {
         JsonToken token = tokens.remove();
         switch (token.type) {