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 --- dir.c | 66 +++++++++++++++++++++++++++++++++--------------------------------- 1 file changed, 33 insertions(+), 33 deletions(-) (limited to 'dir.c') diff --git a/dir.c b/dir.c index adefbdac55..fa7cdd03ea 100644 --- a/dir.c +++ b/dir.c @@ -428,8 +428,8 @@ dir_initialize(int argc, VALUE *argv, VALUE dir) /* * call-seq: - * Dir.open( string ) => aDir - * Dir.open( string ) {| aDir | block } => anObject + * Dir.open( string ) -> aDir + * Dir.open( string ) {| aDir | block } -> anObject * * With no block, open is a synonym for * Dir::new. If a block is present, it is passed @@ -474,7 +474,7 @@ dir_check(VALUE dir) /* * call-seq: - * dir.inspect => string + * dir.inspect -> string * * Return a string describing this Dir object. */ @@ -493,7 +493,7 @@ dir_inspect(VALUE dir) /* * call-seq: - * dir.path => string or nil + * dir.path -> string or nil * * Returns the path parameter passed to dir's constructor. * @@ -558,7 +558,7 @@ dir_path(VALUE dir) /* * call-seq: - * dir.read => string or nil + * dir.read -> string or nil * * Reads the next entry from dir and returns it as a string. * Returns nil at the end of the stream. @@ -591,8 +591,8 @@ dir_read(VALUE dir) /* * call-seq: - * dir.each { |filename| block } => dir - * dir.each => an_enumerator + * dir.each { |filename| block } -> dir + * dir.each -> an_enumerator * * Calls the block once for each entry in this directory, passing the * filename of each entry as a parameter to the block. @@ -629,8 +629,8 @@ dir_each(VALUE dir) #ifdef HAVE_TELLDIR /* * call-seq: - * dir.pos => integer - * dir.tell => integer + * dir.pos -> integer + * dir.tell -> integer * * Returns the current position in dir. See also * Dir#seek. @@ -657,7 +657,7 @@ dir_tell(VALUE dir) #ifdef HAVE_SEEKDIR /* * call-seq: - * dir.seek( integer ) => dir + * dir.seek( integer ) -> dir * * Seeks to a particular location in dir. integer * must be a value returned by Dir#tell. @@ -685,7 +685,7 @@ dir_seek(VALUE dir, VALUE pos) /* * call-seq: - * dir.pos( integer ) => integer + * dir.pos( integer ) -> integer * * Synonym for Dir#seek, but returns the position * parameter. @@ -706,7 +706,7 @@ dir_set_pos(VALUE dir, VALUE pos) /* * call-seq: - * dir.rewind => dir + * dir.rewind -> dir * * Repositions dir to the first entry. * @@ -730,7 +730,7 @@ dir_rewind(VALUE dir) /* * call-seq: - * dir.close => nil + * dir.close -> nil * * Closes the directory stream. Any further attempts to access * dir will raise an IOError. @@ -791,8 +791,8 @@ chdir_restore(struct chdir_data *args) /* * call-seq: - * Dir.chdir( [ string] ) => 0 - * Dir.chdir( [ string] ) {| path | block } => anObject + * Dir.chdir( [ string] ) -> 0 + * Dir.chdir( [ string] ) {| path | block } -> anObject * * Changes the current working directory of the process to the given * string. When called without an argument, changes the directory to @@ -882,8 +882,8 @@ rb_dir_getwd(void) /* * call-seq: - * Dir.getwd => string - * Dir.pwd => string + * Dir.getwd -> string + * Dir.pwd -> string * * Returns the path to the current working directory of this process as * a string. @@ -913,7 +913,7 @@ check_dirname(volatile VALUE *dir) #if defined(HAVE_CHROOT) /* * call-seq: - * Dir.chroot( string ) => 0 + * Dir.chroot( string ) -> 0 * * Changes this process's idea of the file system root. Only a * privileged process may make this call. Not available on all @@ -937,7 +937,7 @@ dir_s_chroot(VALUE dir, VALUE path) /* * call-seq: - * Dir.mkdir( string [, integer] ) => 0 + * Dir.mkdir( string [, integer] ) -> 0 * * Makes a new directory named by string, with permissions * specified by the optional parameter anInteger. The @@ -971,9 +971,9 @@ dir_s_mkdir(int argc, VALUE *argv, VALUE obj) /* * call-seq: - * Dir.delete( string ) => 0 - * Dir.rmdir( string ) => 0 - * Dir.unlink( string ) => 0 + * Dir.delete( string ) -> 0 + * Dir.rmdir( string ) -> 0 + * Dir.unlink( string ) -> 0 * * Deletes the named directory. Raises a subclass of * SystemCallError if the directory isn't empty. @@ -1702,8 +1702,8 @@ dir_globs(long argc, VALUE *argv, int flags) /* * call-seq: - * Dir[ array ] => array - * Dir[ string [, string ...] ] => array + * Dir[ array ] -> array + * Dir[ string [, string ...] ] -> array * * Equivalent to calling * Dir.glob(array,0) and @@ -1721,8 +1721,8 @@ dir_s_aref(int argc, VALUE *argv, VALUE obj) /* * call-seq: - * Dir.glob( pattern, [flags] ) => array - * Dir.glob( pattern, [flags] ) {| filename | block } => nil + * Dir.glob( pattern, [flags] ) -> array + * Dir.glob( pattern, [flags] ) {| filename | block } -> nil * * Returns the filenames found by expanding pattern which is * an +Array+ of the patterns or the pattern +String+, either as an @@ -1822,8 +1822,8 @@ dir_open_dir(int argc, VALUE *argv) /* * call-seq: - * Dir.foreach( dirname ) {| filename | block } => nil - * Dir.foreach( dirname ) => an_enumerator + * Dir.foreach( dirname ) {| filename | block } -> nil + * Dir.foreach( dirname ) -> an_enumerator * * Calls the block once for each entry in the named directory, passing * the filename of each entry as a parameter to the block. @@ -1853,7 +1853,7 @@ dir_foreach(int argc, VALUE *argv, VALUE io) /* * call-seq: - * Dir.entries( dirname ) => array + * Dir.entries( dirname ) -> array * * Returns an array containing all of the filenames in the given * directory. Will raise a SystemCallError if the named @@ -1873,8 +1873,8 @@ dir_entries(int argc, VALUE *argv, VALUE io) /* * call-seq: - * File.fnmatch( pattern, path, [flags] ) => (true or false) - * File.fnmatch?( pattern, path, [flags] ) => (true or false) + * File.fnmatch( pattern, path, [flags] ) -> (true or false) + * File.fnmatch?( pattern, path, [flags] ) -> (true or false) * * Returns true if path matches against pattern The * pattern is not a regular expression; instead it follows rules @@ -1978,8 +1978,8 @@ VALUE rb_home_dir(const char *user, VALUE result); /* * call-seq: - * Dir.home() => "/home/me" - * Dir.home("root") => "/root" + * Dir.home() -> "/home/me" + * Dir.home("root") -> "/root" * * Returns the home directory of the current user or the named user * if given. -- cgit v1.2.3