[gmime/gmime-2-4] Updated reference docs



commit 83880b11b9f6d13c8164879f0b47d3da3458a1b6
Author: Jeffrey Stedfast <fejj gnome org>
Date:   Sat Nov 27 22:50:35 2010 -0500

    Updated reference docs

 gmime/gmime-cipher-context.c |    9 ++++++---
 1 files changed, 6 insertions(+), 3 deletions(-)
---
diff --git a/gmime/gmime-cipher-context.c b/gmime/gmime-cipher-context.c
index 5368aa4..856320d 100644
--- a/gmime/gmime-cipher-context.c
+++ b/gmime/gmime-cipher-context.c
@@ -440,7 +440,8 @@ g_mime_signer_new (void)
  * g_mime_signer_free:
  * @signer: signer
  *
- * Free's the singleton signer.
+ * Frees a singleton signer. Should NOT be used to free signers
+ * returned from g_mime_signature_validity_get_signers().
  **/
 void
 g_mime_signer_free (GMimeSigner *signer)
@@ -860,7 +861,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 cipher keys.
+ * as trust and cipher 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)
@@ -876,7 +878,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]