summaryrefslogtreecommitdiff
path: root/ext/dl/cptr.c
diff options
context:
space:
mode:
authortenderlove <tenderlove@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2009-11-06 22:50:05 +0000
committertenderlove <tenderlove@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2009-11-06 22:50:05 +0000
commitbc52ea0fde16d2a5c209fb09a8e341d2905d2705 (patch)
tree1cf8b274c54fd6ef83fcf10a01cad44110848ade /ext/dl/cptr.c
parent5296367cf4d22222aad08acaa65eb369de65241b (diff)
* ext/dl/cptr.c (rb_dlptr_s_malloc, rb_dlptr_initialize): adding
documentation * test/dl/test_cptr.rb (**): testing that malloc works when passed free functions git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@25678 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/dl/cptr.c')
-rw-r--r--ext/dl/cptr.c19
1 files changed, 19 insertions, 0 deletions
diff --git a/ext/dl/cptr.c b/ext/dl/cptr.c
index a5b07edc736..0c85a91b6cf 100644
--- a/ext/dl/cptr.c
+++ b/ext/dl/cptr.c
@@ -123,6 +123,15 @@ rb_dlptr_s_allocate(VALUE klass)
return obj;
}
+/*
+ * call-seq:
+ * DL::CPtr.new(address) => dl_cptr
+ * DL::CPtr.new(address, size) => dl_cptr
+ * DL::CPtr.new(address, size, freefunc) => dl_cptr
+ *
+ * Create a new pointer to +address+ with an optional +size+ and +freefunc+.
+ * +freefunc+ will be called when the instance is garbage collected.
+ */
static VALUE
rb_dlptr_initialize(int argc, VALUE argv[], VALUE self)
{
@@ -163,6 +172,16 @@ rb_dlptr_initialize(int argc, VALUE argv[], VALUE self)
return Qnil;
}
+/*
+ * call-seq:
+ *
+ * DL::CPtr.malloc(size, freefunc = nil) => dl cptr instance
+ *
+ * Allocate +size+ bytes of memory and associate it with an optional
+ * +freefunc+ that will be called when the pointer is garbage collected.
+ * +freefunc+ must be an address pointing to a function or an instance of
+ * DL::CFunc
+ */
static VALUE
rb_dlptr_s_malloc(int argc, VALUE argv[], VALUE klass)
{