From f3a63c31756032d9d0e6ad07f263fe0de0c97212 Mon Sep 17 00:00:00 2001
From: zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Mon, 15 Jul 2013 23:16:26 +0000
Subject: * ext/bigdecimal/lib/bigdecimal/util.rb: [DOC] document top-level  
 classes from BigDecimal utils native extensions

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@41991 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 ext/bigdecimal/lib/bigdecimal/util.rb | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'ext/bigdecimal/lib/bigdecimal/util.rb')

diff --git a/ext/bigdecimal/lib/bigdecimal/util.rb b/ext/bigdecimal/lib/bigdecimal/util.rb
index bd02ef427c..3673d88cc2 100644
--- a/ext/bigdecimal/lib/bigdecimal/util.rb
+++ b/ext/bigdecimal/lib/bigdecimal/util.rb
@@ -1,3 +1,7 @@
+# BigDecimal extends the native Integer class to provide the #to_d method.
+#
+# When you require the BigDecimal library in your application, this methodwill
+# be available on Integer objects.
 class Integer < Numeric
   # call-seq:
   #     int.to_d  -> bigdecimal
@@ -15,6 +19,10 @@ class Integer < Numeric
   end
 end
 
+# BigDecimal extends the native Float class to provide the #to_d method.
+#
+# When you require BigDecimal in your application, this method will be
+# available on Float objects.
 class Float < Numeric
   # call-seq:
   #     flt.to_d  -> bigdecimal
@@ -32,6 +40,10 @@ class Float < Numeric
   end
 end
 
+# BigDecimal extends the native String class to provide the #to_d method.
+#
+# When you require BigDecimal in your application, this method will be
+# available on String objects.
 class String
   # call-seq:
   #     string.to_d  -> bigdecimal
@@ -49,6 +61,11 @@ class String
   end
 end
 
+# BigDecimal extends the native Numeric class to provide the #to_digits and
+# #to_d methods.
+#
+# When you require BigDecimal in your application, this method will be
+# available on BigDecimal objects.
 class BigDecimal < Numeric
   # call-seq:
   #     a.to_digits -> string
@@ -81,6 +98,10 @@ class BigDecimal < Numeric
   end
 end
 
+# BigDecimal extends the native Rational class to provide the #to_d method.
+#
+# When you require BigDecimal in your application, this method will be
+# available on Rational objects.
 class Rational < Numeric
   # call-seq:
   #   r.to_d        -> bigdecimal
-- 
cgit v1.2.3