* lib/xmlrpc.rb: Documentation for XMLRPC

* lib/xmlrpc/datetime.rb: ditto.
* lib/xmlrpc/parser.rb: ditto.
* lib/xmlrpc/client.rb: ditto.
* lib/xmlrpc/utils.rb: ditto.
* lib/xmlrpc/README.rdoc: ditto.
* lib/xmlrpc/create.rb: ditto.
* lib/xmlrpc/base64.rb: ditto.
* lib/xmlrpc/config.rb: ditto.
* lib/xmlrpc/httpserver.rb: ditto.
* lib/xmlrpc/server.rb: ditto.
* lib/xmlrpc/marshal.rb: ditto.
* lib/xmlrpc/README.txt: ditto.
  [Bug #6909] [ruby-core:47286]


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

1 files changed, 22 insertions, 41 deletions

diff --git a/lib/xmlrpc/base64.rb b/lib/xmlrpc/base64.rb
index bfa8c0a2d5..4aac3520c5 100644
--- a/lib/xmlrpc/base64.rb
+++ b/lib/xmlrpc/base64.rb
@@ -1,46 +1,23 @@
-=begin
-= xmlrpc/base64.rb
-Copyright (C) 2001, 2002, 2003 by Michael Neumann (mneumann@ntecs.de)
-
-Released under the same term of license as Ruby.
-
-= Classes
-* ((<XMLRPC::Base64>))
-
-= XMLRPC::Base64
-== Description
-This class is necessary for (('xmlrpc4r')) to determine that a string should
-be transmitted base64-encoded and not as a raw-string.
-You can use (({XMLRPC::Base64})) on the client and server-side as a
-parameter and/or return-value.
-
-== Class Methods
---- XMLRPC::Base64.new( str, state = :dec )
-    Creates a new (({XMLRPC::Base64})) instance with string ((|str|)) as the
-    internal string. When ((|state|)) is (({:dec})) it assumes that the
-    string ((|str|)) is not in base64 format (perhaps already decoded),
-    otherwise if ((|state|)) is (({:enc})) it decodes ((|str|))
-    and stores it as the internal string.
-
---- XMLRPC::Base64.decode( str )
-    Decodes string ((|str|)) with base64 and returns that value.
-
---- XMLRPC::Base64.encode( str )
-    Encodes string ((|str|)) with base64 and returns that value.
-
-== Instance Methods
---- XMLRPC::Base64#decoded
-    Returns the internal string decoded.
-
---- XMLRPC::Base64#encoded
-    Returns the internal string encoded with base64.
-
-=end
-
-module XMLRPC
-
+#
+# xmlrpc/base64.rb
+# Copyright (C) 2001, 2002, 2003 by Michael Neumann (mneumann@ntecs.de)
+#
+# Released under the same term of license as Ruby.
+
+module XMLRPC # :nodoc:
+
+# This class is necessary for 'xmlrpc4r' to determine that a string should
+# be transmitted base64-encoded and not as a raw-string.
+#
+# You can use XMLRPC::Base64 on the client and server-side as a
+# parameter and/or return-value.
 class Base64
 
+  # Creates a new XMLRPC::Base64 instance with string +str+ as the
+  # internal string. When +state+ is +:dec+ it assumes that the
+  # string +str+ is not in base64 format (perhaps already decoded),
+  # otherwise if +state+ is +:enc+ it decodes +str+
+  # and stores it as the internal string.
   def initialize(str, state = :dec)
     case state
     when :enc
@@ -52,19 +29,23 @@ class Base64
     end
   end
 
+  # Returns the decoded internal string.
   def decoded
     @str
   end
 
+  # Returns the base64 encoded internal string.
   def encoded
     Base64.encode(@str)
   end
 
 
+  # Decodes string +str+ with base64 and returns that value.
   def Base64.decode(str)
     str.gsub(/\s+/, "").unpack("m")[0]
   end
 
+  # Encodes string +str+ with base64 and returns that value.
   def Base64.encode(str)
     [str].pack("m")
   end