* lib/rss/parser.rb, lib/rss/utils.rb: added documents.

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

1 files changed, 5 insertions, 0 deletions

diff --git a/lib/rss/utils.rb b/lib/rss/utils.rb
index 031ff3072b..b242a72292 100644
--- a/lib/rss/utils.rb
+++ b/lib/rss/utils.rb
@@ -1,6 +1,8 @@
 module RSS
   module Utils
     module_function
+
+    # Convert a name_with_underscores to CamelCase.
     def to_class_name(name)
       name.split(/_/).collect do |part|
         "#{part[0, 1].upcase}#{part[1..-1]}"
@@ -12,11 +14,14 @@ module RSS
       [file, line.to_i]
     end
 
+    # escape '&', '"', '<' and '>' for use in HTML.
     def html_escape(s)
       s.to_s.gsub(/&/, "&amp;").gsub(/\"/, "&quot;").gsub(/>/, "&gt;").gsub(/</, "&lt;")
     end
     alias h html_escape
     
+    # If +value+ is an instance of class +klass+, return it, else
+    # create a new instance of +klass+ with value +value+.
     def new_with_value_if_need(klass, value)
       if value.is_a?(klass)
         value