mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
[DOC] mark up literals
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57693 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
parent
95a476c859
commit
d0cf19d9ed
4 changed files with 32 additions and 30 deletions
|
@ -166,8 +166,8 @@ module OpenSSL::Buffering
|
||||||
#
|
#
|
||||||
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
||||||
# that read_nonblock should not raise an IO::Wait*able exception, but
|
# 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 the symbol +:wait_writable+ or +:wait_readable+ instead. At EOF,
|
||||||
# return nil instead of raising EOFError.
|
# it will return +nil+ instead of raising EOFError.
|
||||||
|
|
||||||
def read_nonblock(maxlen, buf=nil, exception: true)
|
def read_nonblock(maxlen, buf=nil, exception: true)
|
||||||
if maxlen == 0
|
if maxlen == 0
|
||||||
|
@ -379,8 +379,8 @@ module OpenSSL::Buffering
|
||||||
#
|
#
|
||||||
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
||||||
# that write_nonblock should not raise an IO::Wait*able exception, but
|
# 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 the symbol +:wait_writable+ or +:wait_readable+ instead. At EOF,
|
||||||
# return nil instead of raising EOFError.
|
# it will return +nil+ instead of raising EOFError.
|
||||||
|
|
||||||
def write_nonblock(s, exception: true)
|
def write_nonblock(s, exception: true)
|
||||||
flush
|
flush
|
||||||
|
|
|
@ -1600,8 +1600,9 @@ ossl_ssl_connect(VALUE self)
|
||||||
*
|
*
|
||||||
* By specifying a keyword argument _exception_ to +false+, you can indicate
|
* By specifying a keyword argument _exception_ to +false+, you can indicate
|
||||||
* that connect_nonblock should not raise an IO::WaitReadable or
|
* that connect_nonblock should not raise an IO::WaitReadable or
|
||||||
* IO::WaitWritable exception, but return the symbol :wait_readable or
|
* IO::WaitWritable exception, but return the symbol +:wait_readable+ or
|
||||||
* :wait_writable instead. At EOF, it will return nil instead of raising EOFError.
|
* +:wait_writable+ instead. At EOF, it will return +nil+ instead of raising
|
||||||
|
* EOFError.
|
||||||
*/
|
*/
|
||||||
static VALUE
|
static VALUE
|
||||||
ossl_ssl_connect_nonblock(int argc, VALUE *argv, VALUE self)
|
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
|
* By specifying a keyword argument _exception_ to +false+, you can indicate
|
||||||
* that accept_nonblock should not raise an IO::WaitReadable or
|
* that accept_nonblock should not raise an IO::WaitReadable or
|
||||||
* IO::WaitWritable exception, but return the symbol :wait_readable or
|
* IO::WaitWritable exception, but return the symbol +:wait_readable+ or
|
||||||
* :wait_writable instead. At EOF, it will return nil instead of raising EOFError.
|
* +:wait_writable+ instead. At EOF, it will return +nil+ instead of raising
|
||||||
|
* EOFError.
|
||||||
*/
|
*/
|
||||||
static VALUE
|
static VALUE
|
||||||
ossl_ssl_accept_nonblock(int argc, VALUE *argv, VALUE self)
|
ossl_ssl_accept_nonblock(int argc, VALUE *argv, VALUE self)
|
||||||
|
|
|
@ -315,8 +315,8 @@ class BasicSocket < IO
|
||||||
#
|
#
|
||||||
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
||||||
# that sendmsg_nonblock should not raise an IO::WaitWritable exception, but
|
# that sendmsg_nonblock should not raise an IO::WaitWritable exception, but
|
||||||
# return the symbol :wait_writable instead. At EOF, it will return nil instead
|
# return the symbol +:wait_writable+ instead. At EOF, it will return +nil+
|
||||||
# of raising EOFError.
|
# instead of raising EOFError.
|
||||||
def sendmsg_nonblock(mesg, flags = 0, dest_sockaddr = nil, *controls,
|
def sendmsg_nonblock(mesg, flags = 0, dest_sockaddr = nil, *controls,
|
||||||
exception: true)
|
exception: true)
|
||||||
__sendmsg_nonblock(mesg, flags, dest_sockaddr, controls, exception)
|
__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
|
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
||||||
# that recv_nonblock should not raise an IO::WaitReadable exception, but
|
# that recv_nonblock should not raise an IO::WaitReadable exception, but
|
||||||
# return the symbol :wait_readable instead. At EOF, it will return nil instead
|
# return the symbol +:wait_readable+ instead. At EOF, it will return +nil+
|
||||||
# of raising EOFError.
|
# instead of raising EOFError.
|
||||||
#
|
#
|
||||||
# === See
|
# === See
|
||||||
# * Socket#recvfrom
|
# * Socket#recvfrom
|
||||||
|
@ -439,8 +439,8 @@ class BasicSocket < IO
|
||||||
#
|
#
|
||||||
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
||||||
# that recvmsg_nonblock should not raise an IO::WaitReadable exception, but
|
# that recvmsg_nonblock should not raise an IO::WaitReadable exception, but
|
||||||
# return the symbol :wait_readable instead. At EOF, it will return nil instead
|
# return the symbol +:wait_readable+ instead. At EOF, it will return +nil+
|
||||||
# of raising EOFError.
|
# instead of raising EOFError.
|
||||||
def recvmsg_nonblock(dlen = nil, flags = 0, clen = nil,
|
def recvmsg_nonblock(dlen = nil, flags = 0, clen = nil,
|
||||||
scm_rights: false, exception: true)
|
scm_rights: false, exception: true)
|
||||||
__recvmsg_nonblock(dlen, flags, clen, scm_rights, exception)
|
__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
|
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
||||||
# that recvfrom_nonblock should not raise an IO::WaitReadable exception, but
|
# that recvfrom_nonblock should not raise an IO::WaitReadable exception, but
|
||||||
# return the symbol :wait_readable instead. At EOF, it will return nil instead
|
# return the symbol +:wait_readable+ instead. At EOF, it will return +nil+
|
||||||
# of raising EOFError.
|
# instead of raising EOFError.
|
||||||
#
|
#
|
||||||
# === See
|
# === See
|
||||||
# * Socket#recvfrom
|
# * Socket#recvfrom
|
||||||
|
@ -575,8 +575,8 @@ class Socket < BasicSocket
|
||||||
#
|
#
|
||||||
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
||||||
# that accept_nonblock should not raise an IO::WaitReadable exception, but
|
# that accept_nonblock should not raise an IO::WaitReadable exception, but
|
||||||
# return the symbol :wait_readable instead. At EOF, it will return nil instead
|
# return the symbol +:wait_readable+ instead. At EOF, it will return +nil+
|
||||||
# of raising EOFError.
|
# instead of raising EOFError.
|
||||||
#
|
#
|
||||||
# === See
|
# === See
|
||||||
# * Socket#accept
|
# * Socket#accept
|
||||||
|
@ -1195,8 +1195,8 @@ class Socket < BasicSocket
|
||||||
#
|
#
|
||||||
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
||||||
# that connect_nonblock should not raise an IO::WaitWritable exception, but
|
# that connect_nonblock should not raise an IO::WaitWritable exception, but
|
||||||
# return the symbol :wait_writable instead. At EOF, it will return nil instead
|
# return the symbol +:wait_writable+ instead. At EOF, it will return +nil+
|
||||||
# of raising EOFError.
|
# instead of raising EOFError.
|
||||||
#
|
#
|
||||||
# === See
|
# === See
|
||||||
# # Socket#connect
|
# # Socket#connect
|
||||||
|
@ -1254,8 +1254,8 @@ class UDPSocket < IPSocket
|
||||||
#
|
#
|
||||||
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
||||||
# that recvfrom_nonblock should not raise an IO::WaitReadable exception, but
|
# that recvfrom_nonblock should not raise an IO::WaitReadable exception, but
|
||||||
# return the symbol :wait_readable instead. At EOF, it will return nil instead
|
# return the symbol +:wait_readable+ instead. At EOF, it will return +nil+
|
||||||
# of raising EOFError.
|
# instead of raising EOFError.
|
||||||
#
|
#
|
||||||
# === See
|
# === See
|
||||||
# * Socket#recvfrom
|
# * Socket#recvfrom
|
||||||
|
@ -1296,8 +1296,8 @@ class TCPServer < TCPSocket
|
||||||
#
|
#
|
||||||
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
||||||
# that accept_nonblock should not raise an IO::WaitReadable exception, but
|
# that accept_nonblock should not raise an IO::WaitReadable exception, but
|
||||||
# return the symbol :wait_readable instead. At EOF, it will return nil instead
|
# return the symbol +:wait_readable+ instead. At EOF, it will return +nil+
|
||||||
# of raising EOFError.
|
# instead of raising EOFError.
|
||||||
#
|
#
|
||||||
# === See
|
# === See
|
||||||
# * TCPServer#accept
|
# * TCPServer#accept
|
||||||
|
@ -1338,8 +1338,8 @@ class UNIXServer < UNIXSocket
|
||||||
#
|
#
|
||||||
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
||||||
# that accept_nonblock should not raise an IO::WaitReadable exception, but
|
# that accept_nonblock should not raise an IO::WaitReadable exception, but
|
||||||
# return the symbol :wait_readable instead. At EOF, it will return nil instead
|
# return the symbol +:wait_readable+ instead. At EOF, it will return +nil+
|
||||||
# of raising EOFError.
|
# instead of raising EOFError.
|
||||||
#
|
#
|
||||||
# === See
|
# === See
|
||||||
# * UNIXServer#accept
|
# * UNIXServer#accept
|
||||||
|
|
|
@ -70,8 +70,8 @@ class IO
|
||||||
#
|
#
|
||||||
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
||||||
# that read_nonblock should not raise an IO::WaitReadable exception, but
|
# that read_nonblock should not raise an IO::WaitReadable exception, but
|
||||||
# return the symbol :wait_readable instead. At EOF, it will return nil instead
|
# return the symbol +:wait_readable+ instead. At EOF, it will return nil
|
||||||
# of raising EOFError.
|
# instead of raising EOFError.
|
||||||
def read_nonblock(len, buf = nil, exception: true)
|
def read_nonblock(len, buf = nil, exception: true)
|
||||||
__read_nonblock(len, buf, exception)
|
__read_nonblock(len, buf, exception)
|
||||||
end
|
end
|
||||||
|
@ -129,8 +129,8 @@ class IO
|
||||||
#
|
#
|
||||||
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
# By specifying a keyword argument _exception_ to +false+, you can indicate
|
||||||
# that write_nonblock should not raise an IO::WaitWritable exception, but
|
# that write_nonblock should not raise an IO::WaitWritable exception, but
|
||||||
# return the symbol :wait_writable instead. At EOF, it will return nil instead
|
# return the symbol +:wait_writable+ instead. At EOF, it will return nil
|
||||||
# of raising EOFError.
|
# instead of raising EOFError.
|
||||||
def write_nonblock(buf, exception: true)
|
def write_nonblock(buf, exception: true)
|
||||||
__write_nonblock(buf, exception)
|
__write_nonblock(buf, exception)
|
||||||
end
|
end
|
||||||
|
|
Loading…
Add table
Reference in a new issue