Document WeakRef

Fixes #3926
crystal-lang · Apr 20, 2017 · 24c8321 · 24c8321
1 parent 919bc4c
commit 24c8321
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/docs_main.cr b/src/docs_main.cr
@@ -29,6 +29,7 @@ require "./socket"
 require "./spec"
 require "./string/**"
 require "./thread"
+require "./weak_ref"
 require "./xml"
 require "./yaml"
 require "./benchmark"

diff --git a/src/weak_ref.cr b/src/weak_ref.cr
@@ -1,5 +1,11 @@
 # Weak Reference class that allows a referenced object to be garbage-collected.
 #
+# ```
+# ref = WeakRef.new("oof".reverse)
+# p ref.value # => "foo"
+# GC.collect
+# p ref.value # => nil
+# ```
 class WeakRef(T)
   @target : Void*
 
@@ -10,6 +16,7 @@ class WeakRef(T)
     end
   end
 
+  # :nodoc:
   def self.allocate
     ptr = GC.malloc_atomic(instance_sizeof(self)).as(self)
     set_crystal_type_id(ptr)