[gmime] Updated reference docs
- From: Jeffrey Stedfast <fejj src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gmime] Updated reference docs
- Date: Sun, 28 Nov 2010 03:53:18 +0000 (UTC)
commit e1261bd694f14f34cd906e2708f1d5414a241c75
Author: Jeffrey Stedfast <fejj gnome org>
Date: Sat Nov 27 22:53:02 2010 -0500
Updated reference docs
gmime/gmime-crypto-context.c | 9 ++++++---
1 files changed, 6 insertions(+), 3 deletions(-)
---
diff --git a/gmime/gmime-crypto-context.c b/gmime/gmime-crypto-context.c
index 79eef32..86106a6 100644
--- a/gmime/gmime-crypto-context.c
+++ b/gmime/gmime-crypto-context.c
@@ -480,7 +480,8 @@ g_mime_signer_new (void)
* g_mime_signer_free:
* @signer: signer
*
- * Free's the singleton signer.
+ * Frees the singleton signer. Should NOT be used to free signers
+ * returned from g_mime_signature_validity_get_signers().
**/
void
g_mime_signer_free (GMimeSigner *signer)
@@ -1137,7 +1138,8 @@ g_mime_signature_validity_set_details (GMimeSignatureValidity *validity, const c
* Gets the list of signers.
*
* Returns: a #GMimeSigner list which contain further information such
- * as trust and crypto keys.
+ * as trust and crypto keys. These signers are part of the
+ * #GMimeSignatureValidity and should NOT be freed individually.
**/
const GMimeSigner *
g_mime_signature_validity_get_signers (const GMimeSignatureValidity *validity)
@@ -1153,7 +1155,8 @@ g_mime_signature_validity_get_signers (const GMimeSignatureValidity *validity)
* @validity: signature validity
* @signer: signer
*
- * Adds @signer to the list of signers on @validity.
+ * Adds @signer to the list of signers on @validity. Once the signer
+ * is added, it must NOT be freed.
**/
void
g_mime_signature_validity_add_signer (GMimeSignatureValidity *validity, GMimeSigner *signer)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]