mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
dir.rb: moved class rdoc from dir.c
This commit is contained in:
Nobuyoshi Nakada
parent
bb4a10208c
commit
4bd538e847
2 changed files with 76 additions and 79 deletions
79
dir.c
79
dir.c
|
|
@ -3346,85 +3346,6 @@ rb_dir_s_empty_p(VALUE obj, VALUE dirname)
|
|||
return result;
|
||||
}
|
||||
|
||||
/*
|
||||
* 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
|
||||
* directory (<code>..</code>), and the directory itself
|
||||
* (<code>.</code>).
|
||||
*
|
||||
* == What's Here
|
||||
*
|
||||
* \Class \Dir provides methods that are useful for:
|
||||
*
|
||||
* - {Reading}[#class-Dir-label-Reading]
|
||||
* - {Setting}[#class-Dir-label-Setting]
|
||||
* - {Querying}[#class-Dir-label-Querying]
|
||||
* - {Iterating}[#class-Dir-label-Iterating]
|
||||
* - {Other}[#class-Dir-label-Other]
|
||||
*
|
||||
* === Reading
|
||||
*
|
||||
* - #close:: Closes the directory stream for +self+.
|
||||
* - #pos=:: Sets the position in the directory stream for +self+.
|
||||
* - #read:: Reads and returns the next entry in the directory stream for +self+.
|
||||
* - #rewind:: Sets the position in the directory stream for +self+ to the first entry.
|
||||
* - #seek:: Sets the position in the directory stream for +self+
|
||||
* the entry at the given offset.
|
||||
*
|
||||
* === Setting
|
||||
*
|
||||
* - ::chdir:: Changes the working directory of the current process
|
||||
* to the given directory.
|
||||
* - ::chroot:: Changes the file-system root for the current process
|
||||
* to the given directory.
|
||||
*
|
||||
* === Querying
|
||||
*
|
||||
* - ::[]:: Same as ::glob without the ability to pass flags.
|
||||
* - ::children:: Returns an array of names of the children
|
||||
* (both files and directories) of the given directory,
|
||||
* but not including <tt>.</tt> or <tt>..</tt>.
|
||||
* - ::empty?:: Returns whether the given path is an empty directory.
|
||||
* - ::entries:: Returns an array of names of the children
|
||||
* (both files and directories) of the given directory,
|
||||
* including <tt>.</tt> and <tt>..</tt>.
|
||||
* - ::exist?:: Returns whether the given path is a directory.
|
||||
* - ::getwd (aliased as #pwd):: Returns the path to the current working directory.
|
||||
* - ::glob:: Returns an array of file paths matching the given pattern and flags.
|
||||
* - ::home:: Returns the home directory path for a given user or the current user.
|
||||
* - #children:: Returns an array of names of the children
|
||||
* (both files and directories) of +self+,
|
||||
* but not including <tt>.</tt> or <tt>..</tt>.
|
||||
* - #fileno:: Returns the integer file descriptor for +self+.
|
||||
* - #path (aliased as #to_path):: Returns the path used to create +self+.
|
||||
* - #tell (aliased as #pos):: Returns the integer position
|
||||
* in the directory stream for +self+.
|
||||
*
|
||||
* === Iterating
|
||||
*
|
||||
* - ::each_child:: Calls the given block with each entry in the given directory,
|
||||
* but not including <tt>.</tt> or <tt>..</tt>.
|
||||
* - ::foreach:: Calls the given block with each entryin the given directory,
|
||||
* including <tt>.</tt> and <tt>..</tt>.
|
||||
* - #each:: Calls the given block with each entry in +self+,
|
||||
* including <tt>.</tt> and <tt>..</tt>.
|
||||
* - #each_child:: Calls the given block with each entry in +self+,
|
||||
* but not including <tt>.</tt> or <tt>..</tt>.
|
||||
*
|
||||
* === Other
|
||||
*
|
||||
* - ::mkdir:: Creates a directory at the given path, with optional permissions.
|
||||
* - ::new:: Returns a new \Dir for the given path, with optional encoding.
|
||||
* - ::open:: Same as ::new, but if a block is given, yields the \Dir to the block,
|
||||
* closing it upon block exit.
|
||||
* - ::unlink (aliased as ::delete and ::rmdir):: Removes the given directory.
|
||||
* - #inspect:: Returns a string description of +self+.
|
||||
*
|
||||
*/
|
||||
void
|
||||
Init_Dir(void)
|
||||
{
|
||||
|
|
|
|||
76
dir.rb
76
dir.rb
|
|
@ -1,3 +1,79 @@
|
|||
# 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
|
||||
# directory (<code>..</code>), and the directory itself
|
||||
# (<code>.</code>).
|
||||
#
|
||||
# == What's Here
|
||||
#
|
||||
# \Class \Dir provides methods that are useful for:
|
||||
#
|
||||
# - {Reading}[#class-Dir-label-Reading]
|
||||
# - {Setting}[#class-Dir-label-Setting]
|
||||
# - {Querying}[#class-Dir-label-Querying]
|
||||
# - {Iterating}[#class-Dir-label-Iterating]
|
||||
# - {Other}[#class-Dir-label-Other]
|
||||
#
|
||||
# === Reading
|
||||
#
|
||||
# - #close:: Closes the directory stream for +self+.
|
||||
# - #pos=:: Sets the position in the directory stream for +self+.
|
||||
# - #read:: Reads and returns the next entry in the directory stream for +self+.
|
||||
# - #rewind:: Sets the position in the directory stream for +self+ to the first entry.
|
||||
# - #seek:: Sets the position in the directory stream for +self+
|
||||
# the entry at the given offset.
|
||||
#
|
||||
# === Setting
|
||||
#
|
||||
# - ::chdir:: Changes the working directory of the current process
|
||||
# to the given directory.
|
||||
# - ::chroot:: Changes the file-system root for the current process
|
||||
# to the given directory.
|
||||
#
|
||||
# === Querying
|
||||
#
|
||||
# - ::[]:: Same as ::glob without the ability to pass flags.
|
||||
# - ::children:: Returns an array of names of the children
|
||||
# (both files and directories) of the given directory,
|
||||
# but not including <tt>.</tt> or <tt>..</tt>.
|
||||
# - ::empty?:: Returns whether the given path is an empty directory.
|
||||
# - ::entries:: Returns an array of names of the children
|
||||
# (both files and directories) of the given directory,
|
||||
# including <tt>.</tt> and <tt>..</tt>.
|
||||
# - ::exist?:: Returns whether the given path is a directory.
|
||||
# - ::getwd (aliased as #pwd):: Returns the path to the current working directory.
|
||||
# - ::glob:: Returns an array of file paths matching the given pattern and flags.
|
||||
# - ::home:: Returns the home directory path for a given user or the current user.
|
||||
# - #children:: Returns an array of names of the children
|
||||
# (both files and directories) of +self+,
|
||||
# but not including <tt>.</tt> or <tt>..</tt>.
|
||||
# - #fileno:: Returns the integer file descriptor for +self+.
|
||||
# - #path (aliased as #to_path):: Returns the path used to create +self+.
|
||||
# - #tell (aliased as #pos):: Returns the integer position
|
||||
# in the directory stream for +self+.
|
||||
#
|
||||
# === Iterating
|
||||
#
|
||||
# - ::each_child:: Calls the given block with each entry in the given directory,
|
||||
# but not including <tt>.</tt> or <tt>..</tt>.
|
||||
# - ::foreach:: Calls the given block with each entryin the given directory,
|
||||
# including <tt>.</tt> and <tt>..</tt>.
|
||||
# - #each:: Calls the given block with each entry in +self+,
|
||||
# including <tt>.</tt> and <tt>..</tt>.
|
||||
# - #each_child:: Calls the given block with each entry in +self+,
|
||||
# but not including <tt>.</tt> or <tt>..</tt>.
|
||||
#
|
||||
# === Other
|
||||
#
|
||||
# - ::mkdir:: Creates a directory at the given path, with optional permissions.
|
||||
# - ::new:: Returns a new \Dir for the given path, with optional encoding.
|
||||
# - ::open:: Same as ::new, but if a block is given, yields the \Dir to the block,
|
||||
# closing it upon block exit.
|
||||
# - ::unlink (aliased as ::delete and ::rmdir):: Removes the given directory.
|
||||
# - #inspect:: Returns a string description of +self+.
|
||||
class Dir
|
||||
# Dir.open( string ) -> aDir
|
||||
# Dir.open( string, encoding: enc ) -> aDir
|
||||
|
|
|
|||
Loading…
Reference in a new issue