lib/rio/if/file.rb in rio-0.4.2 vs lib/rio/if/file.rb in rio-0.5.1
- old
+ new
@@ -1,8 +1,8 @@
#--
-# ===============================================================================
-# Copyright (c) 2005,2006,2007,2008 Christopher Kleckner
+# ===========================================================================
+# Copyright (c) 2005-2012 Christopher Kleckner
# All rights reserved
#
# This file is part of the Rio library for ruby.
#
# Rio is free software; you can redistribute it and/or modify
@@ -16,35 +16,22 @@
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Rio; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-# ===============================================================================
+# ===========================================================================
#++
#
-# To create the documentation for Rio run the command
-# ruby build_doc.rb
-# from the distribution directory.
-#
-# Suggested Reading
-# * RIO::Doc::SYNOPSIS
-# * RIO::Doc::INTRO
-# * RIO::Doc::HOWTO
-# * RIO::Doc::EXAMPLES
-# * RIO::Rio
-#
-
-
module RIO
module IF
module File
# Calls FileUtils#rm
#
# Deletes the referenced file, returning the Rio. Raises an exception on any error.
#
- # See also IF::Grande#delete, IF::Grande#delete!, IF::Dir#rmdir.
+ # See also {#delete}[rdoc-ref:IF::Grande#delete], {#delete!}[rdoc-ref:IF::Grande#delete!], {#rmdir}[rdoc-ref:IF::Dir#rmdir].
def rm() target.rm(); self end
# Calls FileUtils#touch
#
@@ -63,19 +50,19 @@
# f.size #=> 10
# f.truncate(5)
# f.size() #=> 5
#
# If called with no arguments, truncates the Rio at the
- # value returned by IF::FileOrDir#pos().
+ # value returned by {#pos}[rdoc-ref:IF::FileOrDir#pos]().
# f.read(2)
# f.truncate.size #=> 2
# f.contents #=> "12"
#
# Returns the Rio
#
def truncate(sz=pos()) target.truncate(sz); self end
- # Calls IF::File#truncate(0)
+ # Calls {#truncate}[rdoc-ref:IF::File#truncate](0)
#
def clear() target.clear(); self end
end
end