[ruby/net-http] [DOC] Suppress documentation for internals

https://github.com/ruby/net-http/commit/e4d80bd609

7 files changed, 117 insertions, 21 deletions

diff --git a/lib/net/http.rb b/lib/net/http.rb
index 6cacc55603..43e3349ac0 100644
--- a/lib/net/http.rb
+++ b/lib/net/http.rb
@@ -1321,6 +1321,9 @@ module Net   #:nodoc:
     # Sets the proxy password;
     # see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
     attr_writer :proxy_pass
+
+    # Sets wheter the proxy uses SSL;
+    # see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
     attr_writer :proxy_use_ssl
 
     # Returns the IP address for the connection.
@@ -1632,6 +1635,21 @@ module Net   #:nodoc:
       self
     end
 
+    # Finishes the \HTTP session:
+    #
+    #   http = Net::HTTP.new(hostname)
+    #   http.start
+    #   http.started? # => true
+    #   http.finish   # => nil
+    #   http.started? # => false
+    #
+    # Raises IOError if not in a session.
+    def finish
+      raise IOError, 'HTTP session not yet started' unless started?
+      do_finish
+    end
+
+    # :stopdoc:
     def do_start
       connect
       @started = true
@@ -1758,20 +1776,6 @@ module Net   #:nodoc:
     end
     private :on_connect
 
-    # Finishes the \HTTP session:
-    #
-    #   http = Net::HTTP.new(hostname)
-    #   http.start
-    #   http.started? # => true
-    #   http.finish   # => nil
-    #   http.started? # => false
-    #
-    # Raises IOError if not in a session.
-    def finish
-      raise IOError, 'HTTP session not yet started' unless started?
-      do_finish
-    end
-
     def do_finish
       @started = false
       @socket.close if @socket
@@ -1915,6 +1919,7 @@ module Net   #:nodoc:
     alias proxyport proxy_port      #:nodoc: obsolete
 
     private
+    # :stopdoc:
 
     def unescape(value)
       require 'cgi/escape'
@@ -2397,6 +2402,8 @@ module Net   #:nodoc:
       res
     end
 
+    # :stopdoc:
+
     IDEMPOTENT_METHODS_ = %w/GET HEAD PUT DELETE OPTIONS TRACE/ # :nodoc:
 
     def transport_request(req)
diff --git a/lib/net/http/exceptions.rb b/lib/net/http/exceptions.rb
index ceec8f7b0a..4342cfc0ef 100644
--- a/lib/net/http/exceptions.rb
+++ b/lib/net/http/exceptions.rb
@@ -3,7 +3,7 @@ module Net
   # Net::HTTP exception class.
   # You cannot use Net::HTTPExceptions directly; instead, you must use
   # its subclasses.
-  module HTTPExceptions
+  module HTTPExceptions # :nodoc:
     def initialize(msg, res)   #:nodoc:
       super msg
       @response = res
@@ -12,6 +12,7 @@ module Net
     alias data response    #:nodoc: obsolete
   end
 
+  # :stopdoc:
   class HTTPError < ProtocolError
     include HTTPExceptions
   end
diff --git a/lib/net/http/generic_request.rb b/lib/net/http/generic_request.rb
index c92004e557..d9a4c4fef0 100644
--- a/lib/net/http/generic_request.rb
+++ b/lib/net/http/generic_request.rb
@@ -264,6 +264,8 @@ class Net::HTTPGenericRequest
 
   private
 
+  # :stopdoc:
+
   class Chunker #:nodoc:
     def initialize(sock)
       @sock = sock
diff --git a/lib/net/http/header.rb b/lib/net/http/header.rb
index f6c36f1b5e..5dcdcc7d74 100644
--- a/lib/net/http/header.rb
+++ b/lib/net/http/header.rb
@@ -179,7 +179,9 @@
 # - #each_value: Passes each string field value to the block.
 #
 module Net::HTTPHeader
+  # The maximum length of HTTP header keys.
   MAX_KEY_LENGTH = 1024
+  # The maximum length of HTTP header values.
   MAX_FIELD_LENGTH = 65536
 
   def initialize_http_header(initheader) #:nodoc:
