diff -r 4879ef4db7cf -r 323b1884d008 libpurple/tls-certificate.h
--- a/libpurple/tls-certificate.h Thu Apr 07 01:29:49 2016 -0500
+++ b/libpurple/tls-certificate.h Thu Apr 07 01:27:18 2016 -0500
@@ -26,8 +26,14 @@
/**
* SECTION:tls-certificate
* @section_id: libpurple-tls-certificate
- * @short_description: tls-certificate.h
+ * @short_description: TLS certificate trust and storage API
* @title: TLS Certificate API
+ *
+ * The TLS Certificate API provides functions for trusting and storing
+ * certificates for use with TLS/SSL connections. This allows certificates,
+ * which aren't considered valid by the TLS implementation, to be manually
+ * trusted by the user, distrusted at a later time, and queried by the UI.
+ * It also provides functions to simply wire this system into Gio.
*/
#include
@@ -39,7 +45,7 @@
* purple_tls_certificate_trust() and friends. These IDs can then be passed
* to purple_certificate_path() or used directly, if desired.
*
- * Returns: The #GList of IDs described above
+ * Returns: (element-type utf8): The #GList of IDs described above
* Free with purple_certificate_free_ids()
*/
GList *
@@ -100,7 +106,8 @@
* Connects the Purple TLS certificate subsystem to @conn so it will accept
* certificates trusted by purple_tls_certificate_trust() and friends.
*
- * Returns: @conn, similar to g_object_connect()
+ * Returns: (transfer: none) (type GObject.Object): @conn, similar to
+ * g_object_connect()
*/
gpointer
purple_tls_certificate_attach_to_tls_connection(GTlsConnection *conn);
@@ -113,7 +120,8 @@
* connections it creates will accept certificates trusted by
* purple_tls_certificate_trust() and friends.
*
- * Returns: @client, similar to g_object_connect()
+ * Returns: (transfer: none) (type GObject.Object): @client, similar to
+ * g_object_connect()
*/
gpointer
purple_tls_certificate_attach_to_socket_client(GSocketClient *client);