From 4515fc22893bbc3d7cc1e1b1dc3e92fc8adc3bdd Mon Sep 17 00:00:00 2001
From: tenderlove <tenderlove@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Sun, 1 Nov 2009 01:47:08 +0000
Subject: * ext/dl/cptr.c (rb_dlptr_ptr, rb_dlptr_ref) adding documentation *
 test/dl/test_cptr.rb (test_ref_ptr) testing CPtr#ref and CPtr#ptr

git-svn-id: http://svn.ruby-lang.org/repos/ruby/trunk@25608 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 ext/dl/cptr.c | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'ext')

diff --git a/ext/dl/cptr.c b/ext/dl/cptr.c
index 555236f2a..466905f69 100644
--- a/ext/dl/cptr.c
+++ b/ext/dl/cptr.c
@@ -210,6 +210,12 @@ rb_dlptr_to_value(VALUE self)
     return (VALUE)(data->ptr);
 }
 
+/*
+ * call-seq: ptr
+ *
+ * Returns a DL::CPtr that is a dereferenced pointer for this DL::CPtr.
+ * Analogous to the star operator in C.
+ */
 VALUE
 rb_dlptr_ptr(VALUE self)
 {
@@ -219,6 +225,12 @@ rb_dlptr_ptr(VALUE self)
     return rb_dlptr_new(*((void**)(data->ptr)),0,0);
 }
 
+/*
+ * call-seq: ref
+ *
+ * Returns a DL::CPtr that is a reference pointer for this DL::CPtr.
+ * Analogous to the ampersand operator in C.
+ */
 VALUE
 rb_dlptr_ref(VALUE self)
 {
-- 
cgit