Merged in qulogic/pidgin (pull request #260)

Tue, 26 Sep 2017 02:41:52 +0000

author
Gary Kramlich <grim@reaperworld.com>
date
Tue, 26 Sep 2017 02:41:52 +0000
changeset 38717
29a0a4cdee6f
parent 38714
a7b3becdc6ea (current diff)
parent 38716
b9bed228745a (diff)
child 38740
560f19f9911a
child 38741
fb51706245fb
child 38750
16fe33af8c11
child 38765
32c6a279adc4
child 38800
8a2ea9672bcb
child 38897
6db89a0010ae

Merged in qulogic/pidgin (pull request #260)

Add lots of element-type annotations

Approved-by: Gary Kramlich <grim@reaperworld.com>

--- a/libpurple/accountopt.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/accountopt.h	Tue Sep 26 02:41:52 2017 +0000
@@ -119,7 +119,7 @@
  * purple_account_option_list_new:
  * @text:      The text of the option.
  * @pref_name: The account preference name for the option.
- * @list:      The key, value list.
+ * @list: (element-type PurpleKeyValuePair) (transfer full): The key, value list.
  *
  * Creates a new list account option.
  *
@@ -189,7 +189,7 @@
 /**
  * purple_account_option_string_set_hints:
  * @option: The account option.
- * @hints: The list of hints, stored as strings.
+ * @hints: (element-type utf8) (transfer full): The list of hints, stored as strings.
  *
  * Sets the hint list for an account option.
  *
@@ -202,7 +202,8 @@
 /**
  * purple_account_option_set_list:
  * @option: The account option.
- * @values: The default list value.
+ * @values: (element-type PurpleKeyValuePair) (transfer full): The default list
+ *          value.
  *
  * Sets the list values for an account option.
  *
@@ -318,7 +319,7 @@
  *
  * Returns the list of hints for an account option.
  *
- * Returns: (transfer none): A list of hints, stored as strings.
+ * Returns: (element-type utf8) (transfer none): A list of hints.
  */
 const GSList * purple_account_option_string_get_hints(const PurpleAccountOption *option);
 
@@ -328,10 +329,10 @@
  *
  * Returns the list values for an account option.
  *
- * Returns: (transfer none): A list of #PurpleKeyValuePair, mapping the human-readable
- *              description of the value to the <type>(const char *)</type> that
- *              should be passed to purple_account_set_string() to set the
- *              option.
+ * Returns: (element-type PurpleKeyValuePair) (transfer none): A list of
+ *          #PurpleKeyValuePair, mapping the human-readable description of the
+ *          value to the <type>(const char *)</type> that should be passed to
+ *          purple_account_set_string() to set the option.
  */
 GList *purple_account_option_get_list(const PurpleAccountOption *option);
 
--- a/libpurple/accounts.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/accounts.h	Tue Sep 26 02:41:52 2017 +0000
@@ -146,7 +146,7 @@
  *
  * Returns a list of all accounts.
  *
- * Returns: (transfer none): A list of all accounts.
+ * Returns: (element-type PurpleAccount) (transfer none): A list of all accounts.
  */
 GList *purple_accounts_get_all(void);
 
@@ -155,9 +155,8 @@
  *
  * Returns a list of all enabled accounts
  *
- * Returns: A list of all enabled accounts. The list is owned
- *         by the caller, and must be g_list_free()d to avoid
- *         leaking the nodes.
+ * Returns: (element-type PurpleAccount) (transfer container): A list of all
+ *          enabled accounts.
  */
 GList *purple_accounts_get_all_active(void);
 
--- a/libpurple/blistnode.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/blistnode.h	Tue Sep 26 02:41:52 2017 +0000
@@ -289,10 +289,8 @@
  * purple_blist_node_get_extended_menu:
  * @n: The blist node for which to obtain the extended menu items.
  *
- * Retrieves the extended menu items for a buddy list node.
- *
- * Returns:  A list of PurpleMenuAction items, as harvested by the
- *          blist-node-extended-menu signal.
+ * Returns: (element-type PurpleMenuAction): The extended menu items for a buddy
+ *          list node, as harvested by the blist-node-extended-menu signal.
  */
 GList *purple_blist_node_get_extended_menu(PurpleBlistNode *n);
 
--- a/libpurple/buddylist.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/buddylist.h	Tue Sep 26 02:41:52 2017 +0000
@@ -195,8 +195,8 @@
  *
  * See purple_blist_find_buddies().
  *
- * Returns: A list of every buddy in the list. Caller is responsible for
- *          freeing the list.
+ * Returns: (element-type PurpleBlistNode) (transfer container): A list of every
+ *          buddy in the list.
  */
 GSList *purple_blist_get_buddies(void);
 
@@ -380,10 +380,8 @@
  *
  * Finds all PurpleBuddy structs given a name and an account
  *
- * Returns:        NULL if the buddy doesn't exist, or a GSList of
- *                PurpleBuddy structs.  You must free the GSList using
- *                g_slist_free.  Do not free the PurpleBuddy structs that
- *                the list points to.
+ * Returns: (element-type PurpleBuddy) (transfer container): %NULL if the buddy
+ *          doesn't exist, or a GSList of PurpleBuddy structs.
  */
 GSList *purple_blist_find_buddies(PurpleAccount *account, const char *name);
 
--- a/libpurple/circularbuffer.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/circularbuffer.h	Tue Sep 26 02:41:52 2017 +0000
@@ -78,18 +78,18 @@
 
 /**
  * purple_circular_buffer_append:
- * @buf: The PurpleCircularBuffer to which to append the data
+ * @buffer: The PurpleCircularBuffer to which to append the data
  * @src: pointer to the data to copy into the buffer
  * @len: number of bytes to copy into the buffer
  *
  * Append data to the PurpleCircularBuffer.  This will grow the internal
  * buffer to fit the added data, if needed.
  */
-void purple_circular_buffer_append(PurpleCircularBuffer *buf, gconstpointer src, gsize len);
+void purple_circular_buffer_append(PurpleCircularBuffer *buffer, gconstpointer src, gsize len);
 
 /**
  * purple_circular_buffer_get_max_read:
- * @buf: the PurpleCircularBuffer for which to determine the maximum
+ * @buffer: the PurpleCircularBuffer for which to determine the maximum
  *            contiguous bytes that can be read.
  *
  * Determine the maximum number of contiguous bytes that can be read from the
@@ -100,11 +100,11 @@
  *
  * Returns: the number of bytes that can be read from the PurpleCircularBuffer
  */
-gsize purple_circular_buffer_get_max_read(const PurpleCircularBuffer *buf);
+gsize purple_circular_buffer_get_max_read(const PurpleCircularBuffer *buffer);
 
 /**
  * purple_circular_buffer_mark_read:
- * @buf: The PurpleCircularBuffer to mark bytes read from
+ * @buffer: The PurpleCircularBuffer to mark bytes read from
  * @len: The number of bytes to mark as read
  *
  * Mark the number of bytes that have been read from the buffer.
@@ -112,7 +112,7 @@
  * Returns: TRUE if we successfully marked the bytes as having been read, FALSE
  *         otherwise.
  */
-gboolean purple_circular_buffer_mark_read(PurpleCircularBuffer *buf, gsize len);
+gboolean purple_circular_buffer_mark_read(PurpleCircularBuffer *buffer, gsize len);
 
 /**
  * purple_circular_buffer_grow:
--- a/libpurple/cmds.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/cmds.h	Tue Sep 26 02:41:52 2017 +0000
@@ -272,14 +272,11 @@
  *
  * List registered commands.
  *
- * Returns a #GList (which must be freed by the caller) of all commands
+ * Returns: (element-type utf8) (transfer container): All commands
  * that are valid in the context of @conv, or all commands, if @conv is
  * %NULL.  Don't keep this list around past the main loop, or anything else that
  * might unregister a command, as the <type>const char *</type>'s used get freed
  * then.
- *
- * Returns: A #GList of <type>const char *</type>, which must be freed with
- *          g_list_free().
  */
 GList *purple_cmd_list(PurpleConversation *conv);
 
@@ -291,11 +288,8 @@
  *
  * Get the help string for a command.
  *
- * Returns the help strings for a given command in the form of a GList,
- * one node for each matching command.
- *
- * Returns: A #GList of <type>const char *</type>s, which is the help string
- *         for that command.
+ * Returns: (element-type utf8) (transfer container): the help strings for a
+ *          given command, one node for each matching command.
  */
 GList *purple_cmd_help(PurpleConversation *conv, const gchar *cmd);
 
--- a/libpurple/connection.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/connection.h	Tue Sep 26 02:41:52 2017 +0000
@@ -435,7 +435,8 @@
  *
  * Returns a list of active chat conversations on a connection.
  *
- * Returns: The active chats on the connection.
+ * Returns: (element-type PurpleChatConversation) (transfer none): The active
+ *          chats on the connection.
  */
 GSList *purple_connection_get_active_chats(const PurpleConnection *gc);
 
@@ -598,7 +599,8 @@
  * Returns a list of all active connections.  This does not
  * include connections that are in the process of connecting.
  *
- * Returns: (transfer none): A list of all active connections.
+ * Returns: (element-type PurpleConnection) (transfer none): A list of all
+ *          active connections.
  */
 GList *purple_connections_get_all(void);
 
@@ -607,7 +609,8 @@
  *
  * Returns a list of all connections in the process of connecting.
  *
- * Returns: (transfer none): A list of connecting connections.
+ * Returns: (element-type PurpleConnection) (transfer none): A list of
+ *          connecting connections.
  */
 GList *purple_connections_get_connecting(void);
 
@@ -669,4 +672,4 @@
 
 G_END_DECLS
 
-#endif /* _PURPLE_CONNECTION_H_ */
\ No newline at end of file
+#endif /* _PURPLE_CONNECTION_H_ */
--- a/libpurple/conversations.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/conversations.h	Tue Sep 26 02:41:52 2017 +0000
@@ -61,7 +61,7 @@
  *
  * This list includes both IMs and chats.
  *
- * Returns: (transfer none): A GList of all conversations.
+ * Returns: (element-type PurpleConversation) (transfer none): A GList of all conversations.
  */
 GList *purple_conversations_get_all(void);
 
@@ -70,7 +70,7 @@
  *
  * Returns a list of all IMs.
  *
- * Returns: (transfer none): A GList of all IMs.
+ * Returns: (element-type PurpleIMConversation) (transfer none): All IMs.
  */
 GList *purple_conversations_get_ims(void);
 
@@ -79,7 +79,7 @@
  *
  * Returns a list of all chats.
  *
- * Returns: (transfer none): A GList of all chats.
+ * Returns: (element-type PurpleChatConversation) (transfer none): All chats.
  */
 GList *purple_conversations_get_chats(void);
 
--- a/libpurple/e2ee.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/e2ee.h	Tue Sep 26 02:41:52 2017 +0000
@@ -245,10 +245,8 @@
  * @provider: The E2EE provider.
  * @conv: The conversation.
  *
- * Returns the list of actions for an E2EE menu.
- *
- * Returns: (transfer full): the #GList of #PurpleMenuAction's. Should be
- *          #g_list_free or #g_list_free_full'd when done using it.
+ * Returns: (element-type PurpleMenuAction) (transfer full): The list of
+ *          actions for an E2EE menu.
  */
 GList *
 purple_e2ee_provider_get_conv_menu_actions(PurpleE2eeProvider *provider,
--- a/libpurple/group.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/group.h	Tue Sep 26 02:41:52 2017 +0000
@@ -105,8 +105,8 @@
  *
  * Returns a list of accounts that have buddies in this group
  *
- * Returns: A GSList of accounts (which must be freed), or NULL if the group
- *         has no accounts.
+ * Returns: (element-type PurpleAccount) (transfer container): A list of
+ *          accounts, or %NULL if the group has no accounts.
  */
 GSList *purple_group_get_accounts(PurpleGroup *g);
 
--- a/libpurple/http.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/http.h	Tue Sep 26 02:41:52 2017 +0000
@@ -908,8 +908,8 @@
  *
  * Gets all headers got with response.
  *
- * Returns:         GList of PurpleKeyValuePair, which keys are header field
- *                 names (gchar*) and values are its contents (gchar*).
+ * Returns: (element-type PurpleKeyValuePair) (transfer none): Keys are header
+ *          field names (gchar*) and values are its contents (gchar*).
  */
 const GList * purple_http_response_get_all_headers(PurpleHttpResponse *response);
 
@@ -920,7 +920,7 @@
  *
  * Gets all headers with specified name got with response.
  *
- * Returns:         GList of header field records contents (gchar*).
+ * Returns: (element-type gchar*) (transfer none): Header field record contents.
  */
 const GList * purple_http_response_get_headers_by_name(
 	PurpleHttpResponse *response, const gchar *name);
--- a/libpurple/keyring.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/keyring.h	Tue Sep 26 02:41:52 2017 +0000
@@ -278,7 +278,7 @@
  * Returns a GList containing the IDs and names of the registered
  * keyrings.
  *
- * Returns: The list of IDs and names.
+ * Returns: (element-type utf8) (transfer container): The list of IDs and names.
  */
 GList *
 purple_keyring_get_options(void);
--- a/libpurple/log.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/log.h	Tue Sep 26 02:41:52 2017 +0000
@@ -272,7 +272,7 @@
  *
  * Returns a list of all available logs
  *
- * Returns:                    A sorted list of PurpleLogs
+ * Returns: (element-type PurpleLog): A sorted list of logs
  */
 GList *purple_log_get_logs(PurpleLogType type, const char *name, PurpleAccount *account);
 
@@ -292,7 +292,8 @@
  * destroyed. If a PurpleLogSet is removed from the GHashTable, it
  * must be freed with purple_log_set_free().
  *
- * Returns: A GHashTable of all available unique PurpleLogSets
+ * Returns: (element-type PurpleLogSet PurpleLogSet): All available unique log
+ *          sets.
  */
 GHashTable *purple_log_get_log_sets(void);
 
@@ -302,7 +303,7 @@
  *
  * Returns a list of all available system logs
  *
- * Returns:        A sorted list of PurpleLogs
+ * Returns: (element-type PurpleLog): A sorted list of logs
  */
 GList *purple_log_get_system_logs(PurpleAccount *account);
 
@@ -440,7 +441,7 @@
  * @ext:      The file extension this log format uses.
  * @logger:   A reference to the logger struct for this log.
  *
- * Returns a sorted GList of PurpleLogs of the requested type.
+ * Returns a sorted list of logs of the requested type.
  *
  * This function should only be used with logs that are written
  * with purple_log_common_writer().  It's intended to be used as
@@ -448,7 +449,7 @@
  * It should only be passed to purple_log_logger_new() and never
  * called directly.
  *
- * Returns: A sorted GList of PurpleLogs matching the parameters.
+ * Returns: (element-type PurpleLog): A sorted list of logs matching the parameters.
  */
 GList *purple_log_common_lister(PurpleLogType type, const char *name,
 							  PurpleAccount *account, const char *ext,
@@ -604,7 +605,7 @@
  * Returns a GList containing the IDs and names of the registered
  * loggers.
  *
- * Returns: The list of IDs and names.
+ * Returns: (element-type utf8) (transfer container): The list of IDs and names.
  */
 GList *purple_log_logger_get_options(void);
 
--- a/libpurple/media.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/media.h	Tue Sep 26 02:41:52 2017 +0000
@@ -100,7 +100,7 @@
  *
  * Gets a list of session IDs.
  *
- * Returns: GList of session IDs. The caller must free the list.
+ * Returns: (element-type utf8) (transfer container): List of session IDs.
  */
 GList *purple_media_get_session_ids(PurpleMedia *media);
 
@@ -262,7 +262,7 @@
  *
  * Gets the codecs from a session.
  *
- * Returns: The retreieved codecs.
+ * Returns: (element-type PurpleMediaCodec): The retrieved codecs.
  */
 GList *purple_media_get_codecs(PurpleMedia *media, const gchar *sess_id);
 
@@ -271,7 +271,8 @@
  * @media: The media object to find the session in.
  * @sess_id: The session id of the session find the stream in.
  * @participant: The name of the remote user to add the candidates for.
- * @remote_candidates: The remote candidates to add.
+ * @remote_candidates: (element-type PurpleMediaCandidate) (transfer none): The
+ *                     remote candidates to add.
  *
  * Adds remote candidates to the stream.
  */
@@ -287,6 +288,8 @@
  * @participant: The name of the remote user to get the candidates from.
  *
  * Gets the local candidates from a stream.
+ *
+ * Returns: (element-type PurpleMediaCandidate): The local candidates.
  */
 GList *purple_media_get_local_candidates(PurpleMedia *media,
 					 const gchar *sess_id,
@@ -301,7 +304,8 @@
  *
  * Gets the active local candidates for the stream.
  *
- * Returns: The active candidates retrieved.
+ * Returns: (element-type PurpleMediaCandidate): The active
+ *          candidates retrieved.
  */
 GList *purple_media_get_active_local_candidates(PurpleMedia *media,
 		const gchar *sess_id, const gchar *participant);
@@ -315,7 +319,8 @@
  *
  * Gets the active remote candidates for the stream.
  *
- * Returns: The remote candidates retrieved.
+ * Returns: (element-type PurpleMediaCandidate): The remote
+ *          candidates retrieved.
  */
 GList *purple_media_get_active_remote_candidates(PurpleMedia *media,
 		const gchar *sess_id, const gchar *participant);
@@ -325,7 +330,8 @@
  * @media: The media object to find the session in.
  * @sess_id: The session id of the session find the stream in.
  * @participant: The name of the remote user to set the codecs for.
- * @codecs: The list of remote codecs to set.
+ * @codecs: (element-type PurpleMediaCodec) (transfer none): The list of remote
+ *          codecs to set.
  *
  * Sets remote codecs from the stream.
  *
--- a/libpurple/media/candidate.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/media/candidate.h	Tue Sep 26 02:41:52 2017 +0000
@@ -90,17 +90,19 @@
 
 /**
  * purple_media_candidate_list_copy:
- * @candidates: The list of candidates to be copied.
+ * @candidates: (element-type PurpleMediaCandidate) (transfer none): The list
+ *              of candidates to be copied.
  *
  * Copies a GList of PurpleMediaCandidate and its contents.
  *
- * Returns: The copy of the GList.
+ * Returns: (element-type PurpleMediaCandidate): The copy of the GList.
  */
 GList *purple_media_candidate_list_copy(GList *candidates);
 
 /**
  * purple_media_candidate_list_free:
- * @candidates: The list of candidates to be freed.
+ * @candidates: (element-type PurpleMediaCandidate) (transfer full): The list
+ *              of candidates to be freed.
  *
  * Frees a GList of PurpleMediaCandidate and its contents.
  */
--- a/libpurple/media/codec.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/media/codec.h	Tue Sep 26 02:41:52 2017 +0000
@@ -120,10 +120,8 @@
  *
  * Gets a list of the optional parameters.
  *
- * The list consists of PurpleKeyValuePair's.
- *
- * Returns: The list of optional parameters. The list is owned by the codec and
- *         should not be freed.
+ * Returns: (element-type PurpleKeyValuePair) (transfer none): The list of
+ *          optional parameters.
  */
 GList *purple_media_codec_get_optional_parameters(PurpleMediaCodec *codec);
 
@@ -174,17 +172,19 @@
 
 /**
  * purple_media_codec_list_copy:
- * @codecs: The list of codecs to be copied.
+ * @codecs: (element-type PurpleMediaCodec) (transfer none): The list of codecs
+ *          to be copied.
  *
  * Copies a GList of PurpleMediaCodec and its contents.
  *
- * Returns: The copy of the GList.
+ * Returns: (element-type PurpleMediaCodec): The copy of the GList.
  */
 GList *purple_media_codec_list_copy(GList *codecs);
 
 /**
  * purple_media_codec_list_free:
- * @codecs: The list of codecs to be freed.
+ * @codecs: (element-type PurpleMediaCodec) (transfer full): The list of codecs
+ *          to be freed.
  *
  * Frees a GList of PurpleMediaCodec and its contents.
  */
--- a/libpurple/mime.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/mime.h	Tue Sep 26 02:41:52 2017 +0000
@@ -102,8 +102,8 @@
  *
  * The list of fields in the header of a document
  *
- * Returns: (transfer none): A list of strings indicating the fields (but not
- *          the values of the fields) in the header of doc.
+ * Returns: (element-type utf8) (transfer none): A list of strings indicating
+ *          the fields (but not the values of the fields) in the header of doc.
  */
 GList *purple_mime_document_get_fields(PurpleMimeDocument *doc);
 
@@ -140,7 +140,8 @@
  *
  * The list of parts in a multipart document.
  *
- * Returns: (transfer none):   List of PurpleMimePart contained within doc.
+ * Returns: (element-type PurpleMimePart) (transfer none): List of MIME parts
+ *          contained within doc.
  */
 GList *purple_mime_document_get_parts(PurpleMimeDocument *doc);
 
@@ -159,8 +160,8 @@
  *
  * The list of fields in the header of a document part.
  *
- * Returns: (transfer none): List of strings indicating the fields (but not the
- *          values of the fields) in the header of part.
+ * Returns: (element-type utf8) (transfer none): List of strings indicating the
+ *          fields (but not the values of the fields) in the header of part.
  */
 GList *purple_mime_part_get_fields(PurpleMimePart *part);
 
--- a/libpurple/network.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/network.h	Tue Sep 26 02:41:52 2017 +0000
@@ -87,7 +87,7 @@
  * Note: The caller must free this list.  If libpurple was built with
  *       support for it, this function also enumerates IPv6 addresses.
  *
- * Returns: A list of local IP addresses.
+ * Returns: (element-type utf8): A list of local IP addresses.
  */
 GList *purple_network_get_all_local_system_ips(void);
 
--- a/libpurple/notify.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/notify.h	Tue Sep 26 02:41:52 2017 +0000
@@ -371,7 +371,7 @@
 /**
  * purple_notify_searchresults_row_add:
  * @results: The search results object.
- * @row:     The row of the results.
+ * @row: (element-type utf8) (transfer full): The row of the results.
  *
  * Adds a new row of the results to the search results object.
  */
--- a/libpurple/pluginpref.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/pluginpref.h	Tue Sep 26 02:41:52 2017 +0000
@@ -100,7 +100,7 @@
  *
  * Get the plugin preferences from a plugin preference frame
  *
- * Returns: (transfer none): a GList of plugin preferences
+ * Returns: (element-type PurplePluginPref) (transfer none): a list of plugin preferences
  */
 GList *purple_plugin_pref_frame_get_prefs(PurplePluginPrefFrame *frame);
 
--- a/libpurple/pounce.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/pounce.h	Tue Sep 26 02:41:52 2017 +0000
@@ -358,7 +358,7 @@
  *
  * Returns a list of all registered buddy pounces.
  *
- * Returns: (transfer none): The list of buddy pounces.
+ * Returns: (element-type PurplePounce) (transfer none): The list of buddy pounces.
  */
 GList *purple_pounces_get_all(void);
 
@@ -368,8 +368,7 @@
  *
  * Returns a list of registered buddy pounces for the ui-type.
  *
- * Returns: The list of buddy pounces. The list should be freed by
- *         the caller when it's no longer used.
+ * Returns: (element-type PurplePounce) (transfer container): The list of buddy pounces.
  */
 GList *purple_pounces_get_all_for_ui(const char *ui);
 
--- a/libpurple/prefs.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/prefs.h	Tue Sep 26 02:41:52 2017 +0000
@@ -250,7 +250,7 @@
 /**
  * purple_prefs_add_string_list:
  * @name:  The name of the pref
- * @value: The initial value to set
+ * @value: (element-type utf8) (transfer none): The initial value to set
  *
  * Add a new string list pref.
  *
@@ -272,7 +272,7 @@
 /**
  * purple_prefs_add_path_list:
  * @name:  The name of the pref
- * @value: The initial value to set
+ * @value: (element-type utf8) (transfer none): The initial value to set
  *
  * Add a new path list pref.
  *
@@ -346,7 +346,7 @@
 /**
  * purple_prefs_set_string_list:
  * @name:  The name of the pref
- * @value: The value to set
+ * @value: (element-type utf8) (transfer none): The value to set
  *
  * Set string list pref value
  */
@@ -364,7 +364,7 @@
 /**
  * purple_prefs_set_path_list:
  * @name:  The name of the pref
- * @value: The value to set
+ * @value: (element-type utf8) (transfer none): The value to set
  *
  * Set path list pref value
  */
@@ -427,7 +427,7 @@
  *
  * Get string list pref value
  *
- * Returns: The value of the pref
+ * Returns: (element-type utf8): The value of the pref
  */
 GList *purple_prefs_get_string_list(const char *name);
 
@@ -447,7 +447,7 @@
  *
  * Get path list pref value
  *
- * Returns: The value of the pref
+ * Returns: (element-type utf8): The value of the pref
  */
 GList *purple_prefs_get_path_list(const char *name);
 
@@ -457,9 +457,9 @@
  *
  * Returns a list of children for a pref
  *
- * Returns: A list of newly allocated strings denoting the names of the children.
- *         Returns %NULL if there are no children or if pref doesn't exist.
- *         The caller must free all the strings and the list.
+ * Returns: (element-type utf8): A list of newly allocated strings denoting the
+ *          names of the children. Returns %NULL if there are no children or if
+ *          pref doesn't exist. The caller must free all the strings and the list.
  */
 GList *purple_prefs_get_children_names(const char *name);
 
--- a/libpurple/presence.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/presence.h	Tue Sep 26 02:41:52 2017 +0000
@@ -302,7 +302,7 @@
  *
  * Returns all the statuses in a presence.
  *
- * Returns: (transfer none): The statuses.
+ * Returns: (element-type PurpleStatus) (transfer none): The statuses.
  */
 GList *purple_presence_get_statuses(const PurplePresence *presence);
 
--- a/libpurple/protocols.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/protocols.h	Tue Sep 26 02:41:52 2017 +0000
@@ -466,7 +466,7 @@
  *
  * Retrieves the list of stock status types from a protocol.
  *
- * Returns: List of statuses
+ * Returns: (element-type PurpleStatus): List of statuses
  */
 GList *purple_protocol_get_statuses(PurpleAccount *account,
                                     PurplePresence *presence);
@@ -608,8 +608,8 @@
  *
  * Returns a list of all loaded protocols.
  *
- * Returns: A list of all loaded protocols. The list is owned by the caller, and
- *         must be g_list_free()d to avoid leaking the nodes.
+ * Returns: (element-type PurpleProtocol) (transfer container): A list of all
+ *          loaded protocols.
  */
 GList *purple_protocols_get_all(void);
 
--- a/libpurple/request-datasheet.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/request-datasheet.h	Tue Sep 26 02:41:52 2017 +0000
@@ -129,7 +129,7 @@
  *
  * You shouldn't modify datasheet's data while iterating through it.
  *
- * Returns: (transfer none): The list of records.
+ * Returns: (element-type PurpleRequestDatasheetRecord) (transfer none): The list of records.
  */
 const GList *
 purple_request_datasheet_get_records(PurpleRequestDatasheet *sheet);
@@ -153,7 +153,7 @@
  *
  * Returns the list of actions in a datasheet.
  *
- * Returns: (transfer none): The list of actions.
+ * Returns: (element-type PurpleRequestDatasheetAction) (transfer none): The list of actions.
  */
 const GList *
 purple_request_datasheet_get_actions(PurpleRequestDatasheet *sheet);
--- a/libpurple/request.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/request.h	Tue Sep 26 02:41:52 2017 +0000
@@ -543,7 +543,7 @@
  *
  * Returns a list of all groups in a field list.
  *
- * Returns: (transfer none): A list of groups.
+ * Returns: (element-type PurpleRequestFieldGroup) (transfer none): A list of groups.
  */
 GList *purple_request_fields_get_groups(const PurpleRequestFields *fields);
 
@@ -588,7 +588,7 @@
  *
  * Returns a list of all required fields.
  *
- * Returns: (transfer none): The list of required fields.
+ * Returns: (element-type PurpleRequestField) (transfer none): The list of required fields.
  */
 const GList *purple_request_fields_get_required(
 	const PurpleRequestFields *fields);
@@ -599,7 +599,7 @@
  *
  * Returns a list of all validated fields.
  *
- * Returns: (transfer none): The list of validated fields.
+ * Returns: (element-type PurpleRequestField) (transfer none): The list of validated fields.
  */
 const GList *purple_request_fields_get_validatable(
 	const PurpleRequestFields *fields);
@@ -610,8 +610,8 @@
  *
  * Returns a list of all fields with sensitivity callback added.
  *
- * Returns: (transfer none): The list of fields with automatic sensitivity
- *          callback.
+ * Returns: (element-type PurpleRequestField) (transfer none): The list of
+ *          fields with automatic sensitivity callback.
  */
 const GList *
 purple_request_fields_get_autosensitive(const PurpleRequestFields *fields);
@@ -816,7 +816,7 @@
  *
  * Returns a list of all fields in a group.
  *
- * Returns: (transfer none): The list of fields in the group.
+ * Returns: (element-type PurpleRequestField) (transfer none): The list of fields in the group.
  */
 GList *purple_request_field_group_get_fields(
 		const PurpleRequestFieldGroup *group);
@@ -1521,7 +1521,7 @@
 /**
  * purple_request_field_list_set_selected:
  * @field: The field.
- * @items: The list of selected items, which is not modified or freed.
+ * @items: (element-type utf8) (transfer none): The list of selected items.
  *
  * Sets a list of selected items in a list field.
  */
@@ -1549,7 +1549,7 @@
  * To retrieve the data for each item, use
  * purple_request_field_list_get_data().
  *
- * Returns: (transfer none): The list of selected items.
+ * Returns: (element-type utf8) (transfer none): The list of selected items.
  */
 GList *purple_request_field_list_get_selected(
 	const PurpleRequestField *field);
@@ -1560,7 +1560,7 @@
  *
  * Returns a list of items in a list field.
  *
- * Returns: (transfer none): The list of items.
+ * Returns: (element-type utf8) (transfer none): The list of items.
  */
 GList *purple_request_field_list_get_items(const PurpleRequestField *field);
 
@@ -1572,7 +1572,7 @@
  *
  * The icons will correspond with the items, in order.
  *
- * Returns: (transfer none): The list of icons or %NULL (i.e. the empty #GList)
+ * Returns: (element-type utf8) (transfer none): The list of icons or %NULL (i.e. the empty #GList)
  *          if no items have icons.
  */
 GList *purple_request_field_list_get_icons(const PurpleRequestField *field);
--- a/libpurple/roomlist.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/roomlist.h	Tue Sep 26 02:41:52 2017 +0000
@@ -193,8 +193,8 @@
 /**
  * purple_roomlist_set_fields:
  * @list: The room list.
- * @fields: A GList of PurpleRoomlistField's. UI's are encouraged
- *               to default to displaying them in the order given.
+ * @fields: (element-type PurpleRoomlistField) (transfer full): UI's are
+ *          encouraged to default to displaying these fields in the order given.
  *
  * Set the different field types and their names for this protocol.
  *
@@ -280,7 +280,7 @@
  *
  * Get the list of fields for a roomlist.
  *
- * Returns: (transfer none): A list of fields
+ * Returns: (element-type PurpleRoomlistField) (transfer none): A list of fields
  */
 GList *purple_roomlist_get_fields(PurpleRoomlist *roomlist);
 
@@ -424,7 +424,7 @@
  *
  * Get the list of fields for a room.
  *
- * Returns: (transfer none): A list of fields
+ * Returns: (element-type PurpleRoomlistField) (transfer none): A list of fields
  */
 GList * purple_roomlist_room_get_fields(PurpleRoomlistRoom *room);
 
--- a/libpurple/savedstatuses.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/savedstatuses.h	Tue Sep 26 02:41:52 2017 +0000
@@ -184,7 +184,7 @@
  *
  * Returns all saved statuses.
  *
- * Returns: (transfer none): A list of saved statuses.
+ * Returns: (element-type PurpleSavedStatus) (transfer none): A list of saved statuses.
  */
 GList *purple_savedstatuses_get_all(void);
 
@@ -199,10 +199,8 @@
  * how many times it has been used. Transient statuses without
  * messages are not included in the list.
  *
- * Returns: A linked list containing at most how_many
- *         PurpleSavedStatuses.  This list should be
- *         g_list_free'd by the caller (but the
- *         PurpleSavedStatuses must not be free'd).
+ * Returns: (element-type PurpleSavedStatus) (transfer container): A list containing
+ *         at most how_many saved statuses.
  */
 GList *purple_savedstatuses_get_popular(unsigned int how_many);
 
--- a/libpurple/smiley-list.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/smiley-list.h	Tue Sep 26 02:41:52 2017 +0000
@@ -156,8 +156,7 @@
  *
  * Returns the list of smileys with unique image file paths.
  *
- * Returns: (transfer container): the #GList of unique smileys. Use #g_list_free
- *          when done using it.
+ * Returns: (element-type PurpleSmiley) (transfer container): the list of unique smileys.
  */
 GList *purple_smiley_list_get_unique(PurpleSmileyList *list_);
 
@@ -167,8 +166,7 @@
  *
  * Returns the list of all smileys added to the @list_.
  *
- * Returns: (transfer container): the #GList of smileys. Use #g_list_free
- *          when done using it.
+ * Returns: (element-type PurpleSmiley) (transfer container): the list of smileys.
  */
 GList *purple_smiley_list_get_all(PurpleSmileyList *list_);
 
--- a/libpurple/smiley-parser.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/smiley-parser.h	Tue Sep 26 02:41:52 2017 +0000
@@ -112,8 +112,7 @@
  * text. However, distinct smileys may share common image file (thus, their
  * paths will be the same).
  *
- * Returns: (transfer container): the #GList of found smileys. Use #g_list_free
- *          when no longer need it.
+ * Returns: (element-type PurpleSmiley) (transfer container): the list of found smileys.
  */
 GList *
 purple_smiley_parser_find(PurpleSmileyList *smileys, const gchar *message,
--- a/libpurple/sslconn.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/sslconn.h	Tue Sep 26 02:41:52 2017 +0000
@@ -238,8 +238,9 @@
  *
  * Obtains the peer's presented certificates
  *
- * Returns: The peer certificate chain, in the order of certificate, issuer,
- *         issuer's issuer, etc. %NULL if no certificates have been provided,
+ * Returns: (element-type GTlsCertificate): The peer certificate chain, in the
+ *          order of certificate, issuer, issuer's issuer, etc. %NULL if no
+ *          certificates have been provided.
  */
 GList * purple_ssl_get_peer_certificates(PurpleSslConnection *gsc);
 
--- a/libpurple/status.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/status.h	Tue Sep 26 02:41:52 2017 +0000
@@ -408,13 +408,14 @@
  *
  * Returns a list of all attributes in a status type.
  *
- * Returns: (transfer none): The list of attributes.
+ * Returns: (element-type PurpleStatusAttribute) (transfer none): The list of attributes.
  */
 GList *purple_status_type_get_attrs(const PurpleStatusType *status_type);
 
 /**
  * purple_status_type_find_with_id:
- * @status_types: A list of status types.  Often account->status_types.
+ * @status_types: (element-type PurpleStatus) (transfer none): A list of status
+ *                types.  Often account->status_types.
  * @id: The unique ID of the status type you wish to find.
  *
  * Find the PurpleStatusType with the given id.
--- a/libpurple/util.h	Fri Sep 22 03:44:07 2017 +0000
+++ b/libpurple/util.h	Tue Sep 26 02:41:52 2017 +0000
@@ -78,8 +78,8 @@
  * @callback: The function to be called when the action is used on
  *                 the selected item.
  * @data:     Additional data to be passed to the callback.
- * @children: A GList of PurpleMenuActions to be added as a submenu
- *                 of the action.
+ * @children: (element-type PurpleMenuAction) (transfer full): Menu actions to
+ *            be added as a submenu of this action.
  *
  * Creates a new PurpleMenuAction.
  *
@@ -132,7 +132,7 @@
  *
  * Returns the children of the PurpleMenuAction.
  *
- * Returns: The  GList of children.
+ * Returns: (element-type PurpleMenuAction) (transfer none): The menu children.
  */
 GList* purple_menu_action_get_children(const PurpleMenuAction *act);
 
@@ -166,7 +166,7 @@
 /**
  * purple_menu_action_set_children:
  * @act:       The menu action.
- * @children:  The PurpleMenuAtion children
+ * @children: (element-type PurpleMenuAction) (transfer full): The menu children
  *
  * Set the children of the PurpleMenuAction.
  */
@@ -1309,8 +1309,8 @@
  * This function extracts a list of URIs from the a "text/uri-list"
  * string.  It was "borrowed" from gnome_uri_list_extract_uris
  *
- * Returns: A GList containing strings allocated with g_malloc
- *         that have been splitted from uri-list.
+ * Returns: (element-type utf8): A GList containing strings allocated with
+ *          g_malloc that have been split from uri-list.
  */
 GList *purple_uri_list_extract_uris(const gchar *uri_list);
 
@@ -1322,10 +1322,10 @@
  * "text/uri-list" string.  It was "borrowed" from
  * gnome_uri_list_extract_filenames
  *
- * Returns: A GList containing strings allocated with g_malloc that
- *         contain the filenames in the uri-list. Note that unlike
- *         purple_uri_list_extract_uris() function, this will discard
- *         any non-file uri from the result value.
+ * Returns: (element-type utf8): A GList containing strings allocated with
+ *          g_malloc that contain the filenames in the uri-list. Note that
+ *          unlike the purple_uri_list_extract_uris() function, this will
+ *          discard any non-file uri from the result value.
  */
 GList *purple_uri_list_extract_filenames(const gchar *uri_list);
 

mercurial