Documentation for Token

2 files changed, 20 insertions, 12 deletions

diff --git a/src/parcom.cr b/src/parcom.cr
index 16abe22..82c4c3b 100644
--- a/src/parcom.cr
+++ b/src/parcom.cr
@@ -81,18 +81,6 @@ module Parcom
     end
   end
 
-  class Token(T) < Parser(T, T)
-    def initialize(@expected : T)
-      @p = Satisfy(T).new { |x| x == @expected }
-    end
-
-    def parse(tokens : Tokens(T)) : Result(T, T)
-      @p.parse(tokens)
-    rescue ex : ParserFail
-      raise ParserFail.new("Token <#{@expected}>: #{ex.message}")
-    end
-  end
-
   class Alt(T, V) < Parser(T, V)
     def initialize(@p1 : Parser(T, V), @p2 : Parser(T, V))
     end
diff --git a/src/parcom/token.cr b/src/parcom/token.cr
new file mode 100644
index 0000000..b4e1fef
--- /dev/null
+++ b/src/parcom/token.cr
@@ -0,0 +1,20 @@
+require "./satisfy"
+
+module Parcom
+  # `Token` is a `Parser` that tries to parse a specific token
+  # from the input stream.
+  class Token(T) < Parser(T, T)
+    # Accepts the token that this parser will try to parse.
+    def initialize(@expected : T)
+      @p = Satisfy(T).new { |x| x == @expected }
+    end
+
+    # Tries to parse the specified token from the input stream.
+    def parse(tokens : Tokens(T)) : Result(T, T)
+      @p.parse(tokens)
+    rescue ex : ParserFail
+      raise ParserFail.new("Token <#{@expected}>: #{ex.message}")
+    end
+  end
+end
+