[DOC] mark up literals

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57693 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

ext/openssl/lib/openssl/buffering.rb

@@ -166,8 +166,8 @@ module OpenSSL::Buffering
   #
   # By specifying a keyword argument _exception_ to +false+, you can indicate
   # that read_nonblock should not raise an IO::Wait*able exception, but
-  # return the symbol :wait_writable or :wait_readable instead. At EOF, it will
-  # return nil instead of raising EOFError.
+  # return the symbol +:wait_writable+ or +:wait_readable+ instead. At EOF,
+  # it will return +nil+ instead of raising EOFError.
 
   def read_nonblock(maxlen, buf=nil, exception: true)
     if maxlen == 0
@@ -379,8 +379,8 @@ module OpenSSL::Buffering
   #
   # By specifying a keyword argument _exception_ to +false+, you can indicate
   # that write_nonblock should not raise an IO::Wait*able exception, but
-  # return the symbol :wait_writable or :wait_readable instead. At EOF, it will
-  # return nil instead of raising EOFError.
+  # return the symbol +:wait_writable+ or +:wait_readable+ instead. At EOF,
+  # it will return +nil+ instead of raising EOFError.
 
   def write_nonblock(s, exception: true)
     flush

ext/openssl/ossl_ssl.c

@@ -1600,8 +1600,9 @@ ossl_ssl_connect(VALUE self)
  *
  * By specifying a keyword argument _exception_ to +false+, you can indicate
  * that connect_nonblock should not raise an IO::WaitReadable or
- * IO::WaitWritable exception, but return the symbol :wait_readable or
- * :wait_writable instead. At EOF, it will return nil instead of raising EOFError.
+ * IO::WaitWritable exception, but return the symbol +:wait_readable+ or
+ * +:wait_writable+ instead. At EOF, it will return +nil+ instead of raising
+ * EOFError.
  */
 static VALUE
 ossl_ssl_connect_nonblock(int argc, VALUE *argv, VALUE self)
@@ -1648,8 +1649,9 @@ ossl_ssl_accept(VALUE self)
  *
  * By specifying a keyword argument _exception_ to +false+, you can indicate
  * that accept_nonblock should not raise an IO::WaitReadable or
- * IO::WaitWritable exception, but return the symbol :wait_readable or
- * :wait_writable instead. At EOF, it will return nil instead of raising EOFError.
+ * IO::WaitWritable exception, but return the symbol +:wait_readable+ or
+ * +:wait_writable+ instead. At EOF, it will return +nil+ instead of raising
+ * EOFError.
  */
 static VALUE
 ossl_ssl_accept_nonblock(int argc, VALUE *argv, VALUE self)

ext/socket/lib/socket.rb

@@ -315,8 +315,8 @@ class BasicSocket < IO
   #
   # By specifying a keyword argument _exception_ to +false+, you can indicate
   # that sendmsg_nonblock should not raise an IO::WaitWritable exception, but
-  # return the symbol :wait_writable instead. At EOF, it will return nil instead
-  # of raising EOFError.
+  # return the symbol +:wait_writable+ instead. At EOF, it will return +nil+
+  # instead of raising EOFError.
   def sendmsg_nonblock(mesg, flags = 0, dest_sockaddr = nil, *controls,
                        exception: true)
     __sendmsg_nonblock(mesg, flags, dest_sockaddr, controls, exception)
@@ -364,8 +364,8 @@ class BasicSocket < IO
   #
   # By specifying a keyword argument _exception_ to +false+, you can indicate
   # that recv_nonblock should not raise an IO::WaitReadable exception, but
-  # return the symbol :wait_readable instead. At EOF, it will return nil instead
-  # of raising EOFError.
+  # return the symbol +:wait_readable+ instead. At EOF, it will return +nil+
+  # instead of raising EOFError.
   #
   # === See
   # * Socket#recvfrom
@@ -439,8 +439,8 @@ class BasicSocket < IO
   #
   # By specifying a keyword argument _exception_ to +false+, you can indicate
   # that recvmsg_nonblock should not raise an IO::WaitReadable exception, but
-  # return the symbol :wait_readable instead. At EOF, it will return nil instead
-  # of raising EOFError.
+  # return the symbol +:wait_readable+ instead. At EOF, it will return +nil+
+  # instead of raising EOFError.
   def recvmsg_nonblock(dlen = nil, flags = 0, clen = nil,
                        scm_rights: false, exception: true)
     __recvmsg_nonblock(dlen, flags, clen, scm_rights, exception)
