From f3f7c40c492b791eecae4980eb817eb1aae02442 Mon Sep 17 00:00:00 2001 From: gsinclair Date: Thu, 21 Aug 2003 09:07:57 +0000 Subject: Small changes to documentation; mainly hiding things from RDoc. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@4417 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- lib/net/ftp.rb | 28 ++++++++++++++++++++++------ lib/net/http.rb | 26 ++++++++++++++++---------- lib/net/imap.rb | 6 +++--- lib/net/protocol.rb | 2 +- lib/net/smtp.rb | 2 +- 5 files changed, 43 insertions(+), 21 deletions(-) diff --git a/lib/net/ftp.rb b/lib/net/ftp.rb index 585c14b004..3baa5d02e7 100644 --- a/lib/net/ftp.rb +++ b/lib/net/ftp.rb @@ -14,13 +14,15 @@ require "socket" require "monitor" -module Net +module Net # :nodoc: + # :stopdoc: class FTPError < StandardError; end class FTPReplyError < FTPError; end - class FTPTempError < FTPError; end - class FTPPermError < FTPError; end + class FTPTempError < FTPError; end + class FTPPermError < FTPError; end class FTPProtoError < FTPError; end + # :startdoc: # # This class implements the File Transfer Protocol. If you have used a @@ -31,6 +33,8 @@ module Net # == Example # # require 'net/ftp' + # + # === Example 1 # # ftp = Net::FTP.new('ftp.netlab.co.jp') # ftp.login @@ -39,6 +43,15 @@ module Net # ftp.getbinaryfile('nif.rb-0.91.gz', 'nif.gz', 1024) # ftp.close # + # === Example 2 + # + # Net::FTP.open('ftp.netlab.co.jp') do |ftp| + # ftp.login + # files = ftp.chdir('pub/lang/ruby/contrib') + # files = ftp.list('n*') + # ftp.getbinaryfile('nif.rb-0.91.gz', 'nif.gz', 1024) + # end + # # == Major Methods # # The following are the methods most likely to be useful to users: @@ -56,10 +69,11 @@ module Net class FTP include MonitorMixin + # :stopdoc: FTP_PORT = 21 CRLF = "\r\n" - DEFAULT_BLOCKSIZE = 4096 + # :startdoc: # When +true+, transfers are performed in binary mode. Default: +true+. attr_accessor :binary @@ -123,11 +137,13 @@ module Net end end + # Obsolete def return_code $stderr.puts("warning: Net::FTP#return_code is obsolete and do nothing") return "\n" end + # Obsolete def return_code=(s) $stderr.puts("warning: Net::FTP#return_code= is obsolete and do nothing") end @@ -524,7 +540,7 @@ module Net # data in +blocksize+ chunks. # def putbinaryfile(localfile, remotefile = File.basename(localfile), - blocksize = DEFAULT_BLOCKSIZE, &block) # :yield: line/data + blocksize = DEFAULT_BLOCKSIZE, &block) # :yield: data if @resume begin rest_offset = size(remotefile) @@ -670,7 +686,7 @@ module Net return resp[3..-1].strip.to_i end - MDTM_REGEXP = /^(\d\d\d\d)(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/ + MDTM_REGEXP = /^(\d\d\d\d)(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)$/ # :nodoc: # # Returns the last modification time of the (remote) file. If +local+ is diff --git a/lib/net/http.rb b/lib/net/http.rb index 33f1863bbd..93199e09f6 100644 --- a/lib/net/http.rb +++ b/lib/net/http.rb @@ -132,6 +132,8 @@ # } # # === HTTP Response Classes +# +# TODO: write me. # # == Switching Net::HTTP versions # @@ -155,10 +157,12 @@ require 'net/protocol' require 'uri' -module Net +module Net # :nodoc: + # :stopdoc: class HTTPBadResponse < StandardError; end class HTTPHeaderSyntaxError < StandardError; end + # :startdoc: # # Class providing both short-cut class methods for retrieving entities, @@ -168,15 +172,11 @@ module Net # class HTTP < Protocol + # :stopdoc: Revision = %q$Revision$.split[1] - HTTPVersion = '1.1' - - # - # for backward compatibility - # - - @@newimpl = true + @@newimpl = true # for backward compatability + # :startdoc: # Turns on net/http 1.2 (ruby 1.8) features. # Defaults to ON in ruby 1.8. @@ -411,7 +411,7 @@ module Net # When called with a block, returns the return value of the # block; otherwise, returns self. # - def start # :yield: +http+ + def start # :yield: http raise IOError, 'HTTP session already opened' if @started if block_given? begin @@ -1319,6 +1319,8 @@ module Net end end # redefined after + # :stopdoc: + class HTTPUnknownResponse < HTTPResponse HAS_BODY = true EXCEPTION_TYPE = HTTPError @@ -1472,6 +1474,8 @@ module Net HAS_BODY = true end + # :startdoc: + class HTTPResponse # redefine @@ -1778,12 +1782,14 @@ module Net end + # :enddoc: + #-- # for backward compatibility class HTTP ProxyMod = ProxyDelta end - module NetPrivate #:nodoc: + module NetPrivate HTTPRequest = ::Net::HTTPRequest end diff --git a/lib/net/imap.rb b/lib/net/imap.rb index a84f5637ef..0463665bd5 100644 --- a/lib/net/imap.rb +++ b/lib/net/imap.rb @@ -185,7 +185,7 @@ begin rescue LoadError end -module Net +module Net # :nodoc: # Net::IMAP implements Internet Message Access Protocol (IMAP) client # functionality. The protocol is described in [IMAP]. @@ -834,8 +834,8 @@ module Net private - CRLF = "\r\n" - PORT = 143 + CRLF = "\r\n" # :nodoc: + PORT = 143 # :nodoc: @@debug = false @@authenticators = {} diff --git a/lib/net/protocol.rb b/lib/net/protocol.rb index eb1284735f..3c76955cfe 100644 --- a/lib/net/protocol.rb +++ b/lib/net/protocol.rb @@ -21,7 +21,7 @@ require 'socket' require 'timeout' -module Net +module Net # :nodoc: class Protocol #:nodoc: internal use only private diff --git a/lib/net/smtp.rb b/lib/net/smtp.rb index 7f16c7e44f..85d2452c5b 100644 --- a/lib/net/smtp.rb +++ b/lib/net/smtp.rb @@ -122,7 +122,7 @@ require 'net/protocol' require 'digest/md5' -module Net +module Net # :nodoc: # Module mixed in to all SMTP error classes module SMTPError -- cgit v1.2.3