add document.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@12500 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
fgo · Jun 10, 2007 · 1b8a677 · 1b8a677
1 parent 52ec7cc
commit 1b8a677
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/lib/securerandom.rb b/lib/securerandom.rb
@@ -42,6 +42,9 @@ module SecureRandom
   #
   # The argument n specifies the length of the result string.
   #
+  # If n is not specified, 16 is assumed.
+  # It may be larger in future.
+  #
   # If secure random number generator is not available,
   # NotImplementedError is raised.
   def self.random_bytes(n=nil)
@@ -79,6 +82,9 @@ def self.random_bytes(n=nil)
   # The argument n specifies the length of the random length.
   # The length of the result string is twice of n.
   #
+  # If n is not specified, 16 is assumed.
+  # It may be larger in future.
+  #
   # If secure random number generator is not available,
   # NotImplementedError is raised.
   def self.hex(n=nil)
@@ -90,6 +96,9 @@ def self.hex(n=nil)
   # The argument n specifies the length of the random length.
   # The length of the result string is about 4/3 of n.
   #
+  # If n is not specified, 16 is assumed.
+  # It may be larger in future.
+  #
   # If secure random number generator is not available,
   # NotImplementedError is raised.
   def self.base64(n=nil)