Added some documentation

wedesoft · Nov 17, 2010 · 5668758 · 5668758
1 parent eec23bf
commit 5668758
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/Rakefile b/Rakefile
@@ -7,7 +7,7 @@ require 'rake/loaders/makefile'
 require 'rbconfig'
 
 PKG_NAME = 'malloc'
-PKG_VERSION = '1.3.4'
+PKG_VERSION = '1.3.5'
 CFG = RbConfig::CONFIG
 CXX = ENV[ 'CXX' ] || 'g++'
 RB_FILES = FileList[ 'lib/**/*.rb' ]

diff --git a/lib/malloc_ext.rb b/lib/malloc_ext.rb
@@ -92,6 +92,14 @@ def inspect
 
     # Duplicate object
     #
+    # @example Duplicating a Malloc object
+    #   m = Malloc.new 3
+    #   m.write 'aaa'
+    #   n = m.dup
+    #   n.write 'bbb'
+    #   m.read 3
+    #   "aaa"
+    #
     # @return [Malloc] A new malloc object with a copy of the data.
     def dup
       retval = Malloc.new @size