@@ -267,6 +269,7 @@ module Net::HTTPHeader
     end
   end
 
+  # :stopdoc:
   private def set_field(key, val)
     case val
     when Enumerable
@@ -294,6 +297,7 @@ module Net::HTTPHeader
       ary.push val
     end
   end
+  # :startdoc:
 
   # Returns the array field value for the given +key+,
   # or +nil+ if there is no such field;
@@ -490,7 +494,7 @@ module Net::HTTPHeader
 
   alias canonical_each each_capitalized
 
-  def capitalize(name)
+  def capitalize(name)  # :nodoc:
     name.to_s.split('-'.freeze).map {|s| s.capitalize }.join('-'.freeze)
   end
   private :capitalize
@@ -957,12 +961,12 @@ module Net::HTTPHeader
     @header['proxy-authorization'] = [basic_encode(account, password)]
   end
 
-  def basic_encode(account, password)
+  def basic_encode(account, password)   # :nodoc:
     'Basic ' + ["#{account}:#{password}"].pack('m0')
   end
   private :basic_encode
 
-# Returns whether the HTTP session is to be closed.
+  # Returns whether the HTTP session is to be closed.
   def connection_close?
     token = /(?:\A|,)\s*close\s*(?:\z|,)/i
     @header['connection']&.grep(token) {return true}
@@ -970,7 +974,7 @@ module Net::HTTPHeader
     false
   end
 
-# Returns whether the HTTP session is to be kept alive.
+  # Returns whether the HTTP session is to be kept alive.
   def connection_keep_alive?
     token = /(?:\A|,)\s*keep-alive\s*(?:\z|,)/i
     @header['connection']&.grep(token) {return true}
diff --git a/lib/net/http/requests.rb b/lib/net/http/requests.rb
index e58057adf1..939d413f91 100644
--- a/lib/net/http/requests.rb
+++ b/lib/net/http/requests.rb
@@ -29,6 +29,7 @@
 # - Net::HTTP#get: sends +GET+ request, returns response object.
 #
 class Net::HTTP::Get < Net::HTTPRequest
+  # :stopdoc:
   METHOD = 'GET'
   REQUEST_HAS_BODY  = false
   RESPONSE_HAS_BODY = true
@@ -60,6 +61,7 @@ end
 # - Net::HTTP#head: sends +HEAD+ request, returns response object.
 #
 class Net::HTTP::Head < Net::HTTPRequest
+  # :stopdoc:
   METHOD = 'HEAD'
   REQUEST_HAS_BODY = false
   RESPONSE_HAS_BODY = false
@@ -95,6 +97,7 @@ end
 # - Net::HTTP#post: sends +POST+ request, returns response object.
 #
 class Net::HTTP::Post < Net::HTTPRequest
+  # :stopdoc:
   METHOD = 'POST'
   REQUEST_HAS_BODY = true
   RESPONSE_HAS_BODY = true
@@ -130,6 +133,7 @@ end
 # - Net::HTTP#put: sends +PUT+ request, returns response object.
 #
 class Net::HTTP::Put < Net::HTTPRequest
+  # :stopdoc:
   METHOD = 'PUT'
   REQUEST_HAS_BODY = true
   RESPONSE_HAS_BODY = true
@@ -162,6 +166,7 @@ end
 # - Net::HTTP#delete: sends +DELETE+ request, returns response object.
 #
 class Net::HTTP::Delete < Net::HTTPRequest
+  # :stopdoc:
   METHOD = 'DELETE'
   REQUEST_HAS_BODY = false
   RESPONSE_HAS_BODY = true
@@ -193,6 +198,7 @@ end
 # - Net::HTTP#options: sends +OPTIONS+ request, returns response object.
 #
 class Net::HTTP::Options < Net::HTTPRequest
+  # :stopdoc:
   METHOD = 'OPTIONS'
   REQUEST_HAS_BODY = false
   RESPONSE_HAS_BODY = true
@@ -224,6 +230,7 @@ end
 # - Net::HTTP#trace: sends +TRACE+ request, returns response object.
 #
 class Net::HTTP::Trace < Net::HTTPRequest
+  # :stopdoc:
   METHOD = 'TRACE'
   REQUEST_HAS_BODY = false
   RESPONSE_HAS_BODY = true
