[DOC] Suppress documentation for internals

Author: nobu

lib/net/http.rb

@@ -1321,6 +1321,9 @@ def response_body_encoding=(value)
     # 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 @@ def start  # :yield: http
       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 @@ def on_connect
     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 @@ def proxy_pass
     alias proxyport proxy_port      #:nodoc: obsolete
 
     private
+    # :stopdoc:
 
     def unescape(value)
       require 'cgi/escape'
@@ -2397,6 +2402,8 @@ def send_entity(path, data, initheader, dest, type, &block)
       res
     end
 
+    # :stopdoc:
+
     IDEMPOTENT_METHODS_ = %w/GET HEAD PUT DELETE OPTIONS TRACE/ # :nodoc:
 
     def transport_request(req)

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 @@ def initialize(msg, res)   #:nodoc:
     alias data response    #:nodoc: obsolete
   end
 
+  # :stopdoc:
   class HTTPError < ProtocolError
     include HTTPExceptions
   end

lib/net/http/generic_request.rb

@@ -264,6 +264,8 @@ def update_uri(addr, port, ssl) # :nodoc: internal use only
 
   private
 
+  # :stopdoc:
+
   class Chunker #:nodoc:
     def initialize(sock)
       @sock = sock

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 @@ def add_field(key, val)
     end
   end
 
+  # :stopdoc:
   private def set_field(key, val)
     case val
     when Enumerable
@@ -294,6 +297,7 @@ def add_field(key, val)
       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 @@ def each_capitalized
 
   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,20 +961,20 @@ def proxy_basic_auth(account, password)
     @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}
     @header['proxy-connection']&.grep(token) {return true}
     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}

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 @@ class Net::HTTP::Get < Net::HTTPRequest
 # - 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 @@ class Net::HTTP::Head < Net::HTTPRequest
 # - 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 @@ class Net::HTTP::Post < Net::HTTPRequest
 # - 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 @@ class Net::HTTP::Put < Net::HTTPRequest
 # - 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 @@ class Net::HTTP::Delete < Net::HTTPRequest
 # - 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 @@ class Net::HTTP::Options < Net::HTTPRequest
 # - 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 @@ class Net::HTTP::Trace < Net::HTTPRequest
 # - 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 @@ class Net::HTTP::Patch < Net::HTTPRequest
 # - 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 @@ class Net::HTTP::Propfind < Net::HTTPRequest
 # - 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 @@ class Net::HTTP::Proppatch < Net::HTTPRequest
 # - 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 @@ class Net::HTTP::Mkcol < Net::HTTPRequest
 # - 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 @@ class Net::HTTP::Copy < Net::HTTPRequest
 # - 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 @@ class Net::HTTP::Move < Net::HTTPRequest
 # - 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 @@ class Net::HTTP::Lock < Net::HTTPRequest
 # - 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
-

lib/net/http/response.rb

@@ -153,6 +153,7 @@ def read_new(sock)   #:nodoc: internal use only
     end
 
     private
+    # :stopdoc:
 
     def read_status_line(sock)
       str = sock.readline
@@ -259,7 +260,7 @@ def body_encoding=(value)
   # header.
   attr_accessor :ignore_eof
 
-  def inspect
+  def inspect   # :nodoc:
     "#<#{self.class} #{@code} #{@message} readbody=#{@read}>"
   end