diff options
| author | gsinclair <gsinclair@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-05-09 13:42:05 +0000 |
|---|---|---|
| committer | gsinclair <gsinclair@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-05-09 13:42:05 +0000 |
| commit | d31210ccbd28a7873aa5db8f34ea87275dc62269 (patch) | |
| tree | 07eec8a8d97df96f930054d556e3a93881887cfd /lib/net/ftp.rb | |
| parent | 3dbd32a2144af170378d0b5713a828dad6c976fb (diff) | |
* lib/net/ftp.rb: improved documentation
* lib/net/imap.rb: ditto
* lib/net/pop.rb: ditto
* lib/net/smtp.rb: ditto
* lib/net/telnet.rb: ditto
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@6281 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/net/ftp.rb')
| -rw-r--r-- | lib/net/ftp.rb | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/lib/net/ftp.rb b/lib/net/ftp.rb index d236140056..2b94cde234 100644 --- a/lib/net/ftp.rb +++ b/lib/net/ftp.rb @@ -1,5 +1,5 @@ # -# = net/ftp.rb +# = net/ftp.rb - FTP Client Library # # Written by Shugo Maeda <shugo@ruby-lang.org>. # @@ -17,7 +17,7 @@ require "socket" require "monitor" -module Net # :nodoc: +module Net # :stopdoc: class FTPError < StandardError; end @@ -58,7 +58,7 @@ module Net # :nodoc: # == Major Methods # # The following are the methods most likely to be useful to users: - # - FTP::open + # - FTP.open # - #getbinaryfile # - #gettextfile # - #putbinaryfile @@ -81,7 +81,7 @@ module Net # :nodoc: # When +true+, transfers are performed in binary mode. Default: +true+. attr_accessor :binary - # When +true+, the connection is in passive mode. Default: false. + # When +true+, the connection is in passive mode. Default: +false+. attr_accessor :passive # When +true+, all traffic to and from the server is written @@ -103,7 +103,7 @@ module Net # :nodoc: attr_reader :last_response # - # A synonym for +FTP.new+, but with a mandatory host parameter. + # A synonym for <tt>FTP.new</tt>, but with a mandatory host parameter. # # If a block is given, it is passed the +FTP+ object, which will be closed # when the block finishes, or when an exception is raised. @@ -165,7 +165,7 @@ module Net # :nodoc: # Establishes an FTP connection to host, optionally overriding the default # port. If the environment variable +SOCKS_SERVER+ is set, sets up the # connection through a SOCKS proxy. Raises an exception (typically - # +Errno::ECONNREFUSED+) if the connection cannot be established. + # <tt>Errno::ECONNREFUSED</tt>) if the connection cannot be established. # def connect(host, port = FTP_PORT) if @debug_mode |