[gmime/gmime-2-4] Fixed multipart/encrypted docs

[Jeffrey Stedfast <fejj src gnome org>]

commit 73b66da012bca1054901c4a7fb5970045983db28
Author: Jeffrey Stedfast <fejj gnome org>
Date:   Sat Jan 29 16:25:53 2011 -0500

    Fixed multipart/encrypted docs
    
    2011-01-29  Jeffrey Stedfast  <fejj novell com>
    
    	* gmime/gmime-multipart-encrypted.c
    	* (g_mime_multipart_encrypted_decrypt):
    	Fixed documentation. Fixes bug #640906 and bug #640911.

 ChangeLog                         |    5 +++++
 gmime/gmime-multipart-encrypted.c |   20 ++++++++++++--------
 2 files changed, 17 insertions(+), 8 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 71945ae..b19bbfd 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2011-01-29  Jeffrey Stedfast  <fejj novell com>
+
+	* gmime/gmime-multipart-encrypted.c (g_mime_multipart_encrypted_decrypt):
+	Fixed documentation. Fixes bug #640906 and bug #640911.
+
 2011-01-25  Jeffrey Stedfast  <fejj novell com>
 
 	* README: Bumped version
diff --git a/gmime/gmime-multipart-encrypted.c b/gmime/gmime-multipart-encrypted.c
index 446e894..a3a683e 100644
--- a/gmime/gmime-multipart-encrypted.c
+++ b/gmime/gmime-multipart-encrypted.c
@@ -213,7 +213,7 @@ g_mime_multipart_encrypted_new (void)
  * g_mime_multipart_encrypted_encrypt:
  * @mpe: multipart/encrypted object
  * @content: MIME part to encrypt
- * @ctx: encryption cipher context
+ * @ctx: encryption context
  * @sign: %TRUE if the content should also be signed or %FALSE otherwise
  * @userid: user id to use for signing (only used if @sign is %TRUE)
  * @recipients: an array of recipients to encrypt to
@@ -315,19 +315,23 @@ g_mime_multipart_encrypted_encrypt (GMimeMultipartEncrypted *mpe, GMimeObject *c
 /**
  * g_mime_multipart_encrypted_decrypt:
  * @mpe: multipart/encrypted object
- * @ctx: decryption cipher context
+ * @ctx: decryption context
  * @err: a #GError
  *
  * Attempts to decrypt the encrypted MIME part contained within the
- * multipart/encrypted object @mpe using the @ctx decryption context.
+ * multipart/encrypted object @mpe using the @ctx decryption
+ * context.
  *
- * If @validity is non-NULL, then on a successful decrypt operation,
- * it will be updated to point to a newly-allocated
- * #GMimeSignatureValidity with signature status information.
+ * For information regarding the signature status (in cases where the
+ * MIME part was both encrypted and signed), you may wish to check the
+ * results of g_mime_multipart_encrypted_get_signature_validity().
  *
- * Returns: the decrypted MIME part on success or %NULL on fail. If the
- * decryption fails, an exception will be set on @err to provide
+ * Returns: the decrypted MIME part on success or %NULL on fail. If
+ * the decryption fails, an exception will be set on @err to provide
  * information as to why the failure occured.
+ *
+ * Note: On success, the decrypted MIME part is cached internally and
+ * so the returned #GMimeObject must NOT be unreffed.
  **/
 GMimeObject *
 g_mime_multipart_encrypted_decrypt (GMimeMultipartEncrypted *mpe, GMimeCipherContext *ctx,