diff options
author | Kazuki Yamaguchi <k@rhe.jp> | 2016-08-19 16:48:56 +0900 |
---|---|---|
committer | Kazuki Yamaguchi <k@rhe.jp> | 2016-08-22 04:50:39 +0900 |
commit | a378e5148f4f93f8c82b0d9bcee02cd5d9883450 (patch) | |
tree | 39e03e54cbc427d9ccacaa9395bc2c7caf484e27 /ext/openssl/ossl_digest.c | |
parent | b9e17f6f9c4528d72f173c4ebea7786718e08218 (diff) | |
download | ruby-openssl-a378e5148f4f93f8c82b0d9bcee02cd5d9883450.tar.gz |
digest: cleanup documentation
Diffstat (limited to 'ext/openssl/ossl_digest.c')
-rw-r--r-- | ext/openssl/ossl_digest.c | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/ext/openssl/ossl_digest.c b/ext/openssl/ossl_digest.c index f9451220..44d96183 100644 --- a/ext/openssl/ossl_digest.c +++ b/ext/openssl/ossl_digest.c @@ -111,17 +111,16 @@ VALUE ossl_digest_update(VALUE, VALUE); * * Creates a Digest instance based on +string+, which is either the ln * (long name) or sn (short name) of a supported digest algorithm. + * * If +data+ (a +String+) is given, it is used as the initial input to the * Digest instance, i.e. + * * digest = OpenSSL::Digest.new('sha256', 'digestdata') + * * is equal to + * * digest = OpenSSL::Digest.new('sha256') * digest.update('digestdata') - * - * === Example - * digest = OpenSSL::Digest.new('sha1') - * - * */ static VALUE ossl_digest_initialize(int argc, VALUE *argv, VALUE self) @@ -243,7 +242,7 @@ ossl_digest_finish(int argc, VALUE *argv, VALUE self) * call-seq: * digest.name -> string * - * Returns the sn of this Digest instance. + * Returns the sn of this Digest algorithm. * * === Example * digest = OpenSSL::Digest::SHA512.new |