diff options
Diffstat (limited to 'dir.c')
| -rw-r--r-- | dir.c | 49 |
1 files changed, 22 insertions, 27 deletions
@@ -592,11 +592,10 @@ dir_initialize(int argc, VALUE *argv, VALUE dir) * The optional <i>encoding</i> keyword argument specifies the encoding of the directory. * If not specified, the filesystem encoding is used. * - * With no block, <code>open</code> is a synonym for - * <code>Dir::new</code>. If a block is present, it is passed - * <i>aDir</i> as a parameter. The directory is closed at the end of - * the block, and <code>Dir::open</code> returns the value of the - * block. + * With no block, <code>open</code> is a synonym for Dir::new. If a + * block is present, it is passed <i>aDir</i> as a parameter. The + * directory is closed at the end of the block, and Dir::open returns + * the value of the block. */ static VALUE dir_s_open(int argc, VALUE *argv, VALUE klass) @@ -870,8 +869,7 @@ dir_each_entry(VALUE dir, VALUE (*each)(VALUE, VALUE), VALUE arg, int children_o * dir.pos -> integer * dir.tell -> integer * - * Returns the current position in <em>dir</em>. See also - * <code>Dir#seek</code>. + * Returns the current position in <em>dir</em>. See also Dir#seek. * * d = Dir.new("testdir") * d.tell #=> 0 @@ -898,7 +896,7 @@ dir_tell(VALUE dir) * dir.seek( integer ) -> dir * * Seeks to a particular location in <em>dir</em>. <i>integer</i> - * must be a value returned by <code>Dir#tell</code>. + * must be a value returned by Dir#tell. * * d = Dir.new("testdir") #=> #<Dir:0x401b3c40> * d.read #=> "." @@ -926,8 +924,7 @@ dir_seek(VALUE dir, VALUE pos) * call-seq: * dir.pos = integer -> integer * - * Synonym for <code>Dir#seek</code>, but returns the position - * parameter. + * Synonym for Dir#seek, but returns the position parameter. * * d = Dir.new("testdir") #=> #<Dir:0x401b3c40> * d.read #=> "." @@ -1044,8 +1041,8 @@ chdir_restore(struct chdir_data *args) * Changes the current working directory of the process to the given * string. When called without an argument, changes the directory to * the value of the environment variable <code>HOME</code>, or - * <code>LOGDIR</code>. <code>SystemCallError</code> (probably - * <code>Errno::ENOENT</code>) if the target directory does not exist. + * <code>LOGDIR</code>. SystemCallError (probably Errno::ENOENT) if + * the target directory does not exist. * * If a block is given, it is passed the name of the new current * directory, and the block is executed with that as the current @@ -1242,11 +1239,10 @@ nogvl_mkdir(void *ptr) * * Makes a new directory named by <i>string</i>, with permissions * specified by the optional parameter <i>anInteger</i>. The - * permissions may be modified by the value of - * <code>File::umask</code>, and are ignored on NT. Raises a - * <code>SystemCallError</code> if the directory cannot be created. See - * also the discussion of permissions in the class documentation for - * <code>File</code>. + * permissions may be modified by the value of File::umask, and are + * ignored on NT. Raises a SystemCallError if the directory cannot be + * created. See also the discussion of permissions in the class + * documentation for File. * * Dir.mkdir(File.join(Dir.home, ".foo"), 0700) #=> 0 * @@ -1288,8 +1284,8 @@ nogvl_rmdir(void *ptr) * Dir.rmdir( string ) -> 0 * Dir.unlink( string ) -> 0 * - * Deletes the named directory. Raises a subclass of - * <code>SystemCallError</code> if the directory isn't empty. + * Deletes the named directory. Raises a subclass of SystemCallError + * if the directory isn't empty. */ static VALUE dir_s_rmdir(VALUE obj, VALUE dir) @@ -2974,8 +2970,8 @@ dir_collect(VALUE dir) * Dir.entries( dirname, encoding: enc ) -> array * * Returns an array containing all of the filenames in the given - * directory. Will raise a <code>SystemCallError</code> if the named - * directory doesn't exist. + * directory. Will raise a SystemCallError if the named directory + * doesn't exist. * * The optional <i>encoding</i> keyword argument specifies the encoding of the * directory. If not specified, the filesystem encoding is used. @@ -3082,8 +3078,8 @@ dir_collect_children(VALUE dir) * Dir.children( dirname, encoding: enc ) -> array * * Returns an array containing all of the filenames except for "." - * and ".." in the given directory. Will raise a - * <code>SystemCallError</code> if the named directory doesn't exist. + * and ".." in the given directory. Will raise a SystemCallError if + * the named directory doesn't exist. * * The optional <i>encoding</i> keyword argument specifies the encoding of the * directory. If not specified, the filesystem encoding is used. @@ -3390,10 +3386,9 @@ rb_dir_s_empty_p(VALUE obj, VALUE dirname) } /* - * Objects of class <code>Dir</code> are directory streams representing - * directories in the underlying file system. They provide a variety of - * ways to list directories and their contents. See also - * <code>File</code>. + * Objects of class Dir are directory streams representing + * directories in the underlying file system. They provide a variety + * of ways to list directories and their contents. See also File. * * The directory used in these examples contains the two regular files * (<code>config.h</code> and <code>main.rb</code>), the parent |