LexerSource: Comment escape()

1 files changed, 7 insertions, 0 deletions

diff --git a/src/main/java/org/anarres/cpp/LexerSource.java b/src/main/java/org/anarres/cpp/LexerSource.java
index 931f4a7..de3da8d 100644
--- a/src/main/java/org/anarres/cpp/LexerSource.java
+++ b/src/main/java/org/anarres/cpp/LexerSource.java
@@ -305,6 +305,13 @@ public class LexerSource extends Source {
         return new Token(CPPCOMMENT, text.toString());
     }
 
+    /**
+     * Lexes an escaped character, appends the lexed escape sequence to 'text' and returns the parsed character value.
+     * @param text The buffer to which the literal escape sequence is appended.
+     * @return The new parsed character value.
+     * @throws IOException if it goes badly wrong.
+     * @throws LexerException  if it goes wrong.
+     */
     private int escape(StringBuilder text)
             throws IOException,
             LexerException {