Merge pull request #869 from midnight-wonderer/docs/initialize_copy

rhenium · web-flow · commit b4877f8aa04e · 2025-03-13T01:03:41.000+09:00
Improve document of `initialize_copy`
diff --git a/ext/openssl/ossl_bn.c b/ext/openssl/ossl_bn.c
@@ -929,6 +929,7 @@ BIGNUM_NUM(num_bytes)
  */
 BIGNUM_NUM(num_bits)
 
+/* :nodoc: */
 static VALUE
 ossl_bn_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_cipher.c b/ext/openssl/ossl_cipher.c
@@ -130,6 +130,7 @@ ossl_cipher_initialize(VALUE self, VALUE str)
     return self;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_cipher_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_digest.c b/ext/openssl/ossl_digest.c
@@ -141,6 +141,7 @@ ossl_digest_initialize(int argc, VALUE *argv, VALUE self)
     return self;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_digest_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_hmac.c b/ext/openssl/ossl_hmac.c
@@ -113,6 +113,7 @@ ossl_hmac_initialize(VALUE self, VALUE key, VALUE digest)
     return self;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_hmac_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_ocsp.c b/ext/openssl/ossl_ocsp.c
@@ -173,6 +173,7 @@ ossl_ocspreq_alloc(VALUE klass)
     return obj;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_ocspreq_initialize_copy(VALUE self, VALUE other)
 {
@@ -513,6 +514,7 @@ ossl_ocspres_alloc(VALUE klass)
     return obj;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_ocspres_initialize_copy(VALUE self, VALUE other)
 {
@@ -669,6 +671,7 @@ ossl_ocspbres_alloc(VALUE klass)
     return obj;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_ocspbres_initialize_copy(VALUE self, VALUE other)
 {
@@ -1157,6 +1160,7 @@ ossl_ocspsres_initialize(VALUE self, VALUE arg)
     return self;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_ocspsres_initialize_copy(VALUE self, VALUE other)
 {
@@ -1418,6 +1422,7 @@ ossl_ocspcid_alloc(VALUE klass)
     return obj;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_ocspcid_initialize_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_pkcs12.c b/ext/openssl/ossl_pkcs12.c
@@ -60,6 +60,7 @@ ossl_pkcs12_s_allocate(VALUE klass)
     return obj;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_pkcs12_initialize_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_pkcs7.c b/ext/openssl/ossl_pkcs7.c
@@ -392,6 +392,7 @@ ossl_pkcs7_initialize(int argc, VALUE *argv, VALUE self)
     return self;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_pkcs7_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_pkey.c b/ext/openssl/ossl_pkey.c
@@ -615,6 +615,7 @@ ossl_pkey_initialize(VALUE self)
 }
 
 #ifdef HAVE_EVP_PKEY_DUP
+/* :nodoc: */
 static VALUE
 ossl_pkey_initialize_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_pkey_dh.c b/ext/openssl/ossl_pkey_dh.c
@@ -128,6 +128,7 @@ ossl_dh_initialize(int argc, VALUE *argv, VALUE self)
 }
 
 #ifndef HAVE_EVP_PKEY_DUP
+/* :nodoc: */
 static VALUE
 ossl_dh_initialize_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_pkey_dsa.c b/ext/openssl/ossl_pkey_dsa.c
@@ -140,6 +140,7 @@ ossl_dsa_initialize(int argc, VALUE *argv, VALUE self)
 }
 
 #ifndef HAVE_EVP_PKEY_DUP
+/* :nodoc: */
 static VALUE
 ossl_dsa_initialize_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_pkey_ec.c b/ext/openssl/ossl_pkey_ec.c
@@ -191,6 +191,7 @@ static VALUE ossl_ec_key_initialize(int argc, VALUE *argv, VALUE self)
 }
 
 #ifndef HAVE_EVP_PKEY_DUP
