Tweaks to RDoc comments to save Yardoc from choking
authorWincent Colaiuta <win@wincent.com>
Wed, 28 Jul 2010 21:04:06 +0000 (23:04 +0200)
committerWincent Colaiuta <win@wincent.com>
Wed, 28 Jul 2010 21:04:06 +0000 (23:04 +0200)
Signed-off-by: Wincent Colaiuta <win@wincent.com>
ext/mkdtemp.c

index 91ecdc1d69e5223d7e9a1a38b4e3368456361b0c..2a3e316ddd6417c4224bf50d29ba232be8263fe7 100644 (file)
@@ -39,8 +39,11 @@ VALUE yield_block(VALUE ignored, VALUE block)
     return rb_funcall(block, rb_intern("call"), 0);
 }
 
+// Document-method: mkdtemp
+//
 // call-seq:
-//     Dir.mkdtemp([string])   -> String or nil
+//     Dir.mkdtemp([string]) -> String or nil
+//     Dir.mkdtemp([string]) { ... } -> String or nil
 //
 // This method securely creates temporary directories. It is a wrapper for the
 // mkdtemp() function in the standard C library. It takes an optional String
@@ -99,5 +102,9 @@ static VALUE dir_mkdtemp_m(int argc, VALUE *argv, VALUE self)
 
 void Init_mkdtemp()
 {
+#if 0
+    // for Yardoc, need to fake this here
+    VALUE rb_cDir = rb_define_class("Dir", rb_cObject);
+#endif
     rb_define_singleton_method(rb_cDir, "mkdtemp", dir_mkdtemp_m, -1);
 }