Skip to content

Commit 89056f4

Browse files
committed
[DOC] Stop documentation for internals
Stop documentation for undocumented private constants and private class methods. And align private method definition styles. Also `Socket.tcp_with_fast_fallback` looks private as well as `Socket.tcp_without_fast_fallback`.
1 parent 8c95c9d commit 89056f4

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

ext/socket/lib/socket.rb

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -599,6 +599,7 @@ def accept_nonblock(exception: true)
599599
__accept_nonblock(exception)
600600
end
601601

602+
# :stopdoc:
602603
RESOLUTION_DELAY = 0.05
603604
private_constant :RESOLUTION_DELAY
604605

@@ -616,6 +617,7 @@ def accept_nonblock(exception: true)
616617

617618
IPV6_ADDRESS_FORMAT = /\A(?i:(?:(?:[0-9A-F]{1,4}:){7}(?:[0-9A-F]{1,4}|:)|(?:[0-9A-F]{1,4}:){6}(?:[0-9A-F]{1,4}|:(?:[0-9A-F]{1,4}:){1,5}[0-9A-F]{1,4}|:)|(?:[0-9A-F]{1,4}:){5}(?:(?::[0-9A-F]{1,4}){1,2}|:(?:[0-9A-F]{1,4}:){1,4}[0-9A-F]{1,4}|:)|(?:[0-9A-F]{1,4}:){4}(?:(?::[0-9A-F]{1,4}){1,3}|:(?:[0-9A-F]{1,4}:){1,3}[0-9A-F]{1,4}|:)|(?:[0-9A-F]{1,4}:){3}(?:(?::[0-9A-F]{1,4}){1,4}|:(?:[0-9A-F]{1,4}:){1,2}[0-9A-F]{1,4}|:)|(?:[0-9A-F]{1,4}:){2}(?:(?::[0-9A-F]{1,4}){1,5}|:(?:[0-9A-F]{1,4}:)[0-9A-F]{1,4}|:)|(?:[0-9A-F]{1,4}:){1}(?:(?::[0-9A-F]{1,4}){1,6}|:(?:[0-9A-F]{1,4}:){0,5}[0-9A-F]{1,4}|:)|(?:::(?:[0-9A-F]{1,4}:){0,7}[0-9A-F]{1,4}|::)))(?:%.+)?\z/
618619
private_constant :IPV6_ADDRESS_FORMAT
620+
# :startdoc:
619621

620622
# :call-seq:
621623
# Socket.tcp(host, port, local_host=nil, local_port=nil, [opts]) {|socket| ... }
@@ -680,6 +682,7 @@ def self.tcp(host, port, local_host = nil, local_port = nil, connect_timeout: ni
680682
end
681683
end
682684

685+
# :stopdoc:
683686
def self.tcp_with_fast_fallback(host, port, local_host = nil, local_port = nil, connect_timeout: nil, resolv_timeout: nil, open_timeout: nil)
684687
if local_host || local_port
685688
local_addrinfos = Addrinfo.getaddrinfo(local_host, local_port, nil, :STREAM, timeout: resolv_timeout)
@@ -923,6 +926,7 @@ def self.tcp_with_fast_fallback(host, port, local_host = nil, local_port = nil,
923926
connecting_socket.close
924927
end
925928
end
929+
private_class_method :tcp_with_fast_fallback
926930

927931
def self.tcp_without_fast_fallback(host, port, local_host, local_port, connect_timeout:, resolv_timeout:, open_timeout:)
928932
last_error = nil
@@ -1106,7 +1110,6 @@ def any_unresolved_family?
11061110
end
11071111
private_constant :HostnameResolutionStore
11081112

1109-
# :stopdoc:
11101113
def self.ip_sockets_port0(ai_list, reuseaddr)
11111114
sockets = []
11121115
begin
@@ -1139,9 +1142,7 @@ def self.ip_sockets_port0(ai_list, reuseaddr)
11391142
end
11401143
sockets
11411144
end
1142-
class << self
1143-
private :ip_sockets_port0
1144-
end
1145+
private_class_method :ip_sockets_port0
11451146

11461147
def self.tcp_server_sockets_port0(host)
11471148
ai_list = Addrinfo.getaddrinfo(host, 0, nil, :STREAM, nil, Socket::AI_PASSIVE)
@@ -1569,6 +1570,7 @@ def self.unix_server_socket(path)
15691570
end
15701571
end
15711572

1573+
# :stopdoc:
15721574
if RUBY_PLATFORM.include?("linux")
15731575
def self.unix_socket_abstract_name?(path)
15741576
path.empty? or path.start_with?("\0")
@@ -1579,6 +1581,7 @@ def self.unix_socket_abstract_name?(path)
15791581
end
15801582
end
15811583
private_class_method :unix_socket_abstract_name?
1584+
# :startdoc:
15821585

15831586
# creates a UNIX socket server on _path_.
15841587
# It calls the block for each socket accepted.

0 commit comments

Comments
 (0)