+/* :nodoc: */
 static VALUE
 ossl_ec_key_initialize_copy(VALUE self, VALUE other)
 {
@@ -706,6 +707,7 @@ static VALUE ossl_ec_group_initialize(int argc, VALUE *argv, VALUE self)
     return self;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_ec_group_initialize_copy(VALUE self, VALUE other)
 {
@@ -1261,6 +1263,7 @@ static VALUE ossl_ec_point_initialize(int argc, VALUE *argv, VALUE self)
     return self;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_ec_point_initialize_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_pkey_rsa.c b/ext/openssl/ossl_pkey_rsa.c
@@ -136,6 +136,7 @@ ossl_rsa_initialize(int argc, VALUE *argv, VALUE self)
 }
 
 #ifndef HAVE_EVP_PKEY_DUP
+/* :nodoc: */
 static VALUE
 ossl_rsa_initialize_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_ssl_session.c b/ext/openssl/ossl_ssl_session.c
@@ -69,6 +69,7 @@ ossl_ssl_session_initialize(VALUE self, VALUE arg1)
     return self;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_ssl_session_initialize_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_x509attr.c b/ext/openssl/ossl_x509attr.c
@@ -123,6 +123,7 @@ ossl_x509attr_initialize(int argc, VALUE *argv, VALUE self)
     return self;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_x509attr_initialize_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_x509cert.c b/ext/openssl/ossl_x509cert.c
@@ -140,6 +140,7 @@ ossl_x509_initialize(int argc, VALUE *argv, VALUE self)
     return self;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_x509_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_x509crl.c b/ext/openssl/ossl_x509crl.c
@@ -117,6 +117,7 @@ ossl_x509crl_initialize(int argc, VALUE *argv, VALUE self)
     return self;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_x509crl_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_x509ext.c b/ext/openssl/ossl_x509ext.c
@@ -295,6 +295,7 @@ ossl_x509ext_initialize(int argc, VALUE *argv, VALUE self)
     return self;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_x509ext_initialize_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_x509name.c b/ext/openssl/ossl_x509name.c
@@ -177,6 +177,7 @@ ossl_x509name_initialize(int argc, VALUE *argv, VALUE self)
     return self;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_x509name_initialize_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_x509req.c b/ext/openssl/ossl_x509req.c
@@ -103,6 +103,7 @@ ossl_x509req_initialize(int argc, VALUE *argv, VALUE self)
     return self;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_x509req_copy(VALUE self, VALUE other)
 {
diff --git a/ext/openssl/ossl_x509revoked.c b/ext/openssl/ossl_x509revoked.c
@@ -105,6 +105,7 @@ ossl_x509revoked_initialize(int argc, VALUE *argv, VALUE self)
     return self;
 }
 
+/* :nodoc: */
 static VALUE
 ossl_x509revoked_initialize_copy(VALUE self, VALUE other)
 {

Original file line number	Diff line number	Diff line change
`@@ -929,6 +929,7 @@ BIGNUM_NUM(num_bytes)`
`929`	`929`	`*/`
`930`	`930`	`BIGNUM_NUM(num_bits)`
`931`	`931`
	`932`	`+/* :nodoc: */`
`932`	`933`	`static VALUE`
`933`	`934`	`ossl_bn_copy(VALUE self, VALUE other)`
`934`	`935`	`{`
Original file line number	Diff line number	Diff line change
`@@ -130,6 +130,7 @@ ossl_cipher_initialize(VALUE self, VALUE str)`
`130`	`130`	`return self;`
`131`	`131`	`}`
`132`	`132`
	`133`	`+/* :nodoc: */`
`133`	`134`	`static VALUE`
`134`	`135`	`ossl_cipher_copy(VALUE self, VALUE other)`
`135`	`136`	`{`
Original file line number	Diff line number	Diff line change
`@@ -141,6 +141,7 @@ ossl_digest_initialize(int argc, VALUE *argv, VALUE self)`
`141`	`141`	`return self;`
`142`	`142`	`}`
`143`	`143`
	`144`	`+/* :nodoc: */`
`144`	`145`	`static VALUE`
`145`	`146`	`ossl_digest_copy(VALUE self, VALUE other)`
`146`	`147`	`{`
Original file line number	Diff line number	Diff line change
`@@ -113,6 +113,7 @@ ossl_hmac_initialize(VALUE self, VALUE key, VALUE digest)`
`113`	`113`	`return self;`
`114`	`114`	`}`
`115`	`115`
	`116`	`+/* :nodoc: */`
`116`	`117`	`static VALUE`
`117`	`118`	`ossl_hmac_copy(VALUE self, VALUE other)`
`118`	`119`	`{`
Original file line number	Diff line number	Diff line change
`@@ -173,6 +173,7 @@ ossl_ocspreq_alloc(VALUE klass)`
`173`	`173`	`return obj;`
`174`	`174`	`}`
`175`	`175`
	`176`	`+/* :nodoc: */`
`176`	`177`	`static VALUE`
`177`	`178`	`ossl_ocspreq_initialize_copy(VALUE self, VALUE other)`
`178`	`179`	`{`
`@@ -513,6 +514,7 @@ ossl_ocspres_alloc(VALUE klass)`
`513`	`514`	`return obj;`
`514`	`515`	`}`
`515`	`516`
	`517`	`+/* :nodoc: */`
`516`	`518`	`static VALUE`
`517`	`519`	`ossl_ocspres_initialize_copy(VALUE self, VALUE other)`
`518`	`520`	`{`
`@@ -669,6 +671,7 @@ ossl_ocspbres_alloc(VALUE klass)`
`669`	`671`	`return obj;`
`670`	`672`	`}`
`671`	`673`
	`674`	`+/* :nodoc: */`
`672`	`675`	`static VALUE`
`673`	`676`	`ossl_ocspbres_initialize_copy(VALUE self, VALUE other)`
`674`	`677`	`{`
`@@ -1157,6 +1160,7 @@ ossl_ocspsres_initialize(VALUE self, VALUE arg)`
`1157`	`1160`	`return self;`
`1158`	`1161`	`}`
`1159`	`1162`
	`1163`	`+/* :nodoc: */`
`1160`	`1164`	`static VALUE`
`1161`	`1165`	`ossl_ocspsres_initialize_copy(VALUE self, VALUE other)`
`1162`	`1166`	`{`
`@@ -1418,6 +1422,7 @@ ossl_ocspcid_alloc(VALUE klass)`
`1418`	`1422`	`return obj;`
`1419`	`1423`	`}`
`1420`	`1424`
	`1425`	`+/* :nodoc: */`
`1421`	`1426`	`static VALUE`
`1422`	`1427`	`ossl_ocspcid_initialize_copy(VALUE self, VALUE other)`
`1423`	`1428`	`{`
Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,7 @@ ossl_pkcs12_s_allocate(VALUE klass)`
`60`	`60`	`return obj;`
`61`	`61`	`}`
`62`	`62`
	`63`	`+/* :nodoc: */`
`63`	`64`	`static VALUE`
`64`	`65`	`ossl_pkcs12_initialize_copy(VALUE self, VALUE other)`
`65`	`66`	`{`
Original file line number	Diff line number	Diff line change
`@@ -392,6 +392,7 @@ ossl_pkcs7_initialize(int argc, VALUE *argv, VALUE self)`
`392`	`392`	`return self;`
`393`	`393`	`}`
`394`	`394`
	`395`	`+/* :nodoc: */`
`395`	`396`	`static VALUE`
`396`	`397`	`ossl_pkcs7_copy(VALUE self, VALUE other)`
`397`	`398`	`{`
Original file line number	Diff line number	Diff line change
`@@ -615,6 +615,7 @@ ossl_pkey_initialize(VALUE self)`
`615`	`615`	`}`
`616`	`616`
`617`	`617`	`#ifdef HAVE_EVP_PKEY_DUP`
	`618`	`+/* :nodoc: */`
`618`	`619`	`static VALUE`
`619`	`620`	`ossl_pkey_initialize_copy(VALUE self, VALUE other)`
`620`	`621`	`{`
Original file line number	Diff line number	Diff line change
`@@ -128,6 +128,7 @@ ossl_dh_initialize(int argc, VALUE *argv, VALUE self)`
`128`	`128`	`}`
`129`	`129`
`130`	`130`	`#ifndef HAVE_EVP_PKEY_DUP`
	`131`	`+/* :nodoc: */`
`131`	`132`	`static VALUE`
`132`	`133`	`ossl_dh_initialize_copy(VALUE self, VALUE other)`
`133`	`134`	`{`
Original file line number	Diff line number	Diff line change
`@@ -140,6 +140,7 @@ ossl_dsa_initialize(int argc, VALUE *argv, VALUE self)`
`140`	`140`	`}`
`141`	`141`
`142`	`142`	`#ifndef HAVE_EVP_PKEY_DUP`
	`143`	`+/* :nodoc: */`
`143`	`144`	`static VALUE`
`144`	`145`	`ossl_dsa_initialize_copy(VALUE self, VALUE other)`
`145`	`146`	`{`