[gmime] Fixed GMimeCryptoContext doc comments
- From: Jeffrey Stedfast <fejj src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gmime] Fixed GMimeCryptoContext doc comments
- Date: Fri, 4 Mar 2011 21:56:27 +0000 (UTC)
commit cf943d89693e91e962ba238040227fbe5323215c
Author: Jeffrey Stedfast <fejj gnome org>
Date: Fri Mar 4 16:49:32 2011 -0500
Fixed GMimeCryptoContext doc comments
gmime/gmime-crypto-context.c | 18 +++++++++---------
gmime/gmime-crypto-context.h | 2 +-
2 files changed, 10 insertions(+), 10 deletions(-)
---
diff --git a/gmime/gmime-crypto-context.c b/gmime/gmime-crypto-context.c
index 7e1b516..0d95dd5 100644
--- a/gmime/gmime-crypto-context.c
+++ b/gmime/gmime-crypto-context.c
@@ -560,7 +560,7 @@ g_mime_signer_new (GMimeSignerStatus status)
/**
* g_mime_signer_free:
- * @signer: signer
+ * @signer: a #GMimeSigner
*
* Frees the singleton signer. Should NOT be used to free signers
* returned from g_mime_signature_validity_get_signers().
@@ -587,8 +587,8 @@ g_mime_signer_free (GMimeSigner *signer)
*
* Returns: the next #GMimeSigner or %NULL when complete.
**/
-GMimeSigner *
-g_mime_signer_next (GMimeSigner *signer)
+const GMimeSigner *
+g_mime_signer_next (const GMimeSigner *signer)
{
g_return_val_if_fail (signer != NULL, NULL);
@@ -1189,7 +1189,7 @@ g_mime_signature_validity_new (void)
/**
* g_mime_signature_validity_free:
- * @validity: signature validity
+ * @validity: a #GMimeSignatureValidity
*
* Frees the memory used by @validity back to the system.
**/
@@ -1216,7 +1216,7 @@ g_mime_signature_validity_free (GMimeSignatureValidity *validity)
/**
* g_mime_signature_validity_get_details:
- * @validity: signature validity
+ * @validity: a #GMimeSignatureValidity
*
* Gets any user-readable status details.
*
@@ -1233,7 +1233,7 @@ g_mime_signature_validity_get_details (const GMimeSignatureValidity *validity)
/**
* g_mime_signature_validity_set_details:
- * @validity: signature validity
+ * @validity: a #GMimeSignatureValidity
* @details: details string
*
* Sets @details as the status details string on @validity.
@@ -1250,7 +1250,7 @@ g_mime_signature_validity_set_details (GMimeSignatureValidity *validity, const c
/**
* g_mime_signature_validity_get_signers:
- * @validity: signature validity
+ * @validity: a #GMimeSignatureValidity
*
* Gets the list of signers.
*
@@ -1269,8 +1269,8 @@ g_mime_signature_validity_get_signers (const GMimeSignatureValidity *validity)
/**
* g_mime_signature_validity_add_signer:
- * @validity: signature validity
- * @signer: signer
+ * @validity: a #GMimeSignatureValidity
+ * @signer: a #GMimeSigner
*
* Adds @signer to the list of signers on @validity. Once the signer
* is added, it must NOT be freed.
diff --git a/gmime/gmime-crypto-context.h b/gmime/gmime-crypto-context.h
index 4f1ddb6..363f9c6 100644
--- a/gmime/gmime-crypto-context.h
+++ b/gmime/gmime-crypto-context.h
@@ -320,7 +320,7 @@ struct _GMimeSigner {
GMimeSigner *g_mime_signer_new (GMimeSignerStatus status);
void g_mime_signer_free (GMimeSigner *signer);
-GMimeSigner *g_mime_signer_next (GMimeSigner *signer);
+const GMimeSigner *g_mime_signer_next (const GMimeSigner *signer);
void g_mime_signer_set_status (GMimeSigner *signer, GMimeSignerStatus status);
GMimeSignerStatus g_mime_signer_get_status (const GMimeSigner *signer);
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]