@@ -258,6 +265,7 @@ end
 # - Net::HTTP#patch: sends +PATCH+ request, returns response object.
 #
 class Net::HTTP::Patch < Net::HTTPRequest
+  # :stopdoc:
   METHOD = 'PATCH'
   REQUEST_HAS_BODY = true
   RESPONSE_HAS_BODY = true
@@ -285,6 +293,7 @@ end
 # - Net::HTTP#propfind: sends +PROPFIND+ request, returns response object.
 #
 class Net::HTTP::Propfind < Net::HTTPRequest
+  # :stopdoc:
   METHOD = 'PROPFIND'
   REQUEST_HAS_BODY = true
   RESPONSE_HAS_BODY = true
@@ -308,6 +317,7 @@ end
 # - Net::HTTP#proppatch: sends +PROPPATCH+ request, returns response object.
 #
 class Net::HTTP::Proppatch < Net::HTTPRequest
+  # :stopdoc:
   METHOD = 'PROPPATCH'
   REQUEST_HAS_BODY = true
   RESPONSE_HAS_BODY = true
@@ -331,6 +341,7 @@ end
 # - Net::HTTP#mkcol: sends +MKCOL+ request, returns response object.
 #
 class Net::HTTP::Mkcol < Net::HTTPRequest
+  # :stopdoc:
   METHOD = 'MKCOL'
   REQUEST_HAS_BODY = true
   RESPONSE_HAS_BODY = true
@@ -354,6 +365,7 @@ end
 # - Net::HTTP#copy: sends +COPY+ request, returns response object.
 #
 class Net::HTTP::Copy < Net::HTTPRequest
+  # :stopdoc:
   METHOD = 'COPY'
   REQUEST_HAS_BODY = false
   RESPONSE_HAS_BODY = true
@@ -377,6 +389,7 @@ end
 # - Net::HTTP#move: sends +MOVE+ request, returns response object.
 #
 class Net::HTTP::Move < Net::HTTPRequest
+  # :stopdoc:
   METHOD = 'MOVE'
   REQUEST_HAS_BODY = false
   RESPONSE_HAS_BODY = true
@@ -400,6 +413,7 @@ end
 # - Net::HTTP#lock: sends +LOCK+ request, returns response object.
 #
 class Net::HTTP::Lock < Net::HTTPRequest
+  # :stopdoc:
   METHOD = 'LOCK'
   REQUEST_HAS_BODY = true
   RESPONSE_HAS_BODY = true
@@ -423,8 +437,8 @@ end
 # - Net::HTTP#unlock: sends +UNLOCK+ request, returns response object.
 #
 class Net::HTTP::Unlock < Net::HTTPRequest
+  # :stopdoc:
   METHOD = 'UNLOCK'
   REQUEST_HAS_BODY = true
   RESPONSE_HAS_BODY = true
 end
-
diff --git a/lib/net/http/response.rb b/lib/net/http/response.rb
index 40de963868..8804a99c9e 100644
--- a/lib/net/http/response.rb
+++ b/lib/net/http/response.rb
@@ -153,6 +153,7 @@ class Net::HTTPResponse
     end
 
     private
+    # :stopdoc:
 
     def read_status_line(sock)
       str = sock.readline
@@ -259,7 +260,7 @@ class Net::HTTPResponse
   # header.
   attr_accessor :ignore_eof
 
-  def inspect
+  def inspect   # :nodoc:
     "#<#{self.class} #{@code} #{@message} readbody=#{@read}>"
   end
 
diff --git a/lib/net/http/responses.rb b/lib/net/http/responses.rb
index 5e2f8ce1aa..2fa01e2c0c 100644
--- a/lib/net/http/responses.rb
+++ b/lib/net/http/responses.rb
@@ -5,6 +5,7 @@
 module Net
 
   class HTTPUnknownResponse < HTTPResponse
+    # :stopdoc:
     HAS_BODY = true
     EXCEPTION_TYPE = HTTPError                  #
   end
@@ -19,6 +20,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#1xx_informational_response].
   #
   class HTTPInformation < HTTPResponse
