Bug #4704: Clean up and complete CGI documentation (patch included)

• Status: Closed
• Assignee: drbrain (Eric Hodel)
• Target version: -
• ruby -v: ruby 1.9.3dev (2011-05-16 trunk 31583) [x86_64-darwin10.7.0]

[davetron5000 (David Copeland)]

CGI's documentation has a few issues:

• Some RDoc is in the wrong place (e.g. Cookie's)
• Some is inconsistently worded or has grammar issues
• Some methods/attributes aren't documented at all

This patch addresses all of that, in addition to using :call-seq: to explain the different ways to call various methods.

[drbrain (Eric Hodel)]

• Status changed from Open to Closed
• % Done changed from 0 to 100

This issue was solved with changeset r31595.
David, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.

---

• 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]

[drbrain (Eric Hodel)]

I made a few additions to this patch to bring in the toplevel CGI documentation and include the overviews.

For the nested labeled lists I undented them quite a bit. For example:

foo:: blah blah
bar:: blah blah

To:

foo::
blah blah

bar:: blah blah

See the committed diff above for the actual changes.