[gcr] gcr: Update documentation and symbols



commit 248450a71a214f9aed593431e4068a71bba54c88
Author: Stef Walter <stefw collabora co uk>
Date:   Thu Nov 24 07:53:49 2011 +0100

    gcr: Update documentation and symbols

 docs/reference/gcr/gcr-sections.txt |    7 ++++++-
 gcr/gcr-base.symbols                |    3 +++
 gcr/gcr-certificate-request.c       |   31 +++++++++++++++++++++++++++++++
 3 files changed, 40 insertions(+), 1 deletions(-)
---
diff --git a/docs/reference/gcr/gcr-sections.txt b/docs/reference/gcr/gcr-sections.txt
index e918813..7503337 100644
--- a/docs/reference/gcr/gcr-sections.txt
+++ b/docs/reference/gcr/gcr-sections.txt
@@ -93,12 +93,17 @@ GcrGeneralNameType
 <FILE>gcr-certificate-request</FILE>
 GcrCertificateRequest
 GcrCertificateRequestFormat
+gcr_certificate_request_capable
+gcr_certificate_request_capable_async
+gcr_certificate_request_capable_finish
 gcr_certificate_request_prepare
+gcr_certificate_request_get_format
+gcr_certificate_request_get_private_key
+gcr_certificate_request_set_cn
 gcr_certificate_request_complete
 gcr_certificate_request_complete_async
 gcr_certificate_request_complete_finish
 gcr_certificate_request_encode
-gcr_certificate_request_set_cn
 <SUBSECTION Private>
 GCR_CERTIFICATE_REQUEST
 GCR_IS_CERTIFICATE_REQUEST
diff --git a/gcr/gcr-base.symbols b/gcr/gcr-base.symbols
index d578127..2d2f1b8 100644
--- a/gcr/gcr-base.symbols
+++ b/gcr/gcr-base.symbols
@@ -40,6 +40,9 @@ gcr_certificate_mixin_comparable_init
 gcr_certificate_mixin_emit_notify
 gcr_certificate_mixin_get_property
 gcr_certificate_is_issuer
+gcr_certificate_request_capable
+gcr_certificate_request_capable_async
+gcr_certificate_request_capable_finish
 gcr_certificate_request_complete
 gcr_certificate_request_complete_async
 gcr_certificate_request_complete_finish
diff --git a/gcr/gcr-certificate-request.c b/gcr/gcr-certificate-request.c
index 310736a..ce355e1 100644
--- a/gcr/gcr-certificate-request.c
+++ b/gcr/gcr-certificate-request.c
@@ -762,6 +762,17 @@ gcr_certificate_request_encode (GcrCertificateRequest *self,
 	return encoded;
 }
 
+/**
+ * gcr_certificate_request_capable:
+ * @private_key: a private key
+ * @cancellable: cancellation object
+ * @error: location to place an error
+ *
+ * Check whether #GcrCertificateRequest is capable of creating a request
+ * for the given @private_key.
+ *
+ * Returns: whether a request can be created
+ */
 gboolean
 gcr_certificate_request_capable (GckObject *private_key,
                                  GCancellable *cancellable,
@@ -776,6 +787,16 @@ gcr_certificate_request_capable (GckObject *private_key,
 	                                 CKA_SIGN, cancellable, error);
 }
 
+/**
+ * gcr_certificate_request_capable_async:
+ * @private_key: a private key
+ * @cancellable: cancellation object
+ * @callback: will be called when the operation completes
+ * @user_data: data to be passed to callback
+ *
+ * Asynchronously check whether #GcrCertificateRequest is capable of creating
+ * a request for the given @private_key.
+ */
 void
 gcr_certificate_request_capable_async (GckObject *private_key,
                                        GCancellable *cancellable,
@@ -791,6 +812,16 @@ gcr_certificate_request_capable_async (GckObject *private_key,
 	                                 callback, user_data);
 }
 
+/**
+ * gcr_certificate_request_capable_finish:
+ * @result: asynchronous result
+ * @error: location to place an error
+ *
+ * Get the result for asynchronously check whether #GcrCertificateRequest is
+ * capable of creating a request for the given @private_key.
+ *
+ * Returns: whether a request can be created
+ */
 gboolean
 gcr_certificate_request_capable_finish (GAsyncResult *result,
                                         GError **error)



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]