From d3e42dbbe34c3ddb4c627f7e146e587d6faa2d18 Mon Sep 17 00:00:00 2001 From: nobu Date: Thu, 7 May 2009 04:58:54 +0000 Subject: [PATCH] * range.c (range_eql): fixed rdoc. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@23356 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- ChangeLog | 4 ++++ range.c | 72 +++++++++++++++++++++++++++---------------------------- 2 files changed, 40 insertions(+), 36 deletions(-) diff --git a/ChangeLog b/ChangeLog index 1f7ca0c6d5..6ad8d9706d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +Thu May 7 13:58:52 2009 Nobuyoshi Nakada + + * range.c (range_eql): fixed rdoc. + Thu May 7 01:59:35 2009 Tanaka Akira * util.c: suppress strict-aliasing warning with gcc-4.4.0 -O2 to fix diff --git a/range.c b/range.c index 662dc5194c..5653458774 100644 --- a/range.c +++ b/range.c @@ -41,7 +41,7 @@ range_init(range, beg, end, exclude_end) args[0] = beg; args[1] = end; - + if (!FIXNUM_P(beg) || !FIXNUM_P(end)) { VALUE v; @@ -68,7 +68,7 @@ rb_range_new(beg, end, exclude_end) /* * call-seq: * Range.new(start, end, exclusive=false) => range - * + * * Constructs a range using the given start and end. If the third * parameter is omitted or is false, the range will include * the end object; otherwise, it will be excluded. @@ -81,7 +81,7 @@ range_initialize(argc, argv, range) VALUE range; { VALUE beg, end, flags; - + rb_scan_args(argc, argv, "21", &beg, &end, &flags); /* Ranges are immutable, so that they should be initialized only once. */ if (rb_ivar_defined(range, id_beg)) { @@ -95,7 +95,7 @@ range_initialize(argc, argv, range) /* * call-seq: * rng.exclude_end? => true or false - * + * * Returns true if rng excludes its end value. */ @@ -110,15 +110,15 @@ range_exclude_end_p(range) /* * call-seq: * rng == obj => true or false - * + * * Returns true only if obj is a Range, has equivalent * beginning and end items (by comparing them with ==), and has * the same #exclude_end? setting as rng. - * + * * (0..2) == (0..2) #=> true * (0..2) == Range.new(0,2) #=> true * (0..2) == (0...2) #=> false - * + * */ static VALUE @@ -168,15 +168,15 @@ r_le(a, b) /* * call-seq: * rng.eql?(obj) => true or false - * + * * Returns true only if obj is a Range, has equivalent * beginning and end items (by comparing them with #eql?), and has the same * #exclude_end? setting as rng. - * - * (0..2) == (0..2) #=> true - * (0..2) == Range.new(0,2) #=> true - * (0..2) == (0...2) #=> false - * + * + * (0..2).eql?(0..2) #=> true + * (0..2).eql?(Range.new(0,2)) #=> true + * (0..2).eql?(0...2) #=> false + * */ static VALUE @@ -278,19 +278,19 @@ extern int ruby_float_step _((VALUE from, VALUE to, VALUE step, int excl)); /* * call-seq: * rng.step(n=1) {| obj | block } => rng - * + * * Iterates over rng, passing each nth element to the block. If * the range contains numbers, n is added for each iteration. Otherwise * step invokes succ to iterate through range * elements. The following code uses class Xs, which is defined * in the class-level documentation. - * + * * range = Xs.new(1)..Xs.new(10) * range.step(2) {|x| puts x} * range.step(3) {|x| puts x} - * + * * produces: - * + * * 1 x * 3 xxx * 5 xxxxx @@ -337,7 +337,7 @@ range_step(argc, argv, range) if (!EXCL(range)) end += 1; - i = FIX2LONG(b); + i = FIX2LONG(b); while (i < end) { rb_yield(LONG2NUM(i)); if (i + unit < i) break; @@ -407,18 +407,18 @@ each_i(v, arg) /* * call-seq: * rng.each {| i | block } => rng - * + * * Iterates over the elements rng, passing each in turn to the * block. You can only iterate if the start object of the range * supports the +succ+ method (which means that you can't iterate over * ranges of +Float+ objects). - * + * * (10..15).each do |n| * print n, ' ' * end - * + * * produces: - * + * * 10 11 12 13 14 15 */ @@ -464,7 +464,7 @@ range_each(range) * call-seq: * rng.first => obj * rng.begin => obj - * + * * Returns the first object in rng. */ @@ -480,9 +480,9 @@ range_first(range) * call-seq: * rng.end => obj * rng.last => obj - * + * * Returns the object that defines the end of rng. - * + * * (1..10).end #=> 10 * (1...10).end #=> 10 */ @@ -561,7 +561,7 @@ range_to_s(range) * call-seq: * rng.inspect => string * - * Convert this range object to a printable form (using + * Convert this range object to a printable form (using * inspect to convert the start and end * objects). */ @@ -588,20 +588,20 @@ range_inspect(range) * rng === obj => true or false * rng.member?(val) => true or false * rng.include?(val) => true or false - * + * * Returns true if obj is an element of * rng, false otherwise. Conveniently, * === is the comparison operator used by * case statements. - * + * * case 79 * when 1..50 then print "low\n" * when 51..75 then print "medium\n" * when 76..100 then print "high\n" * end - * + * * produces: - * + * * high */ @@ -633,17 +633,17 @@ range_include(range, val) * run from the start to the end inclusively. Those created using * ... exclude the end value. When used as an iterator, * ranges return each value in the sequence. - * + * * (-1..-5).to_a #=> [] * (-5..-1).to_a #=> [-5, -4, -3, -2, -1] * ('a'..'e').to_a #=> ["a", "b", "c", "d", "e"] * ('a'...'e').to_a #=> ["a", "b", "c", "d"] - * + * * Ranges can be constructed using objects of any type, as long as the * objects can be compared using their <=> operator and * they support the succ method to return the next object * in sequence. - * + * * class Xs # represent a string of 'x's * include Comparable * attr :length @@ -663,18 +663,18 @@ range_include(range, val) * 'x' * @length * end * end - * + * * r = Xs.new(3)..Xs.new(6) #=> xxx..xxxxxx * r.to_a #=> [xxx, xxxx, xxxxx, xxxxxx] * r.member?(Xs.new(5)) #=> true - * + * * In the previous code example, class Xs includes the * Comparable module. This is because * Enumerable#member? checks for equality using * ==. Including Comparable ensures that the * == method is defined in terms of the <=> * method implemented in Xs. - * + * */ void