@@ -517,8 +517,8 @@ class Socket < BasicSocket
   #
   # By specifying a keyword argument _exception_ to +false+, you can indicate
   # that recvfrom_nonblock should not raise an IO::WaitReadable exception, but
-  # return the symbol :wait_readable instead. At EOF, it will return nil instead
-  # of raising EOFError.
+  # return the symbol +:wait_readable+ instead. At EOF, it will return +nil+
+  # instead of raising EOFError.
   #
   # === See
   # * Socket#recvfrom
@@ -575,8 +575,8 @@ class Socket < BasicSocket
   #
   # By specifying a keyword argument _exception_ to +false+, you can indicate
   # that accept_nonblock should not raise an IO::WaitReadable exception, but
-  # return the symbol :wait_readable instead. At EOF, it will return nil instead
-  # of raising EOFError.
+  # return the symbol +:wait_readable+ instead. At EOF, it will return +nil+
+  # instead of raising EOFError.
   #
   # === See
   # * Socket#accept
@@ -1195,8 +1195,8 @@ class Socket < BasicSocket
   #
   # By specifying a keyword argument _exception_ to +false+, you can indicate
   # that connect_nonblock should not raise an IO::WaitWritable exception, but
-  # return the symbol :wait_writable instead. At EOF, it will return nil instead
-  # of raising EOFError.
+  # return the symbol +:wait_writable+ instead. At EOF, it will return +nil+
+  # instead of raising EOFError.
   #
   # === See
   #  # Socket#connect
@@ -1254,8 +1254,8 @@ class UDPSocket < IPSocket
   #
   # By specifying a keyword argument _exception_ to +false+, you can indicate
   # that recvfrom_nonblock should not raise an IO::WaitReadable exception, but
-  # return the symbol :wait_readable instead. At EOF, it will return nil instead
-  # of raising EOFError.
+  # return the symbol +:wait_readable+ instead. At EOF, it will return +nil+
+  # instead of raising EOFError.
   #
   # === See
   # * Socket#recvfrom
@@ -1296,8 +1296,8 @@ class TCPServer < TCPSocket
   #
   # By specifying a keyword argument _exception_ to +false+, you can indicate
   # that accept_nonblock should not raise an IO::WaitReadable exception, but
-  # return the symbol :wait_readable instead. At EOF, it will return nil instead
-  # of raising EOFError.
+  # return the symbol +:wait_readable+ instead. At EOF, it will return +nil+
+  # instead of raising EOFError.
   #
   # === See
   # * TCPServer#accept
@@ -1338,8 +1338,8 @@ class UNIXServer < UNIXSocket
   #
   # By specifying a keyword argument _exception_ to +false+, you can indicate
   # that accept_nonblock should not raise an IO::WaitReadable exception, but
-  # return the symbol :wait_readable instead. At EOF, it will return nil instead
-  # of raising EOFError.
+  # return the symbol +:wait_readable+ instead. At EOF, it will return +nil+
+  # instead of raising EOFError.
   #
   # === See
   # * UNIXServer#accept

prelude.rb

@@ -70,8 +70,8 @@ class IO
   #
   # By specifying a keyword argument _exception_ to +false+, you can indicate
   # that read_nonblock should not raise an IO::WaitReadable exception, but
-  # return the symbol :wait_readable instead. At EOF, it will return nil instead
-  # of raising EOFError.
+  # return the symbol +:wait_readable+ instead. At EOF, it will return nil
+  # instead of raising EOFError.
   def read_nonblock(len, buf = nil, exception: true)
     __read_nonblock(len, buf, exception)
   end
@@ -129,8 +129,8 @@ class IO
   #
   # By specifying a keyword argument _exception_ to +false+, you can indicate
   # that write_nonblock should not raise an IO::WaitWritable exception, but
-  # return the symbol :wait_writable instead. At EOF, it will return nil instead
-  # of raising EOFError.
+  # return the symbol +:wait_writable+ instead. At EOF, it will return nil
+  # instead of raising EOFError.
   def write_nonblock(buf, exception: true)
     __write_nonblock(buf, exception)
   end