emboss	2011-05-31 06:47:37 +0900 (Tue, 31 May 2011)

  New Revision: 31826

  http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=31826

  Log:
    * ext/openssl/ossl_pkey_rsa.c: Complete documentation.

  Modified files:
    trunk/ext/openssl/ossl_pkey_rsa.c

Index: ext/openssl/ossl_pkey_rsa.c
===================================================================
--- ext/openssl/ossl_pkey_rsa.c	(revision 31825)
+++ ext/openssl/ossl_pkey_rsa.c	(revision 31826)
@@ -570,8 +570,24 @@
     mPKey = rb_define_module_under(mOSSL, "PKey");
 #endif
 
+    /* Document-class: OpenSSL::PKey::RSAError
+     *
+     * Generic exception that is raised if an operation on an RSA PKey
+     * fails unexpectedly or in case an instantiation of an instance of RSA
+     * fails due to non-conformant input data.
+     */
     eRSAError = rb_define_class_under(mPKey, "RSAError", ePKeyError);
 
+    /* Document-class: OpenSSL::PKey::RSA
+     *
+     * RSA is an asymmetric public key algorithm that has been formalized in
+     * RFC 3447. It is in widespread use in public key infrastuctures (PKI)
+     * where certificates (cf. OpenSSL::X509::Certificate) often are issued
+     * on the basis of a public/private RSA key pair. RSA is used in a wide
+     * field of applications such as secure (symmetric) key exchange, e.g.
+     * when establishing a secure TLS/SSL connection. It is also used in
+     * various digital signature schemes.
+     */
     cRSA = rb_define_class_under(mPKey, "RSA", cPKey);
 
     rb_define_singleton_method(cRSA, "generate", ossl_rsa_s_generate, -1);

--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/