[前][次][番号順一覧][スレッド一覧]

ruby-changes:29939

From: zzak <ko1@a...>
Date: Tue, 16 Jul 2013 08:16:37 +0900 (JST)
Subject: [ruby-changes:29939] zzak:r41991 (trunk): * ext/bigdecimal/lib/bigdecimal/util.rb: [DOC] document top-level

zzak	2013-07-16 08:16:26 +0900 (Tue, 16 Jul 2013)

  New Revision: 41991

  http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=41991

  Log:
    * ext/bigdecimal/lib/bigdecimal/util.rb: [DOC] document top-level
      classes from BigDecimal utils native extensions

  Modified files:
    trunk/ChangeLog
    trunk/ext/bigdecimal/lib/bigdecimal/util.rb

Index: ChangeLog
===================================================================
--- ChangeLog	(revision 41990)
+++ ChangeLog	(revision 41991)
@@ -1,3 +1,8 @@ https://github.com/ruby/ruby/blob/trunk/ChangeLog#L1
+Tue Jul 16 08:15:22 2013  Zachary Scott  <e@z...>
+
+	* ext/bigdecimal/lib/bigdecimal/util.rb: [DOC] document top-level
+	  classes from BigDecimal utils native extensions
+
 Tue Jul 16 03:23:03 2013  Zachary Scott  <e@z...>
 
 	* numeric.c: [DOC] improve rdoc formatting for parameters and links
Index: ext/bigdecimal/lib/bigdecimal/util.rb
===================================================================
--- ext/bigdecimal/lib/bigdecimal/util.rb	(revision 41990)
+++ ext/bigdecimal/lib/bigdecimal/util.rb	(revision 41991)
@@ -1,3 +1,7 @@ https://github.com/ruby/ruby/blob/trunk/ext/bigdecimal/lib/bigdecimal/util.rb#L1
+# 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 https://github.com/ruby/ruby/blob/trunk/ext/bigdecimal/lib/bigdecimal/util.rb#L19
   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 https://github.com/ruby/ruby/blob/trunk/ext/bigdecimal/lib/bigdecimal/util.rb#L40
   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 https://github.com/ruby/ruby/blob/trunk/ext/bigdecimal/lib/bigdecimal/util.rb#L61
   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 https://github.com/ruby/ruby/blob/trunk/ext/bigdecimal/lib/bigdecimal/util.rb#L98
   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

--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]