about summary refs log tree commit homepage
diff options
context:
space:
mode:
authorEric Wong <kcar-public@bogomips.org>2017-03-05 22:52:23 +0000
committerEric Wong <kcar-public@bogomips.org>2017-03-05 22:52:23 +0000
commitf685be5e654d956595c366b3a4278fb7e79a3e36 (patch)
tree96102b0d6b451d3da99caaf0f3664ba5916252b6
parentd382b68bfdbedec9210e5d7686013372960c8915 (diff)
downloadkcar-f685be5e654d956595c366b3a4278fb7e79a3e36.tar.gz
-rw-r--r--ext/kcar/kcar.rl5
-rw-r--r--lib/kcar/response.rb4
2 files changed, 7 insertions, 2 deletions
diff --git a/ext/kcar/kcar.rl b/ext/kcar/kcar.rl
index ef3e393..2155ab4 100644
--- a/ext/kcar/kcar.rl
+++ b/ext/kcar/kcar.rl
@@ -718,6 +718,11 @@ void Init_kcar_ext(void)
   VALUE mKcar = rb_define_module("Kcar");
   VALUE cParser = rb_define_class_under(mKcar, "Parser", rb_cObject);
 
+  /*
+   * Document-class: Kcar::ParserError
+   *
+   * This is raised if there are parsing errors.
+   */
   eParserError = rb_define_class_under(mKcar, "ParserError", rb_eIOError);
 
   rb_define_alloc_func(cParser, kcar_alloc);
diff --git a/lib/kcar/response.rb b/lib/kcar/response.rb
index 954502c..c74bb4b 100644
--- a/lib/kcar/response.rb
+++ b/lib/kcar/response.rb
@@ -1,8 +1,8 @@
 # -*- encoding: binary -*-
 
 
-# This may be used to generate a Rack response
-#
+# This may be used to generate a Rack response synchronously.
+
 class Kcar::Response
   attr_accessor :sock, :hdr, :unchunk, :buf, :parser