summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--ChangeLog4
-rw-r--r--lib/e2mmap.rb16
2 files changed, 14 insertions, 6 deletions
diff --git a/ChangeLog b/ChangeLog
index b138c26..0a1fca9 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+Mon May 20 22:00:31 2013 Zachary Scott <zachary@zacharyscott.net>
+
+ * lib/e2mmap.rb: Format of E2MM documentation
+
Mon May 20 21:41:15 2013 Zachary Scott <zachary@zacharyscott.net>
* ext/extmk.rb: nodoc this file
diff --git a/lib/e2mmap.rb b/lib/e2mmap.rb
index 18a7ca0..a477d14 100644
--- a/lib/e2mmap.rb
+++ b/lib/e2mmap.rb
@@ -1,13 +1,17 @@
#
+#--
# e2mmap.rb - for ruby 1.1
# $Release Version: 2.0$
# $Revision: 1.10 $
# by Keiju ISHITSUKA
#
-# --
-# Usage:
+#++
#
-# U1)
+# Helper module for easily defining exceptions with predefined messages.
+#
+# == Usage
+#
+# 1.
# class Foo
# extend Exception2MessageMapper
# def_e2message ExistingExceptionClass, "message..."
@@ -15,7 +19,7 @@
# ...
# end
#
-# U2)
+# 2.
# module Error
# extend Exception2MessageMapper
# def_e2meggage ExistingExceptionClass, "message..."
@@ -30,7 +34,7 @@
# foo = Foo.new
# foo.Fail ....
#
-# U3)
+# 3.
# module Error
# extend Exception2MessageMapper
# def_e2message ExistingExceptionClass, "message..."
@@ -50,7 +54,7 @@
module Exception2MessageMapper
@RCS_ID='-$Id: e2mmap.rb,v 1.10 1999/02/17 12:33:17 keiju Exp keiju $-'
- E2MM = Exception2MessageMapper
+ E2MM = Exception2MessageMapper # :nodoc:
def E2MM.extend_object(cl)
super