1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

* lib/fileutils.rb: slighly improved documentation (sync with 1.8)

Browse Source 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@5692 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
gsinclair 2004-02-13 12:53:42 +00:00
parent c0306157d9
commit be1de4f8db
2 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -1,3 +1,7 @@
Fri Feb 13 21:51:00 2004 Gavin Sinclair <gsinclair@soyabean.com.au>
* lib/fileutils.rb: slighly improved documentation (sync with 1.8)
Fri Feb 13 19:57:01 2004 Kouhei Sutou <kou@cozmixng.org> Fri Feb 13 19:57:01 2004 Kouhei Sutou <kou@cozmixng.org>
* test/rss/test_trackback.rb: added tests for TrackBack with RSS * test/rss/test_trackback.rb: added tests for TrackBack with RSS

23
lib/fileutils.rb
View File

@ -37,9 +37,9 @@
# touch(list, options) # touch(list, options)
# #
# The <tt>options</tt> parameter is a hash of options, taken from the list # The <tt>options</tt> parameter is a hash of options, taken from the list
# +:force+, +:noop+, +:preserve+, and +:verbose+. +:noop+ means that no changes # <tt>:force</tt>, <tt>:noop</tt>, <tt>:preserve</tt>, and <tt>:verbose</tt>.
# are made. The other two are obvious. Each method documents the options that # <tt>:noop</tt> means that no changes are made. The other two are obvious.
# it honours. # Each method documents the options that it honours.
# #
# All methods that have the concept of a "source" file or directory can take # All methods that have the concept of a "source" file or directory can take
# either one file or a list of files in that argument. See the method # either one file or a list of files in that argument. See the method
@ -56,14 +56,14 @@
# == module FileUtils::Verbose # == module FileUtils::Verbose
# #
# This module has all methods of FileUtils module, but it outputs messages # This module has all methods of FileUtils module, but it outputs messages
# before acting. This equates to passing the +:verbose+ flag to methods in # before acting. This equates to passing the <tt>:verbose</tt> flag to methods
# FileUtils. # in FileUtils.
# #
# == module FileUtils::NoWrite # == module FileUtils::NoWrite
# #
# This module has all methods of FileUtils module, but never changes # This module has all methods of FileUtils module, but never changes
# files/directories. This equates to passing the +:noop+ flag to methods in # files/directories. This equates to passing the <tt>:noop</tt> flag to methods
# FileUtils. # in FileUtils.
# #
@ -820,7 +820,7 @@ module FileUtils
# #
# This module has all methods of FileUtils module, but it outputs messages # This module has all methods of FileUtils module, but it outputs messages
# before acting. This equates to passing the +:verbose+ flag to methods in # before acting. This equates to passing the <tt>:verbose</tt> flag to methods in
# FileUtils. # FileUtils.
# #
module Verbose module Verbose
@ -848,7 +848,7 @@ module FileUtils
# #
# This module has all methods of FileUtils module, but never changes # This module has all methods of FileUtils module, but never changes
# files/directories. This equates to passing the +:noop+ flag to methods in # files/directories. This equates to passing the <tt>:noop</tt> flag to methods in
# FileUtils. # FileUtils.
# #
module NoWrite module NoWrite
@ -877,8 +877,3 @@ module FileUtils
end end
# Documentation comments:
# - Some RDoc markup used here doesn't work (namely, +file1+, +:noop+,
# +dir/file+). I consider this a bug and expect that these will be valid in
# the near future.