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

* ext/openssl/ossl_asn1.c: [DOC] Document parts of

Browse source 
OpenSSL::ASN1::ObjectId included a fix for the class overview, which
  previously showed the documentation for Constructive due to missing
  ObjectId overview. This patch also includes a note for Primative.

  Based on a patch by @vbatts via GH-436
  https://github.com/ruby/ruby/pull/436


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@43666 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
zzak 2013-11-13 09:06:17 +00:00
parent 75cef5054b
commit 49a9845405
2 changed files with 49 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
ChangeLog
View file

@ -1,3 +1,13 @@
Wed Nov 13 18:03:00 2013 Zachary Scott <e@zzak.io>
* ext/openssl/ossl_asn1.c: [DOC] Document parts of
OpenSSL::ASN1::ObjectId included a fix for the class overview, which
previously showed the documentation for Constructive due to missing
ObjectId overview. This patch also includes a note for Primative.
Based on a patch by @vbatts via GH-436
https://github.com/ruby/ruby/pull/436
Wed Nov 13 17:19:36 2013 Zachary Scott <e@zzak.io> Wed Nov 13 17:19:36 2013 Zachary Scott <e@zzak.io>
* ext/openssl/lib/openssl/config.rb: In #parse use +string+ for +str+ * ext/openssl/lib/openssl/config.rb: In #parse use +string+ for +str+

39
ext/openssl/ossl_asn1.c
View file

@ -1358,6 +1358,17 @@ ossl_asn1cons_each(VALUE self)
return self; return self;
} }
/*
* call-seq:
* ObjectId.register(object_id, short_name, long_name)
*
* This adds a new ObjectId to the internal tables. Where +object_id+ is the
* numerical form, +short_name+ is the short name, and +long_name+ is the long
* name.
*
* Returns +true+ if successful. Raises an ASN1Error otherwise.
*
*/
static VALUE static VALUE
ossl_asn1obj_s_register(VALUE self, VALUE oid, VALUE sn, VALUE ln) ossl_asn1obj_s_register(VALUE self, VALUE oid, VALUE sn, VALUE ln)
{ {
@ -1371,6 +1382,14 @@ ossl_asn1obj_s_register(VALUE self, VALUE oid, VALUE sn, VALUE ln)
return Qtrue; return Qtrue;
} }
/* Document-method: OpenSSL::ASN1::ObjectId#sn
*
* The short name of the ObjectId, as defined in +openssl/objects.h+.
*/
/* Document-method: OpenSSL::ASN1::ObjectId#short_name
*
* #short_name is an alias to #sn
*/
static VALUE static VALUE
ossl_asn1obj_get_sn(VALUE self) ossl_asn1obj_get_sn(VALUE self)
{ {
@ -1384,6 +1403,14 @@ ossl_asn1obj_get_sn(VALUE self)
return ret; return ret;
} }
/* Document-method: OpenSSL::ASN1::ObjectId#ln
*
* The long name of the ObjectId, as defined in +openssl/objects.h+.
*/
/* Document-method: OpenSSL::ASN1::ObjectId.long_name
*
* #long_name is an alias to #ln
*/
static VALUE static VALUE
ossl_asn1obj_get_ln(VALUE self) ossl_asn1obj_get_ln(VALUE self)
{ {
@ -1397,6 +1424,10 @@ ossl_asn1obj_get_ln(VALUE self)
return ret; return ret;
} }
/* Document-method: OpenSSL::ASN1::ObjectId#oid
*
* The object identifier as a String.
*/
static VALUE static VALUE
ossl_asn1obj_get_oid(VALUE self) ossl_asn1obj_get_oid(VALUE self)
{ {
@ -1778,6 +1809,10 @@ Init_ossl_asn1()
* *
* == OpenSSL::ASN1::ObjectId * == OpenSSL::ASN1::ObjectId
* *
* While OpenSSL::ASN1::ObjectId.new will allocate a new ObjectId, it is
* not typically allocated this way, but rather that are recieved from
* parsed ASN1 encodings.
*
* === Additional attributes * === Additional attributes
* * +sn+: the short name as defined in <openssl/objects.h>. * * +sn+: the short name as defined in <openssl/objects.h>.
* * +ln+: the long name as defined in <openssl/objects.h>. * * +ln+: the long name as defined in <openssl/objects.h>.
@ -1917,6 +1952,10 @@ do{\
OSSL_ASN1_DEFINE_CLASS(EndOfContent, Data); OSSL_ASN1_DEFINE_CLASS(EndOfContent, Data);
/* Document-class: OpenSSL::ASN1::ObjectId
*
* Represents the primative object id for OpenSSL::ASN1
*/
#if 0 #if 0
cASN1ObjectId = rb_define_class_under(mASN1, "ObjectId", cASN1Primitive); /* let rdoc know */ cASN1ObjectId = rb_define_class_under(mASN1, "ObjectId", cASN1Primitive); /* let rdoc know */
#endif #endif