/pidgin/main: 33c30c4b33b4: Clarify docs - the PurpleCertificate...

[Daniel Atallah]

Changeset: 33c30c4b33b40704fdcf5beb153e4b2fdef3529d
Author:	 Daniel Atallah <datallah at pidgin.im>
Date:	 2014-06-25 18:57 -0400
Branch:	 release-2.x.y
URL: https://hg.pidgin.im/pidgin/main/rev/33c30c4b33b4

Description:

Clarify docs - the PurpleCertificate from purple_certificate_pool_retrieve must
be freed using purple_certificate_destroy.

diffstat:

 libpurple/certificate.h |  3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diffs (13 lines):

diff --git a/libpurple/certificate.h b/libpurple/certificate.h
--- a/libpurple/certificate.h
+++ b/libpurple/certificate.h
@@ -639,7 +639,8 @@ purple_certificate_pool_contains(PurpleC
  * Retrieve a certificate from a pool.
  * @param pool   Pool to fish in
  * @param id     ID to look up
- * @return Retrieved certificate, or NULL if it wasn't there
+ * @return Retrieved certificate (to be freed with purple_certificate_destroy),
+ *         or NULL if it wasn't there
  */
 PurpleCertificate *
 purple_certificate_pool_retrieve(PurpleCertificatePool *pool, const gchar *id);