From 13ae409e1ee96cb191d223e475cb563405dcec83 Mon Sep 17 00:00:00 2001 From: drbrain Date: Mon, 16 May 2011 22:15:32 +0000 Subject: * lib/net/http.rb: Improve documentation of proxy configuration methods. Patch by Alf Mikula. [Ruby 1.9 - Bug #4714] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31603 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- lib/net/http.rb | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) (limited to 'lib/net/http.rb') diff --git a/lib/net/http.rb b/lib/net/http.rb index 553ebd9df2..4faf6c87ae 100644 --- a/lib/net/http.rb +++ b/lib/net/http.rb @@ -883,9 +883,17 @@ module Net #:nodoc: @is_proxy_class end + # Address of proxy host. If Net::HTTP does not use a proxy, nil. attr_reader :proxy_address + + # Port number of proxy host. If Net::HTTP does not use a proxy, nil. attr_reader :proxy_port + + # User name for accessing proxy. If Net::HTTP does not use a proxy, nil. attr_reader :proxy_user + + # User password for accessing proxy. If Net::HTTP does not use a proxy, + # nil. attr_reader :proxy_pass end @@ -894,22 +902,22 @@ module Net #:nodoc: self.class.proxy_class? end - # Address of proxy host. If self does not use a proxy, nil. + # A convenience method for accessing value of proxy_address from Net::HTTP. def proxy_address self.class.proxy_address end - # Port number of proxy host. If self does not use a proxy, nil. + # A convenience method for accessing value of proxy_port from Net::HTTP. def proxy_port self.class.proxy_port end - # User name for accessing proxy. If self does not use a proxy, nil. + # A convenience method for accessing value of proxy_user from Net::HTTP. def proxy_user self.class.proxy_user end - # User password for accessing proxy. If self does not use a proxy, nil. + # A convenience method for accessing value of proxy_pass from Net::HTTP. def proxy_pass self.class.proxy_pass end -- cgit v1.2.3