summaryrefslogtreecommitdiff
path: root/lib/finalize.rb
diff options
context:
space:
mode:
authordrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2006-08-04 18:05:50 +0000
committerdrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2006-08-04 18:05:50 +0000
commit52c034aecb365c6cf2a41b8648c3e87fb335fdaf (patch)
tree199813273b1cd9a90b40e3dc797303d0e5f8c67b /lib/finalize.rb
parent4db2df633cc784c40e21b3df38fe9a6dd1b0ff0b (diff)
Documentation cleanup.
Includes patches by Hugh Sasse: * ping.rb * weakref.rb * mailread.rb git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@10668 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/finalize.rb')
-rw-r--r--lib/finalize.rb39
1 files changed, 23 insertions, 16 deletions
diff --git a/lib/finalize.rb b/lib/finalize.rb
index ed1ccc830f..4a9d877edc 100644
--- a/lib/finalize.rb
+++ b/lib/finalize.rb
@@ -1,44 +1,51 @@
-#
+#--
# finalizer.rb -
# $Release Version: 0.3$
# $Revision: 1.4 $
# $Date: 1998/02/27 05:34:33 $
# by Keiju ISHITSUKA
+#++
#
-# --
-#
-# Usage:
+# Usage:
#
+# add dependency R_method(obj, dependant)
# add(obj, dependant, method = :finalize, *opt)
# add_dependency(obj, dependant, method = :finalize, *opt)
-# add dependency R_method(obj, dependant)
#
+# delete dependency R_method(obj, dependant)
# delete(obj_or_id, dependant, method = :finalize)
# delete_dependency(obj_or_id, dependant, method = :finalize)
-# delete dependency R_method(obj, dependant)
-# delete_all_dependency(obj_or_id, dependant)
+#
# delete dependency R_*(obj, dependant)
-# delete_by_dependant(dependant, method = :finalize)
+# delete_all_dependency(obj_or_id, dependant)
+#
# delete dependency R_method(*, dependant)
-# delete_all_by_dependant(dependant)
+# delete_by_dependant(dependant, method = :finalize)
+#
# delete dependency R_*(*, dependant)
-# delete_all
+# delete_all_by_dependant(dependant)
+#
# delete all dependency R_*(*, *)
+# delete_all
#
+# finalize the dependant connected by dependency R_method(obj, dependtant).
# finalize(obj_or_id, dependant, method = :finalize)
# finalize_dependency(obj_or_id, dependant, method = :finalize)
-# finalize the dependant connected by dependency R_method(obj, dependtant).
-# finalize_all_dependency(obj_or_id, dependant)
+#
# finalize all dependants connected by dependency R_*(obj, dependtant).
-# finalize_by_dependant(dependant, method = :finalize)
+# finalize_all_dependency(obj_or_id, dependant)
+#
# finalize the dependant connected by dependency R_method(*, dependtant).
-# finalize_all_by_dependant(dependant)
+# finalize_by_dependant(dependant, method = :finalize)
+#
# finalize all dependants connected by dependency R_*(*, dependant).
-# finalize_all
+# finalize_all_by_dependant(dependant)
+#
# finalize all dependency registered to the Finalizer.
+# finalize_all
#
-# safe{..}
# stop invoking Finalizer on GC.
+# safe{..}
#
module Finalizer