about summary refs log tree commit homepage
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2011-01-14 14:21:41 -0800
committerEric Wong <normalperson@yhbt.net>2011-01-14 14:21:55 -0800
commitfd00bf25c8da9a04952b14bceb7e64420caf9bdb (patch)
treef9aa76ae382a9cf322eadfae702c28f807c98590
parentf61187d870c580b6411d025ac1850cc3e5f2eb6a (diff)
call-seq is needed to make C functions look good
-rw-r--r--ext/clogger_ext/clogger.c16
1 files changed, 15 insertions, 1 deletions
diff --git a/ext/clogger_ext/clogger.c b/ext/clogger_ext/clogger.c
index cc66f3e..ac473bf 100644
--- a/ext/clogger_ext/clogger.c
+++ b/ext/clogger_ext/clogger.c
@@ -818,7 +818,7 @@ static VALUE clogger_call(VALUE self, VALUE env)
         return rv;
 }
 
-/* :nodoc */
+/* :nodoc: */
 static VALUE clogger_init_copy(VALUE clone, VALUE orig)
 {
         struct clogger *a = clogger_get(orig);
@@ -837,6 +837,14 @@ static VALUE clogger_init_copy(VALUE clone, VALUE orig)
 
 #define CONST_GLOBAL_STR(val) CONST_GLOBAL_STR2(val, #val)
 
+/*
+ * call-seq:
+ *   clogger.respond_to?(:to_path) => true or false
+ *   clogger.respond_to?(:close)  => true
+ *
+ * used to delegate +:to_path+ checks for Rack webservers that optimize
+ * static file serving
+ */
 static VALUE respond_to(VALUE self, VALUE method)
 {
         struct clogger *c = clogger_get(self);
@@ -847,6 +855,12 @@ static VALUE respond_to(VALUE self, VALUE method)
         return rb_respond_to(c->body, id);
 }
 
+/*
+ * call-seq:
+ *   clogger.to_path
+ *
+ * used to proxy +:to_path+ method calls to the wrapped response body.
+ */
 static VALUE to_path(VALUE self)
 {
         struct clogger *c = clogger_get(self);