From b416c661e80b917fd316c7d758d1b60c0a638991 Mon Sep 17 00:00:00 2001
From: zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Mon, 20 May 2013 13:01:24 +0000
Subject: * lib/e2mmap.rb: Format of E2MM documentation

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@40856 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 lib/e2mmap.rb | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

(limited to 'lib')

diff --git a/lib/e2mmap.rb b/lib/e2mmap.rb
index 18a7ca003d..a477d14762 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
-- 
cgit v1.2.3