* lib/webrick/httpservlet/erbhandler.rb: Add documentation.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31540 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 33 insertions, 0 deletions

diff --git a/lib/webrick/httpservlet/erbhandler.rb b/lib/webrick/httpservlet/erbhandler.rb
index cbd4fb2303..621d5206c0 100644
--- a/lib/webrick/httpservlet/erbhandler.rb
+++ b/lib/webrick/httpservlet/erbhandler.rb
@@ -15,12 +15,37 @@ require 'erb'
 module WEBrick
   module HTTPServlet
 
+    ##
+    # ERBHandler evaluates an ERB file and returns the result.  This handler
+    # is automatically used if there are .rhtml files in a directory served by
+    # the FileHandler.
+    #
+    # ERBHandler supports GET and POST methods.
+    #
+    # The ERB file is evaluated with the local variables +servlet_request+ and
+    # +servlet_response+ which are a WEBrick::HTTPRequest and
+    # WEBrick::HTTPResponse respectively.
+    #
+    # Example .rhtml file:
+    #
+    #   Request to <%= servlet_request.request_uri %>
+    #
+    #   Query params <%= servlet_request.query.inspect %>
+
     class ERBHandler < AbstractServlet
+
+      ##
+      # Creates a new ERBHandler on +server+ that will evaluate and serve the
+      # ERB file +name+
+
       def initialize(server, name)
         super(server, name)
         @script_filename = name
       end
 
+      ##
+      # Handles GET requests
+
       def do_GET(req, res)
         unless defined?(ERB)
           @logger.warn "#{self.class}: ERB not defined."
@@ -39,9 +64,17 @@ module WEBrick
         end
       end
 
+      ##
+      # Handles POST requests
+
       alias do_POST do_GET
 
       private
+
+      ##
+      # Evaluates +erb+ providing +servlet_request+ and +servlet_response+ as
+      # local variables.
+
       def evaluate(erb, servlet_request, servlet_response)
         Module.new.module_eval{
           servlet_request.meta_vars