aboutsummaryrefslogtreecommitdiffstats
path: root/lib/cgi/session.rb
diff options
context:
space:
mode:
authordrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-05-16 21:21:35 +0000
committerdrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-05-16 21:21:35 +0000
commite60f744e9a574630ebe1c14d023dc3d75ac6ae2b (patch)
tree7d8081e90d74a69b60e5dcd47edd9de824bb0b6c /lib/cgi/session.rb
parentc648243c3d94076959d77a3af3c4b72ebd9268a0 (diff)
downloadruby-e60f744e9a574630ebe1c14d023dc3d75ac6ae2b.tar.gz
* lib/cgi.rb: Add toplevel documentation to class CGI
* lib/cgi/session.rb: Add overview documentation to CGI::Cookie * lib/cgi/html.rb: Don't add CGI::TagMaker documentation to CGI. Patch by David Copeland. [Ruby 1.9 - Bug #4704] * lib/cgi/core.rb: Clean up CGI documentation. Patch by David Copeland. [Ruby 1.9 - Bug #4704] * lib/cgi/cookie.rb: Clean up CGI::Cookie documentation. Patch by David Copeland. [Ruby 1.9 - Bug #4704] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31595 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/cgi/session.rb')
-rw-r--r--lib/cgi/session.rb26
1 files changed, 10 insertions, 16 deletions
diff --git a/lib/cgi/session.rb b/lib/cgi/session.rb
index 65d6442b37..42b5ead81a 100644
--- a/lib/cgi/session.rb
+++ b/lib/cgi/session.rb
@@ -8,28 +8,22 @@
# Author: Yukihiro "Matz" Matsumoto
#
# Documentation: William Webber (william@williamwebber.com)
-#
-# == Overview
-#
-# This file provides the +CGI::Session+ class, which provides session
-# support for CGI scripts. A session is a sequence of HTTP requests
-# and responses linked together and associated with a single client.
-# Information associated with the session is stored
-# on the server between requests. A session id is passed between client
-# and server with every request and response, transparently
-# to the user. This adds state information to the otherwise stateless
-# HTTP request/response protocol.
-#
-# See the documentation to the +CGI::Session+ class for more details
-# and examples of usage. See cgi.rb for the +CGI+ class itself.
require 'cgi'
require 'tmpdir'
class CGI
- # Class representing an HTTP session. See documentation for the file
- # cgi/session.rb for an introduction to HTTP sessions.
+ # == Overview
+ #
+ # This file provides the CGI::Session class, which provides session
+ # support for CGI scripts. A session is a sequence of HTTP requests
+ # and responses linked together and associated with a single client.
+ # Information associated with the session is stored
+ # on the server between requests. A session id is passed between client
+ # and server with every request and response, transparently
+ # to the user. This adds state information to the otherwise stateless
+ # HTTP request/response protocol.
#
# == Lifecycle
#