Skip to content

Commit ebd04d1

Browse files
committed
[DOC] Missing documents
1 parent 9d9a2eb commit ebd04d1

File tree

6 files changed

+18
-0
lines changed

6 files changed

+18
-0
lines changed

.document

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
BSDL
2+
COPYING
3+
README.md
4+
ext/
5+
lib/

lib/cgi.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,6 +289,7 @@
289289
#
290290

291291
class CGI
292+
# The version string
292293
VERSION = "0.5.0"
293294
end
294295

lib/cgi/cookie.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,11 @@ class CGI
4040
class Cookie < Array
4141
@@accept_charset="UTF-8" unless defined?(@@accept_charset)
4242

43+
# :stopdoc:
4344
TOKEN_RE = %r"\A[[!-~]&&[^()<>@,;:\\\"/?=\[\]{}]]+\z"
4445
PATH_VALUE_RE = %r"\A[[ -~]&&[^;]]*\z"
4546
DOMAIN_VALUE_RE = %r"\A\.?(?<label>(?!-)[-A-Za-z0-9]+(?<!-))(?:\.\g<label>)*\z"
47+
# :startdoc:
4648

4749
# Create a new CGI::Cookie object.
4850
#

lib/cgi/escape.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# frozen_string_literal: true
22

3+
# :stopdoc
34
class CGI
45
module Escape; end
56
include Escape
67
extend Escape
8+
module EscapeExt; end # :nodoc:
79
end
10+
# :startdoc:
811

12+
# Escape/unescape for CGI, HTML, URI.
913
module CGI::Escape
1014
@@accept_charset = Encoding::UTF_8 unless defined?(@@accept_charset)
1115

lib/cgi/html.rb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1006,27 +1006,32 @@ def doctype
10061006

10071007
end # Html5
10081008

1009+
# HTML version 3 generation class.
10091010
class HTML3
10101011
include Html3
10111012
include HtmlExtension
10121013
end
10131014

1015+
# HTML version 4 generation class.
10141016
class HTML4
10151017
include Html4
10161018
include HtmlExtension
10171019
end
10181020

1021+
# HTML version 4 transitional generation class.
10191022
class HTML4Tr
10201023
include Html4Tr
10211024
include HtmlExtension
10221025
end
10231026

1027+
# HTML version 4 with framesets generation class.
10241028
class HTML4Fr
10251029
include Html4Tr
10261030
include Html4Fr
10271031
include HtmlExtension
10281032
end
10291033

1034+
# HTML version 5 generation class.
10301035
class HTML5
10311036
include Html5
10321037
include HtmlExtension

lib/cgi/util.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ module Util; end
55
extend Util
66
end
77

8+
# Utility methods for CGI.
89
module CGI::Util
910
# Format a +Time+ object as a String using the format specified by RFC 1123.
1011
#

0 commit comments

Comments
 (0)