+    # :stopdoc:
     HAS_BODY = false
     EXCEPTION_TYPE = HTTPError                  #
   end
@@ -34,6 +36,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#2xx_success].
   #
   class HTTPSuccess < HTTPResponse
+    # :stopdoc:
     HAS_BODY = true
     EXCEPTION_TYPE = HTTPError                  #
   end
@@ -49,6 +52,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#3xx_redirection].
   #
   class HTTPRedirection < HTTPResponse
+    # :stopdoc:
     HAS_BODY = true
     EXCEPTION_TYPE = HTTPRetriableError         #
   end
@@ -63,6 +67,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#4xx_client_errors].
   #
   class HTTPClientError < HTTPResponse
+    # :stopdoc:
     HAS_BODY = true
     EXCEPTION_TYPE = HTTPClientException        #
   end
@@ -77,6 +82,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#5xx_server_errors].
   #
   class HTTPServerError < HTTPResponse
+    # :stopdoc:
     HAS_BODY = true
     EXCEPTION_TYPE = HTTPFatalError             #
   end
@@ -94,6 +100,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#100].
   #
   class HTTPContinue < HTTPInformation
+    # :stopdoc:
     HAS_BODY = false
   end
 
@@ -111,6 +118,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#101].
   #
   class HTTPSwitchProtocol < HTTPInformation
+    # :stopdoc:
     HAS_BODY = false
   end
 
@@ -127,6 +135,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#102].
   #
   class HTTPProcessing < HTTPInformation
+    # :stopdoc:
     HAS_BODY = false
   end
 
@@ -145,6 +154,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#103].
   #
   class HTTPEarlyHints < HTTPInformation
+    # :stopdoc:
     HAS_BODY = false
   end
 
@@ -162,6 +172,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#200].
   #
   class HTTPOK < HTTPSuccess
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -179,6 +190,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#201].
   #
   class HTTPCreated < HTTPSuccess
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -196,6 +208,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#202].
   #
   class HTTPAccepted < HTTPSuccess
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -215,6 +228,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#203].
   #
   class HTTPNonAuthoritativeInformation < HTTPSuccess
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -232,6 +246,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#204].
   #
   class HTTPNoContent < HTTPSuccess
+    # :stopdoc:
     HAS_BODY = false
   end
 
@@ -250,6 +265,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#205].
   #
   class HTTPResetContent < HTTPSuccess
+    # :stopdoc:
     HAS_BODY = false
   end
 
@@ -268,6 +284,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#206].
   #
   class HTTPPartialContent < HTTPSuccess
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -285,6 +302,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#207].
   #
   class HTTPMultiStatus < HTTPSuccess
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -304,6 +322,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#208].
   #
   class HTTPAlreadyReported < HTTPSuccess
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -321,6 +340,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#226].
   #
   class HTTPIMUsed < HTTPSuccess
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -338,6 +358,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#300].
   #
   class HTTPMultipleChoices < HTTPRedirection
+    # :stopdoc:
     HAS_BODY = true
   end
   HTTPMultipleChoice = HTTPMultipleChoices
@@ -356,6 +377,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#301].
   #
   class HTTPMovedPermanently < HTTPRedirection
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -373,6 +395,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#302].
   #
   class HTTPFound < HTTPRedirection
+    # :stopdoc:
     HAS_BODY = true
   end
   HTTPMovedTemporarily = HTTPFound
@@ -390,6 +413,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#303].
   #
   class HTTPSeeOther < HTTPRedirection
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -407,6 +431,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#304].
   #
   class HTTPNotModified < HTTPRedirection
+    # :stopdoc:
     HAS_BODY = false
   end
 
@@ -423,6 +448,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#305].
   #
   class HTTPUseProxy < HTTPRedirection
+    # :stopdoc:
     HAS_BODY = false
   end
 
