Skip to content

Commit 6c5734d

Browse files
committed
[DOC] Suppress documentation for internals
1 parent 5636666 commit 6c5734d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

lib/net/protocol.rb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ def ssl_socket_connect(s, timeout)
5757
end
5858

5959

60+
# :stopdoc:
6061
class ProtocolError < StandardError; end
6162
class ProtoSyntaxError < ProtocolError; end
6263
class ProtoFatalError < ProtocolError; end
@@ -66,6 +67,7 @@ class ProtoAuthError < ProtocolError; end
6667
class ProtoCommandError < ProtocolError; end
6768
class ProtoRetriableError < ProtocolError; end
6869
ProtocRetryError = ProtoRetriableError
70+
# :startdoc:
6971

7072
##
7173
# OpenTimeout, a subclass of Timeout::Error, is raised if a connection cannot
@@ -78,6 +80,7 @@ class OpenTimeout < Timeout::Error; end
7880
# response cannot be read within the read_timeout.
7981

8082
class ReadTimeout < Timeout::Error
83+
# :stopdoc:
8184
def initialize(io = nil)
8285
@io = io
8386
end
@@ -97,6 +100,7 @@ def message
97100
# response cannot be written within the write_timeout. Not raised on Windows.
98101

99102
class WriteTimeout < Timeout::Error
103+
# :stopdoc:
100104
def initialize(io = nil)
101105
@io = io
102106
end
@@ -484,6 +488,7 @@ def buffer_filling(buf, src)
484488
# The writer adapter class
485489
#
486490
class WriteAdapter
491+
# :stopdoc:
487492
def initialize(writer)
488493
@writer = writer
489494
end

0 commit comments

Comments
 (0)