shugo	2007-12-22 15:05:14 +0900 (Sat, 22 Dec 2007)

  New Revision: 14468

  Modified files:
    trunk/ChangeLog
    trunk/lib/net/imap.rb

  Log:
    * lib/net/imap.rb (initialize): fixed documentation.


  http://svn.ruby-lang.org/cgi-bin/viewvc.cgi/trunk/lib/net/imap.rb?r1=14468&r2=14467
  http://svn.ruby-lang.org/cgi-bin/viewvc.cgi/trunk/ChangeLog?r1=14468&r2=14467

Index: ChangeLog
===================================================================
--- ChangeLog	(revision 14467)
+++ ChangeLog	(revision 14468)
@@ -1,3 +1,7 @@
+Sat Dec 22 15:03:37 2007  Shugo Maeda  <shugo@r...>
+
+	* lib/net/imap.rb (initialize): fixed documentation.
+
 Sat Dec 22 15:01:16 2007  Shugo Maeda  <shugo@r...>
 
 	* lib/net/pop.rb (enable_ssl): use OpenSSL::SSL::SSLContext.build
Index: lib/net/imap.rb
===================================================================
--- lib/net/imap.rb	(revision 14467)
+++ lib/net/imap.rb	(revision 14468)
@@ -876,28 +876,24 @@
     @@debug = false
     @@authenticators = {}
 
+    # call-seq:
+    #    Net::IMAP.new(host, options = {})
+    #
     # Creates a new Net::IMAP object and connects it to the specified
-    # port (143 by default) on the named +host+.
+    # +host+.
     #
-    # If +port_or_options+ responds to to_int, it is used as port number.
-    # Otherwise +port_or_options+ is an option hash.
+    # +options+ is an option hash.
     #
     # The available options are:
     #
     # :port:: port number (default value is 143 for imap, or 993 for imaps)
-    # :ssl:: if port_or_options[:ssl] is true, then an attempt will be made
+    # :ssl:: if +options[:ssl]+ is true, then an attempt will be made
     #        to use SSL (now TLS) to connect to the server.  For this to work
     #        OpenSSL [OSSL] and the Ruby OpenSSL [RSSL] extensions need to
     #        be installed.
-    #        if port_or_options[:ssl] is a hash, it's passed to 
+    #        if +options[:ssl]+ is a hash, it's passed to 
     #        OpenSSL::SSL::SSLContext.build as parameters.
     #
-    # +usessl+, +certs+, and +verify+ are for backward compatibility.
-    # If +usessl+ is true, then an attempt will be made to use SSL (now TLS)
-    # to connect to the server.  The +certs+ parameter indicates
-    # the path or file containing the CA cert of the server, and the
-    # +verify+ parameter is for the OpenSSL verification callback.
-    #
     # The most common errors are:
     #
     # Errno::ECONNREFUSED:: connection refused by +host+ or an intervening

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