gtlscertificate: Don't confuse certificate and public key in docs

* A certificate sorta acts as a public key, but more specifically
   it contains a public key (in its subjectPublicKeyInfo) field.
 * Documentation was confusing and could have read like the
   certificate and certificate-pem properties were returning the
   public key part of the certificate.

https://bugzilla.gnome.org/show_bug.cgi?id=681158
This commit is contained in:
Stef Walter 2012-08-03 21:51:08 +02:00
parent 278fe0c67f
commit 49b35f0930

View File

@ -35,9 +35,9 @@
* @see_also: #GTlsConnection * @see_also: #GTlsConnection
* *
* A certificate used for TLS authentication and encryption. * A certificate used for TLS authentication and encryption.
* This can represent either a public key only (eg, the certificate * This can represent either a certificate only (eg, the certificate
* received by a client from a server), or the combination of * received by a client from a server), or the combination of
* a public key and a private key (which is needed when acting as a * a certificate and a private key (which is needed when acting as a
* #GTlsServerConnection). * #GTlsServerConnection).
* *
* Since: 2.28 * Since: 2.28
@ -98,10 +98,9 @@ g_tls_certificate_class_init (GTlsCertificateClass *class)
/** /**
* GTlsCertificate:certificate: * GTlsCertificate:certificate:
* *
* The DER (binary) encoded representation of the certificate's * The DER (binary) encoded representation of the certificate.
* public key. This property and the * This property and the #GTlsCertificate:certificate-pem property
* #GTlsCertificate:certificate-pem property represent the same * represent the same data, just in different forms.
* data, just in different forms.
* *
* Since: 2.28 * Since: 2.28
*/ */
@ -116,8 +115,8 @@ g_tls_certificate_class_init (GTlsCertificateClass *class)
/** /**
* GTlsCertificate:certificate-pem: * GTlsCertificate:certificate-pem:
* *
* The PEM (ASCII) encoded representation of the certificate's * The PEM (ASCII) encoded representation of the certificate.
* public key. This property and the #GTlsCertificate:certificate * This property and the #GTlsCertificate:certificate
* property represent the same data, just in different forms. * property represent the same data, just in different forms.
* *
* Since: 2.28 * Since: 2.28