Documentation for AnyToken

2 files changed, 18 insertions, 10 deletions

diff --git a/src/parcom.cr b/src/parcom.cr
index 5ce8ebe..f6d1e05 100644
--- a/src/parcom.cr
+++ b/src/parcom.cr
@@ -81,16 +81,6 @@ module Parcom
     end
   end
 
-  class AnyToken(T) < Parser(T, T)
-    def parse(tokens : Tokens(T)) : Result(T, T)
-      if tokens.empty?
-        raise ParserFail.new("AnyToken: input was empty")
-      else
-        Result.new(tokens[1..], tokens[0])
-      end
-    end
-  end
-
   class Eof(T) < Parser(T, Nil)
     def parse(tokens : Tokens(T)) : Result(T, Nil)
       if tokens.empty?
diff --git a/src/parcom/any_token.cr b/src/parcom/any_token.cr
new file mode 100644
index 0000000..1f65bfc
--- /dev/null
+++ b/src/parcom/any_token.cr
@@ -0,0 +1,18 @@
+require "./parser.cr"
+
+module Parcom
+  # `AnyToken` is a `Parser` that consumes exactly one token from
+  # the input stream and returns it.
+  # It fails if the input stream is empty.
+  class AnyToken(T) < Parser(T, T)
+    # Parses the first token in the input, fails if the input is empty.
+    def parse(tokens : Tokens(T)) : Result(T, T)
+      if tokens.empty?
+        raise ParserFail.new("AnyToken: input was empty")
+      else
+        Result.new(tokens[1..], tokens[0])
+      end
+    end
+  end
+end
+