Add documentation about yyatEOF()

regisd · regisd · commit 44059777c19d · 2019-12-03T00:40:46.000+01:00
diff --git a/docs/md/lex-specs.md b/docs/md/lex-specs.md
@@ -1153,7 +1153,12 @@ Currently, the API consists of the following methods and member fields:
     Unicode surrogate characters, and as a result expressions such as
     `[^]` (any character) and `\p{...}` (characters having a Unicode
     property) can match more than one `char`.
-
+    
+-   `yyatEOF()`
+    
+    returns whether the scanner has reached the end of the reader it reads
+    from, which often corresponds to the end of file.
+    
 -   `int yyline`
 
     contains the current line of input (starting with 0, only active