@@ -440,6 +466,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#307].
   #
   class HTTPTemporaryRedirect < HTTPRedirection
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -456,6 +483,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#308].
   #
   class HTTPPermanentRedirect < HTTPRedirection
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -472,6 +500,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#400].
   #
   class HTTPBadRequest < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -488,6 +517,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#401].
   #
   class HTTPUnauthorized < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -504,6 +534,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#402].
   #
   class HTTPPaymentRequired < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -521,6 +552,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#403].
   #
   class HTTPForbidden < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -537,6 +569,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#404].
   #
   class HTTPNotFound < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -553,6 +586,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#405].
   #
   class HTTPMethodNotAllowed < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -570,6 +604,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#406].
   #
   class HTTPNotAcceptable < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -586,6 +621,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#407].
   #
   class HTTPProxyAuthenticationRequired < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -602,6 +638,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#408].
   #
   class HTTPRequestTimeout < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
   HTTPRequestTimeOut = HTTPRequestTimeout
@@ -619,6 +656,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#409].
   #
   class HTTPConflict < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -636,6 +674,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#410].
   #
   class HTTPGone < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -653,6 +692,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#411].
   #
   class HTTPLengthRequired < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -670,6 +710,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#412].
   #
   class HTTPPreconditionFailed < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -686,6 +727,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#413].
   #
   class HTTPPayloadTooLarge < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
   HTTPRequestEntityTooLarge = HTTPPayloadTooLarge
@@ -703,6 +745,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#414].
   #
   class HTTPURITooLong < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
   HTTPRequestURITooLong = HTTPURITooLong
@@ -721,6 +764,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#415].
   #
   class HTTPUnsupportedMediaType < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -737,6 +781,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#416].
   #
   class HTTPRangeNotSatisfiable < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
   HTTPRequestedRangeNotSatisfiable = HTTPRangeNotSatisfiable
@@ -754,6 +799,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#417].
   #
   class HTTPExpectationFailed < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -774,6 +820,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#421].
   #
   class HTTPMisdirectedRequest < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -790,6 +837,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#422].
   #
   class HTTPUnprocessableEntity < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -805,6 +853,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#423].
   #
   class HTTPLocked < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -821,6 +870,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#424].
   #
   class HTTPFailedDependency < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -840,6 +890,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#426].
   #
   class HTTPUpgradeRequired < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -856,6 +907,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#428].
   #
   class HTTPPreconditionRequired < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -872,6 +924,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429].
   #
   class HTTPTooManyRequests < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -889,6 +942,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#431].
   #
   class HTTPRequestHeaderFieldsTooLarge < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -906,6 +960,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#451].
   #
   class HTTPUnavailableForLegalReasons < HTTPClientError
+    # :stopdoc:
     HAS_BODY = true
   end
   # 444 No Response - Nginx
@@ -926,6 +981,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#500].
   #
   class HTTPInternalServerError < HTTPServerError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -943,6 +999,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#501].
   #
   class HTTPNotImplemented < HTTPServerError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -960,6 +1017,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#502].
   #
   class HTTPBadGateway < HTTPServerError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -977,6 +1035,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#503].
   #
   class HTTPServiceUnavailable < HTTPServerError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -994,6 +1053,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#504].
   #
   class HTTPGatewayTimeout < HTTPServerError
+    # :stopdoc:
     HAS_BODY = true
   end
   HTTPGatewayTimeOut = HTTPGatewayTimeout
@@ -1011,6 +1071,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#505].
   #
   class HTTPVersionNotSupported < HTTPServerError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -1027,6 +1088,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#506].
   #
   class HTTPVariantAlsoNegotiates < HTTPServerError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -1043,6 +1105,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#507].
   #
   class HTTPInsufficientStorage < HTTPServerError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -1059,6 +1122,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#508].
   #
   class HTTPLoopDetected < HTTPServerError
+    # :stopdoc:
     HAS_BODY = true
   end
   # 509 Bandwidth Limit Exceeded - Apache bw/limited extension
@@ -1076,6 +1140,7 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#510].
   #
   class HTTPNotExtended < HTTPServerError
+    # :stopdoc:
     HAS_BODY = true
   end
 
@@ -1092,12 +1157,14 @@ module Net
   # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#511].
   #
   class HTTPNetworkAuthenticationRequired < HTTPServerError
+    # :stopdoc:
     HAS_BODY = true
   end
 
 end
 
 class Net::HTTPResponse
+  # :stopdoc:
   CODE_CLASS_TO_OBJ = {
     '1' => Net::HTTPInformation,
     '2' => Net::HTTPSuccess,