From 7729de4d91ffbf0fe8fa4f2a95b85d3406845471 Mon Sep 17 00:00:00 2001 From: marcandre Date: Mon, 17 May 2010 21:07:33 +0000 Subject: * array.c: Documentation: change => in call-seq to ->. Harmonize "#=>" in examples. [ruby-core:30206] * bignum.c: ditto * class.c: ditto * compar.c: ditto * cont.c: ditto * dir.c: ditto * encoding.c: ditto * enum.c: ditto * enumerator.c: ditto * error.c: ditto * eval.c: ditto * file.c: ditto * gc.c: ditto * io.c: ditto * load.c: ditto * marshal.c: ditto * math.c: ditto * numeric.c: ditto * object.c: ditto * pack.c: ditto * proc.c: ditto * process.c: ditto * random.c: ditto * range.c: ditto * re.c: ditto * ruby.c: ditto * signal.c: ditto * sprintf.c: ditto * string.c: ditto * struct.c: ditto * thread.c: ditto * time.c: ditto * transcode.c: ditto * variable.c: ditto * vm_eval.c: ditto * vm_method.c: ditto git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@27865 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- struct.c | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) (limited to 'struct.c') diff --git a/struct.c b/struct.c index 83c63a8b47..f0a377c211 100644 --- a/struct.c +++ b/struct.c @@ -79,7 +79,7 @@ rb_struct_s_members_m(VALUE klass) /* * call-seq: - * struct.members => array + * struct.members -> array * * Returns an array of strings representing the names of the instance * variables. @@ -294,9 +294,9 @@ rb_struct_define(const char *name, ...) /* * call-seq: - * Struct.new( [aString] [, aSym]+> ) => StructClass - * StructClass.new(arg, ...) => obj - * StructClass[arg, ...] => obj + * Struct.new( [aString] [, aSym]+> ) -> StructClass + * StructClass.new(arg, ...) -> obj + * StructClass[arg, ...] -> obj * * Creates a new class, named by aString, containing accessor * methods for the given symbols. If the name aString is @@ -441,8 +441,8 @@ rb_struct_new(VALUE klass, ...) /* * call-seq: - * struct.each {|obj| block } => struct - * struct.each => an_enumerator + * struct.each {|obj| block } -> struct + * struct.each -> an_enumerator * * Calls block once for each instance variable, passing the * value as a parameter. @@ -474,8 +474,8 @@ rb_struct_each(VALUE s) /* * call-seq: - * struct.each_pair {|sym, obj| block } => struct - * struct.each_pair => an_enumerator + * struct.each_pair {|sym, obj| block } -> struct + * struct.each_pair -> an_enumerator * * Calls block once for each instance variable, passing the name * (as a symbol) and the value as parameters. @@ -556,8 +556,8 @@ inspect_struct(VALUE s, VALUE dummy, int recur) /* * call-seq: - * struct.to_s => string - * struct.inspect => string + * struct.to_s -> string + * struct.inspect -> string * * Describe the contents of this struct in a string. */ @@ -570,8 +570,8 @@ rb_struct_inspect(VALUE s) /* * call-seq: - * struct.to_a => array - * struct.values => array + * struct.to_a -> array + * struct.values -> array * * Returns the values for this instance as an array. * @@ -624,8 +624,8 @@ rb_struct_aref_id(VALUE s, ID id) /* * call-seq: - * struct[symbol] => anObject - * struct[fixnum] => anObject + * struct[symbol] -> anObject + * struct[fixnum] -> anObject * * Attribute Reference---Returns the value of the instance variable * named by symbol, or indexed (0..length-1) by @@ -687,8 +687,8 @@ rb_struct_aset_id(VALUE s, ID id, VALUE val) /* * call-seq: - * struct[symbol] = obj => obj - * struct[fixnum] = obj => obj + * struct[symbol] = obj -> obj + * struct[fixnum] = obj -> obj * * Attribute Assignment---Assigns to the instance variable named by * symbol or fixnum the value obj and @@ -737,7 +737,7 @@ struct_entry(VALUE s, long n) /* * call-seq: - * struct.values_at(selector,... ) => an_array + * struct.values_at(selector,... ) -> an_array * * Returns an array containing the elements in * +self+ corresponding to the given selector(s). The selectors @@ -759,8 +759,8 @@ rb_struct_values_at(int argc, VALUE *argv, VALUE s) /* * call-seq: - * struct.select {|i| block } => array - * struct.select => an_enumerator + * struct.select {|i| block } -> array + * struct.select -> an_enumerator * * Invokes the block passing in successive elements from * struct, returning an array containing those elements @@ -810,7 +810,7 @@ recursive_equal(VALUE s, VALUE s2, int recur) /* * call-seq: - * struct == other_struct => true or false + * struct == other_struct -> true or false * * Equality---Returns true if other_struct is * equal to this one: they must be of the same class as generated by @@ -860,7 +860,7 @@ recursive_hash(VALUE s, VALUE dummy, int recur) /* * call-seq: - * struct.hash => fixnum + * struct.hash -> fixnum * * Return a hash value based on this struct's contents. */ @@ -889,7 +889,7 @@ recursive_eql(VALUE s, VALUE s2, int recur) /* * code-seq: - * struct.eql?(other) => true or false + * struct.eql?(other) -> true or false * * Two structures are equal if they are the same object, or if all their * fields are equal (using eql?). @@ -910,8 +910,8 @@ rb_struct_eql(VALUE s, VALUE s2) /* * call-seq: - * struct.length => fixnum - * struct.size => fixnum + * struct.length -> fixnum + * struct.size -> fixnum * * Returns the number of instance variables. * -- cgit v1.2.3