diff options
author | knu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2006-10-13 20:55:33 +0000 |
---|---|---|
committer | knu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2006-10-13 20:55:33 +0000 |
commit | 694b2c7a29dc8e0f468053cafe85df7c63b20580 (patch) | |
tree | a65f293f8179e5c3a5c071a984ffe171e428a565 /ext/digest | |
parent | bf8cd1e929d3f1ad2c1a6aefda9da08ebdc11d05 (diff) |
* ext/digest/digest.c: Improve RDoc documentation further more.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@11165 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/digest')
-rw-r--r-- | ext/digest/digest.c | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/ext/digest/digest.c b/ext/digest/digest.c index 55c490c31e..9d56cb89c4 100644 --- a/ext/digest/digest.c +++ b/ext/digest/digest.c @@ -112,7 +112,8 @@ rb_digest_base_alloc(VALUE klass) * * Returns the hash value of a given string _data_. This is almost * equivalent to Digest::ALGORITHM.new(...).update(string).digest() - * where extra arguments, if any, are passed to the constructor. + * where extra arguments, if any, are passed through to the + * constructor. */ static VALUE rb_digest_base_s_digest(int argc, VALUE *argv, VALUE klass) @@ -157,7 +158,7 @@ rb_digest_base_s_digest(int argc, VALUE *argv, VALUE klass) * Returns the hex-encoded hash value of a given _string_. This * method just hex-encode the return value of * Digest::ALGORITHM.digest(string[, ...]) where extra arguments, if - * any, are passed to digest() along with the _string_. + * any, are passed through along with the _string_. */ static VALUE rb_digest_base_s_hexdigest(int argc, VALUE *argv, VALUE klass) @@ -197,6 +198,10 @@ rb_digest_base_copy(VALUE copy, VALUE obj) * digest_obj.reset -> digest_obj * * Resets the digest to the initial state and returns self. + * + * Every implementation subclass which constructor takes arguments + * must redefine this method because Digest::Base#reset() internally + * calls initialize() with no argument. */ static VALUE rb_digest_base_reset(VALUE self) @@ -225,6 +230,8 @@ rb_digest_base_reset(VALUE self) * digest_obj.update(string) -> digest_obj * * Updates the digest using a given _string_ and returns self. + * + * Implementation subclasses must redefine this method. */ static VALUE rb_digest_base_update(VALUE self, VALUE str) @@ -252,6 +259,8 @@ rb_digest_base_update(VALUE self, VALUE str) * digest_obj << string -> digest_obj * * Calls update(string). + * + * Subclasses need not redefine this method. */ static VALUE rb_digest_base_lshift(VALUE self, VALUE str) @@ -281,6 +290,8 @@ rb_digest_base_lshift(VALUE self, VALUE str) * digest_obj.digest -> string * * Returns the resulting hash value. + * + * Implementation subclasses must redefine this method. */ static VALUE rb_digest_base_digest(VALUE self) |