From 34276148c4450faa77bb298cfbe005f7c263f802 Mon Sep 17 00:00:00 2001
From: drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Wed, 18 May 2011 21:07:13 +0000
Subject: 	* lib/cgi/util.rb:  Improve documentation.  Patch by Clinton
 Nixon. 	  [Ruby 1.9 - Bug #4733] 	* lib/cgi/core.rb:  ditto 
 * lib/cgi/cookie.rb:  ditto

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31634 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 lib/cgi/cookie.rb | 2 ++
 lib/cgi/core.rb   | 6 ++++++
 lib/cgi/util.rb   | 8 ++++++++
 3 files changed, 16 insertions(+)

(limited to 'lib')

diff --git a/lib/cgi/cookie.rb b/lib/cgi/cookie.rb
index f05f83e0c9..c2526931d5 100644
--- a/lib/cgi/cookie.rb
+++ b/lib/cgi/cookie.rb
@@ -104,10 +104,12 @@ class CGI
     # True if this cookie is secure; false otherwise
     attr_reader("secure")
 
+    # Returns the value or list of values for this cookie.
     def value
       self
     end
 
+    # Replaces the value of this cookie with a new value or list of values.
     def value=(val)
       replace(Array(val))
     end
diff --git a/lib/cgi/core.rb b/lib/cgi/core.rb
index 4a271d2ba7..a756ab5542 100644
--- a/lib/cgi/core.rb
+++ b/lib/cgi/core.rb
@@ -46,14 +46,17 @@ class CGI
 
   # :startdoc:
 
+  # Synonym for ENV.
   def env_table
     ENV
   end
 
+  # Synonym for $stdin.
   def stdinput
     $stdin
   end
 
+  # Synonym for $stdout.
   def stdoutput
     $stdout
   end
@@ -705,14 +708,17 @@ class CGI
 
   @@accept_charset="UTF-8"
 
+  # Return the accept character set for all new CGI instances.
   def self.accept_charset
     @@accept_charset
   end
 
+  # Set the accept character set for all new CGI instances.
   def self.accept_charset=(accept_charset)
     @@accept_charset=accept_charset
   end
 
+  # Return the accept character set for this CGI instance.
   attr_reader :accept_charset
 
   # Create a new CGI instance.
diff --git a/lib/cgi/util.rb b/lib/cgi/util.rb
index 9f8a63ac92..e611cbedb2 100644
--- a/lib/cgi/util.rb
+++ b/lib/cgi/util.rb
@@ -83,9 +83,13 @@ class CGI
       end
     end
   end
+
+  # Synonym for CGI.escapeHTML.
   def CGI::escape_html(str)
     escapeHTML(str)
   end
+
+  # Synonym for CGI.unescapeHTML.
   def CGI::unescape_html(str)
     unescapeHTML(str)
   end
@@ -134,9 +138,13 @@ class CGI
       string
     end
   end
+
+  # Synonym for CGI.escapeElement.
   def CGI::escape_element(str)
     escapeElement(str)
   end
+
+  # Synonym for CGI.unescapeElement.
   def CGI::unescape_element(str)
     unescapeElement(str)
   end
-- 
cgit v1.2.3