summaryrefslogtreecommitdiff
path: root/lib/net
diff options
context:
space:
mode:
authorshugo <shugo@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2007-12-22 07:29:01 +0000
committershugo <shugo@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2007-12-22 07:29:01 +0000
commit3ee72c86efef9d63f49c7513cf8b11c87be5b0eb (patch)
treea04e6ad400cf3375e02a22db10a5da23ab1ead96 /lib/net
parentfa3d06c738ba0665e8e3cd472a42552fdd999720 (diff)
* lib/net/imap.rb: fixed RDoc markups.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@14476 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/net')
-rw-r--r--lib/net/imap.rb16
1 files changed, 8 insertions, 8 deletions
diff --git a/lib/net/imap.rb b/lib/net/imap.rb
index 117f740d52..540e366729 100644
--- a/lib/net/imap.rb
+++ b/lib/net/imap.rb
@@ -882,17 +882,17 @@ module Net
# Creates a new Net::IMAP object and connects it to the specified
# +host+.
#
- # +options+ is an option hash.
+ # +options+ is an option hash, each key of which is a symbol.
#
# The available options are:
#
- # :port:: port number (default value is 143 for imap, or 993 for imaps)
- # :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 +options[:ssl]+ is a hash, it's passed to
- # OpenSSL::SSL::SSLContext.build as parameters.
+ # port:: port number (default value is 143 for imap, or 993 for imaps)
+ # 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 options[:ssl] is a hash, it's passed to
+ # OpenSSL::SSL::SSLContext.build as parameters.
#
# The most common errors are:
#