From f3f7c40c492b791eecae4980eb817eb1aae02442 Mon Sep 17 00:00:00 2001
From: gsinclair <gsinclair@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Thu, 21 Aug 2003 09:07:57 +0000
Subject: Small changes to documentation; mainly hiding things from RDoc.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@4417 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 lib/net/http.rb | 26 ++++++++++++++++----------
 1 file changed, 16 insertions(+), 10 deletions(-)

(limited to 'lib/net/http.rb')

diff --git a/lib/net/http.rb b/lib/net/http.rb
index 33f1863bbd..93199e09f6 100644
--- a/lib/net/http.rb
+++ b/lib/net/http.rb
@@ -132,6 +132,8 @@
 #     }
 # 
 # === HTTP Response Classes
+#
+# TODO: write me.
 # 
 # == Switching Net::HTTP versions
 # 
@@ -155,10 +157,12 @@ require 'net/protocol'
 require 'uri'
 
 
-module Net
+module Net # :nodoc:
 
+  # :stopdoc:
   class HTTPBadResponse < StandardError; end
   class HTTPHeaderSyntaxError < StandardError; end
+  # :startdoc:
 
   #
   # Class providing both short-cut class methods for retrieving entities,
@@ -168,15 +172,11 @@ module Net
   #
   class HTTP < Protocol
 
+    # :stopdoc:
     Revision = %q$Revision$.split[1]
-
     HTTPVersion = '1.1'
-
-    #
-    # for backward compatibility
-    #
-
-    @@newimpl = true
+    @@newimpl = true    # for backward compatability
+    # :startdoc:
 
     # Turns on net/http 1.2 (ruby 1.8) features.
     # Defaults to ON in ruby 1.8.
@@ -411,7 +411,7 @@ module Net
     # When called with a block, returns the return value of the
     # block; otherwise, returns self.
     #
-    def start  # :yield: +http+
+    def start  # :yield: http
       raise IOError, 'HTTP session already opened' if @started
       if block_given?
         begin
@@ -1319,6 +1319,8 @@ module Net
     end
   end   # redefined after
 
+  # :stopdoc:
+
   class HTTPUnknownResponse < HTTPResponse
     HAS_BODY = true
     EXCEPTION_TYPE = HTTPError
@@ -1472,6 +1474,8 @@ module Net
     HAS_BODY = true
   end
 
+  # :startdoc:
+
 
   class HTTPResponse   # redefine
 
@@ -1778,12 +1782,14 @@ module Net
   end
 
 
+  # :enddoc:
+
   #--
   # for backward compatibility
   class HTTP
     ProxyMod = ProxyDelta
   end
-  module NetPrivate   #:nodoc:
+  module NetPrivate
     HTTPRequest = ::Net::HTTPRequest
   end
 
-- 
cgit v1.2.3