1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

* ext/openssl/*: Document synonymous methods, by windwiny [GH-277]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@40316 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
zzak 2013-04-16 02:24:09 +00:00
parent 582ba0a57c
commit a152c41e53
9 changed files with 20 additions and 9 deletions

View file

@ -1,3 +1,7 @@
Tue Apr 16 11:23:00 2013 Zachary Scott <zachary@zacharyscott.net>
* ext/openssl/*: Document synonymous methods, by windwiny [GH-277]
Mon Apr 15 22:21:42 2013 Tanaka Akira <akr@fsij.org>
* ext/fiddle/depend: New file.

View file

@ -206,7 +206,7 @@ ossl_hmac_s_digest(VALUE klass, VALUE digest, VALUE key, VALUE data)
/*
* call-seq:
* HMAC.digest(digest, key, data) -> aString
* HMAC.hexdigest(digest, key, data) -> aString
*
*/
static VALUE

View file

@ -149,7 +149,7 @@ ossl_ocspreq_add_nonce(int argc, VALUE *argv, VALUE self)
* 2: nonces both absent.
* 3: nonce present in response only.
* 0: nonces both present and not equal.
* -1: nonce in request only.
* -1: nonce in request only.
*
* For most responders clients can check return > 0.
* If responder doesn't handle nonces return != 0 may be

View file

@ -278,7 +278,9 @@ ossl_dh_is_private(VALUE self)
/*
* call-seq:
* dh.export -> aString
* dh.to_pem -> aString
* dh.to_s -> aString
*
* Encodes this DH to its PEM encoding. Note that any existing per-session
* public/private keys will *not* get encoded, just the Diffie-Hellman
@ -428,7 +430,7 @@ ossl_dh_to_public_key(VALUE self)
/*
* call-seq:
* dh.check_params -> true | false
* dh.params_ok? -> true | false
*
* Validates the Diffie-Hellman parameters associated with this instance.
* It checks whether a safe prime and a suitable generator are used. If this

View file

@ -291,7 +291,9 @@ ossl_dsa_is_private(VALUE self)
/*
* call-seq:
* dsa.export([cipher, password]) -> aString
* dsa.to_pem([cipher, password]) -> aString
* dsa.to_s([cipher, password]) -> aString
*
* Encodes this DSA to its PEM encoding.
*

View file

@ -533,8 +533,8 @@ static VALUE ossl_ec_key_to_string(VALUE self, VALUE ciph, VALUE pass, int forma
/*
* call-seq:
* key.export => String
* key.export(cipher, pass_phrase) => String
* key.export([cipher, pass_phrase]) => String
* key.to_pem([cipher, pass_phrase]) => String
*
* Outputs the EC key in PEM encoding. If +cipher+ and +pass_phrase+ are
* given they will be used to encrypt the key. +cipher+ must be an
@ -843,6 +843,7 @@ static VALUE ossl_ec_group_initialize(int argc, VALUE *argv, VALUE self)
}
/* call-seq:
* group1.eql?(group2) => true | false
* group1 == group2 => true | false
*
*/
@ -1312,6 +1313,7 @@ static VALUE ossl_ec_point_initialize(int argc, VALUE *argv, VALUE self)
/*
* call-seq:
* point1.eql?(point2) => true | false
* point1 == point2 => true | false
*
*/

View file

@ -291,8 +291,9 @@ ossl_rsa_is_private(VALUE self)
/*
* call-seq:
* rsa.to_pem => PEM-format String
* rsa.to_pem(cipher, pass_phrase) => PEM-format String
* rsa.export([cipher, pass_phrase]) => PEM-format String
* rsa.to_pem([cipher, pass_phrase]) => PEM-format String
* rsa.to_s([cipher, pass_phrase]) => PEM-format String
*
* Outputs this keypair in PEM encoding. If +cipher+ and +pass_phrase+ are
* given they will be used to encrypt the key. +cipher+ must be an

View file

@ -1634,7 +1634,7 @@ ossl_ssl_get_peer_cert_chain(VALUE self)
/*
* call-seq:
* ssl.version => String
* ssl.ssl_version => String
*
* Returns a String representing the SSL/TLS version that was negotiated
* for the connection, for example "TLSv1.2".

View file

@ -257,7 +257,7 @@ ossl_x509store_add_path(VALUE self, VALUE dir)
/*
* call-seq:
* store.set_default_path
* store.set_default_paths
*
* Adds the default certificates to the certificate store. These certificates
* are loaded from the default configuration directory which can usually be