[前][次][番号順一覧][スレッド一覧]

ruby-changes:30006

From: ktsj <ko1@a...>
Date: Fri, 19 Jul 2013 13:40:17 +0900 (JST)
Subject: [ruby-changes:30006] ktsj:r42058 (trunk): * dir.c: [DOC] add docs for :encoding option.

ktsj	2013-07-19 13:40:07 +0900 (Fri, 19 Jul 2013)

  New Revision: 42058

  http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=42058

  Log:
    * dir.c: [DOC] add docs for :encoding option.

  Modified files:
    trunk/dir.c

Index: dir.c
===================================================================
--- dir.c	(revision 42057)
+++ dir.c	(revision 42058)
@@ -416,8 +416,12 @@ dir_s_alloc(VALUE klass) https://github.com/ruby/ruby/blob/trunk/dir.c#L416
 /*
  *  call-seq:
  *     Dir.new( string ) -> aDir
+ *     Dir.new( string, encoding: enc ) -> aDir
  *
  *  Returns a new directory object for the named directory.
+ *
+ *  The optional <i>enc</i> argument specifies the encoding of the directory.
+ *  If not specified, the filesystem encoding is used.
  */
 static VALUE
 dir_initialize(int argc, VALUE *argv, VALUE dir)
@@ -469,7 +473,12 @@ dir_initialize(int argc, VALUE *argv, VA https://github.com/ruby/ruby/blob/trunk/dir.c#L473
 /*
  *  call-seq:
  *     Dir.open( string ) -> aDir
+ *     Dir.open( string, encoding: enc ) -> aDir
  *     Dir.open( string ) {| aDir | block } -> anObject
+ *     Dir.open( string, encoding: enc ) {| aDir | block } -> anObject
+ *
+ *  The optional <i>enc</i> 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
@@ -1900,8 +1909,10 @@ dir_open_dir(int argc, VALUE *argv) https://github.com/ruby/ruby/blob/trunk/dir.c#L1909
 
 /*
  *  call-seq:
- *     Dir.foreach( dirname ) {| filename | block }  -> nil
- *     Dir.foreach( dirname )                        -> an_enumerator
+ *     Dir.foreach( dirname ) {| filename | block }                 -> nil
+ *     Dir.foreach( dirname, encoding: enc ) {| filename | block }  -> nil
+ *     Dir.foreach( dirname )                                       -> an_enumerator
+ *     Dir.foreach( dirname, encoding: enc )                        -> 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.
@@ -1931,12 +1942,16 @@ dir_foreach(int argc, VALUE *argv, VALUE https://github.com/ruby/ruby/blob/trunk/dir.c#L1942
 
 /*
  *  call-seq:
- *     Dir.entries( dirname ) -> array
+ *     Dir.entries( dirname )                -> array
+ *     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.
  *
+ *  The optional <i>enc</i> argument specifies the encoding of the directory.
+ *  If not specified, the filesystem encoding is used.
+ *
  *     Dir.entries("testdir")   #=> [".", "..", "config.h", "main.rb"]
  *
  */

--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]