From 61da10499f60dc15828d6a9c07e79fb4e19b992d Mon Sep 17 00:00:00 2001 From: nobu Date: Wed, 17 Jun 2015 12:11:53 +0000 Subject: bignum.c: doc of rb_cstr_to_inum * bignum.c (rb_cstr_to_inum): [DOC] add document of the function. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@50938 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- bignum.c | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'bignum.c') diff --git a/bignum.c b/bignum.c index a962dbac36..17e8f701ff 100644 --- a/bignum.c +++ b/bignum.c @@ -3940,6 +3940,22 @@ str2big_gmp( } #endif +/* + * Parse +str+ as Ruby Integer, i.e., underscores, 0d and 0b prefixes. + * + * str: pointer to the string to be parsed. + * should be NUL-terminated. + * base: base of conversion, must be 2..36, or -36..0. + * if +base+ > 0, the conversion is done according to the +base+ + * and unmatched prefix is parsed as a part of the result if + * present. + * if +base+ <= 0, the conversion is done according to the + * prefix if present, in base -base if +base+ < -1, + * or in base 10. + * badcheck: if non-zero, +ArgumentError+ is raised when +str+ is not + * valid as an Integer. if zero, Fixnum 0 is returned in + * that case. + */ VALUE rb_cstr_to_inum(const char *str, int base, int badcheck) { -- cgit v1.2.3