From c648243c3d94076959d77a3af3c4b72ebd9268a0 Mon Sep 17 00:00:00 2001
From: drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Mon, 16 May 2011 20:52:55 +0000
Subject: 	* ext/digest: Improve documentation of Digest, Digest::HMAC
 and 	  Digest::SHA2.  Patch by Pete Higgins.  [Ruby 1.9 - Bug #4702]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31594 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 ext/digest/sha2/lib/sha2.rb | 49 +++++++++++++++++++++++++++++++++++++--------
 1 file changed, 41 insertions(+), 8 deletions(-)

(limited to 'ext/digest/sha2/lib')

diff --git a/ext/digest/sha2/lib/sha2.rb b/ext/digest/sha2/lib/sha2.rb
index b8e4609478..3c5bf0c863 100644
--- a/ext/digest/sha2/lib/sha2.rb
+++ b/ext/digest/sha2/lib/sha2.rb
@@ -18,9 +18,11 @@ module Digest
   #
   class SHA2 < Digest::Class
     # call-seq:
-    #     Digest::SHA2.new(bitlen = 256) -> digest_obj
+    #   Digest::SHA2.new(bitlen = 256) -> digest_obj
     #
     # Creates a new SHA2 hash object with a given bit length.
+    #
+    # Valid bit lengths are 256, 384 and 512.
     def initialize(bitlen = 256)
       case bitlen
       when 256
@@ -35,39 +37,70 @@ module Digest
       @bitlen = bitlen
     end
 
-    # :nodoc:
+    # call-seq:
+    #   digest_obj.reset -> digest_obj
+    #
+    # Resets the digest to the initial state and returns self.
     def reset
       @sha2.reset
       self
     end
 
-    # :nodoc:
+    # call-seq:
+    #   digest_obj.update(string) -> digest_obj
+    #   digest_obj << string -> digest_obj
+    #
+    # Updates the digest using a given _string_ and returns self.
     def update(str)
       @sha2.update(str)
       self
     end
     alias << update
 
-    def finish
+    def finish # :nodoc:
       @sha2.digest!
     end
     private :finish
 
+
+    # call-seq:
+    #   digest_obj.block_length -> Integer
+    #
+    # Returns the block length of the digest in bytes.
+    #
+    #   Digest::SHA256.new.digest_length * 8
+    #   # => 512
+    #   Digest::SHA384.new.digest_length * 8
+    #   # => 1024
+    #   Digest::SHA512.new.digest_length * 8
+    #   # => 1024
     def block_length
       @sha2.block_length
     end
 
+    # call-seq:
+    #   digest_obj.digest_length -> Integer
+    #
+    # Returns the length of the hash value of the digest in bytes.
+    #
+    #   Digest::SHA256.new.digest_length * 8
+    #   # => 256
+    #   Digest::SHA384.new.digest_length * 8
+    #   # => 384
+    #   Digest::SHA512.new.digest_length * 8
+    #   # => 512
+    #
+    # For example, digests produced by Digest::SHA256 will always be 32 bytes
+    # (256 bits) in size.
     def digest_length
       @sha2.digest_length
     end
 
-    # :nodoc:
-    def initialize_copy(other)
+    def initialize_copy(other) # :nodoc:
       @sha2 = other.instance_eval { @sha2.clone }
     end
 
-    # :nodoc:
-    def inspect
+    def inspect # :nodoc:
       "#<%s:%d %s>" % [self.class.name, @bitlen, hexdigest]
     end
   end
-- 
cgit v1.2.3