summaryrefslogtreecommitdiffstats
path: root/lib/mutex_m.rb
diff options
context:
space:
mode:
authordrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2006-08-04 22:00:31 +0000
committerdrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2006-08-04 22:00:31 +0000
commit143f8a86a46b7ec38ad5382b8fe00e80785c1212 (patch)
tree3ebfb81d7fdc03904604b2c7148180d7c6b02cec /lib/mutex_m.rb
parentaf5d40cde2072fbe74e2d5017cc9fa147c0b7d24 (diff)
downloadruby-143f8a86a46b7ec38ad5382b8fe00e80785c1212.tar.gz
ruby-143f8a86a46b7ec38ad5382b8fe00e80785c1212.tar.xz
ruby-143f8a86a46b7ec38ad5382b8fe00e80785c1212.zip
Merge RDoc changes from HEAD.
git-svn-id: http://svn.ruby-lang.org/repos/ruby/branches/ruby_1_8@10679 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/mutex_m.rb')
-rw-r--r--lib/mutex_m.rb34
1 files changed, 19 insertions, 15 deletions
diff --git a/lib/mutex_m.rb b/lib/mutex_m.rb
index 0192d83be..8e0d42bc8 100644
--- a/lib/mutex_m.rb
+++ b/lib/mutex_m.rb
@@ -1,4 +1,4 @@
-#
+#--
# mutex_m.rb -
# $Release Version: 3.0$
# $Revision: 1.7 $
@@ -7,22 +7,26 @@
# by Keiju ISHITSUKA(keiju@ishitsuka.com)
# modified by matz
# patched by akira yamada
+#++
+#
+# == Usage
+#
+# Extend an object and use it like a Mutex object:
+#
+# require "mutex_m.rb"
+# obj = Object.new
+# obj.extend Mutex_m
+# # ...
#
-# --
-# Usage:
-# require "mutex_m.rb"
-# obj = Object.new
-# obj.extend Mutex_m
-# ...
-# extended object can be handled like Mutex
-# or
-# class Foo
-# include Mutex_m
-# ...
-# end
-# obj = Foo.new
-# this obj can be handled like Mutex
+# Or, include Mutex_m in a class to have its instances behave like a Mutex
+# object:
#
+# class Foo
+# include Mutex_m
+# # ...
+# end
+#
+# obj = Foo.new
module Mutex_m
def Mutex_m.define_aliases(cl)