/soc/2013/ankitkv/gobjectification: c391f5d677e4: Merge gtkdoc-c...

Ankit Vani a at nevitus.org
Fri Jan 31 08:17:04 EST 2014


Changeset: c391f5d677e486789174f9c4e4c153507677fe57
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-01-31 18:46 +0530
Branch:	 soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/c391f5d677e4

Description:

Merge gtkdoc-conversion

diffstat:

 libpurple/account.h           |   8 ++++----
 libpurple/accountopt.h        |   4 ++--
 libpurple/accounts.h          |   2 +-
 libpurple/blistnodetypes.h    |   2 +-
 libpurple/connection.h        |   4 ++--
 libpurple/conversations.h     |   6 +++---
 libpurple/conversationtypes.h |   4 ++--
 libpurple/mime.h              |  22 +++++++++++-----------
 libpurple/nat-pmp.h           |   4 ++--
 libpurple/network.h           |   2 +-
 libpurple/notify.h            |   2 +-
 libpurple/pluginpref.h        |   4 ++--
 libpurple/pounce.h            |   2 +-
 libpurple/presence.h          |   2 +-
 libpurple/request-datasheet.h |   4 ++--
 libpurple/request.h           |  24 ++++++++++++------------
 libpurple/roomlist.h          |   4 ++--
 libpurple/savedstatuses.h     |   2 +-
 libpurple/sound-theme.h       |   4 ++--
 libpurple/status.h            |   2 +-
 libpurple/theme-loader.h      |   6 +++---
 libpurple/theme-manager.h     |   2 +-
 libpurple/util.h              |   2 +-
 libpurple/xfer.h              |   2 +-
 pidgin/gtkblist-theme.h       |  32 ++++++++++++++++----------------
 pidgin/gtkblist.h             |   2 +-
 pidgin/gtkicon-theme.h        |   2 +-
 pidgin/gtksmiley.h            |   2 +-
 28 files changed, 79 insertions(+), 79 deletions(-)

diffs (truncated from 778 to 300 lines):

diff --git a/libpurple/account.h b/libpurple/account.h
--- a/libpurple/account.h
+++ b/libpurple/account.h
@@ -858,7 +858,7 @@ void purple_account_privacy_deny(PurpleA
  * Returns the account's permit list.
  *
  * @account:	The account.
- * Returns: (TODO const):     A list of the permitted users
+ * Returns: (transfer none):     A list of the permitted users
  */
 GSList *purple_account_privacy_get_permitted(PurpleAccount *account);
 
@@ -866,7 +866,7 @@ GSList *purple_account_privacy_get_permi
  * Returns the account's deny list.
  *
  * @account:	The account.
- * Returns: (TODO const):     A list of the denied users
+ * Returns: (transfer none):     A list of the denied users
  */
 GSList *purple_account_privacy_get_denied(PurpleAccount *account);
 
@@ -959,7 +959,7 @@ gboolean purple_account_is_status_active
  *
  * @account: The account.
  *
- * Returns: (TODO const): The account's status types.
+ * Returns: (transfer none): The account's status types.
  */
 GList *purple_account_get_status_types(const PurpleAccount *account);
 
@@ -1136,7 +1136,7 @@ gboolean purple_account_supports_offline
  * account is happily connected or disconnected without an error.
  *
  * @account: The account whose error should be retrieved.
- * Returns: (TODO const):   The type of error and a human-readable description of the
+ * Returns: (transfer none):   The type of error and a human-readable description of the
  *                current error, or %NULL if there is no current error.  This
  *                pointer is guaranteed to remain valid until the @ref
  *                account-error-changed signal is emitted for @a account.
diff --git a/libpurple/accountopt.h b/libpurple/accountopt.h
--- a/libpurple/accountopt.h
+++ b/libpurple/accountopt.h
@@ -280,7 +280,7 @@ purple_account_option_string_get_masked(
  *
  * @option: The account option.
  *
- * Returns: (TODO const): A list of hints, stored as strings.
+ * Returns: (transfer none): A list of hints, stored as strings.
  */
 const GSList * purple_account_option_string_get_hints(const PurpleAccountOption *option);
 
@@ -289,7 +289,7 @@ const GSList * purple_account_option_str
  *
  * @option: The account option.
  *
- * Returns: (TODO const): A list of #PurpleKeyValuePair, mapping the human-readable
+ * Returns: (transfer none): A list of #PurpleKeyValuePair, mapping the human-readable
  *              description of the value to the <tt>(const char *)</tt> that
  *              should be passed to purple_account_set_string() to set the
  *              option.
diff --git a/libpurple/accounts.h b/libpurple/accounts.h
--- a/libpurple/accounts.h
+++ b/libpurple/accounts.h
@@ -134,7 +134,7 @@ void purple_accounts_reorder(PurpleAccou
 /**
  * Returns a list of all accounts.
  *
- * Returns: (TODO const): A list of all accounts.
+ * Returns: (transfer none): A list of all accounts.
  */
 GList *purple_accounts_get_all(void);
 
diff --git a/libpurple/blistnodetypes.h b/libpurple/blistnodetypes.h
--- a/libpurple/blistnodetypes.h
+++ b/libpurple/blistnodetypes.h
@@ -540,7 +540,7 @@ PurpleAccount *purple_chat_get_account(P
  *
  * @chat:  The chat.
  *
- * Returns: (TODO const):  The hashtable.
+ * Returns: (transfer none):  The hashtable.
  */
 GHashTable *purple_chat_get_components(PurpleChat *chat);
 
diff --git a/libpurple/connection.h b/libpurple/connection.h
--- a/libpurple/connection.h
+++ b/libpurple/connection.h
@@ -484,14 +484,14 @@ void purple_connections_disconnect_all(v
  * Returns a list of all active connections.  This does not
  * include connections that are in the process of connecting.
  *
- * Returns: (TODO const): A list of all active connections.
+ * Returns: (transfer none): A list of all active connections.
  */
 GList *purple_connections_get_all(void);
 
 /**
  * Returns a list of all connections in the process of connecting.
  *
- * Returns: (TODO const): A list of connecting connections.
+ * Returns: (transfer none): A list of connecting connections.
  */
 GList *purple_connections_get_connecting(void);
 
diff --git a/libpurple/conversations.h b/libpurple/conversations.h
--- a/libpurple/conversations.h
+++ b/libpurple/conversations.h
@@ -56,21 +56,21 @@ void purple_conversations_remove(PurpleC
  *
  * This list includes both IMs and chats.
  *
- * Returns: (TODO const): A GList of all conversations.
+ * Returns: (transfer none): A GList of all conversations.
  */
 GList *purple_conversations_get_all(void);
 
 /**
  * Returns a list of all IMs.
  *
- * Returns: (TODO const): A GList of all IMs.
+ * Returns: (transfer none): A GList of all IMs.
  */
 GList *purple_conversations_get_ims(void);
 
 /**
  * Returns a list of all chats.
  *
- * Returns: (TODO const): A GList of all chats.
+ * Returns: (transfer none): A GList of all chats.
  */
 GList *purple_conversations_get_chats(void);
 
diff --git a/libpurple/conversationtypes.h b/libpurple/conversationtypes.h
--- a/libpurple/conversationtypes.h
+++ b/libpurple/conversationtypes.h
@@ -330,7 +330,7 @@ PurpleChatConversation *purple_chat_conv
  *
  * @chat: The chat.
  *
- * Returns: (TODO const): The list of users.
+ * Returns: (transfer none): The list of users.
  */
 GList *purple_chat_conversation_get_users(const PurpleChatConversation *chat);
 
@@ -365,7 +365,7 @@ GList *purple_chat_conversation_set_igno
  *
  * @chat: The chat.
  *
- * Returns: (TODO const): The list of ignored users.
+ * Returns: (transfer none): The list of ignored users.
  */
 GList *purple_chat_conversation_get_ignored(const PurpleChatConversation *chat);
 
diff --git a/libpurple/mime.h b/libpurple/mime.h
--- a/libpurple/mime.h
+++ b/libpurple/mime.h
@@ -63,7 +63,7 @@ void purple_mime_document_free(PurpleMim
  *
  * @buf: The NULL-terminated string containing the MIME-encoded data.
  *
- * Returns:s A MIME document.
+ * Returns: A MIME document.
  */
 PurpleMimeDocument *purple_mime_document_parse(const char *buf);
 
@@ -73,7 +73,7 @@ PurpleMimeDocument *purple_mime_document
  * @buf: The string containing the MIME-encoded data.
  * @len: Length of buf.
  *
- * Returns:s   A MIME document.
+ * Returns:   A MIME document.
  */
 PurpleMimeDocument *purple_mime_document_parsen(const char *buf, gsize len);
 
@@ -87,8 +87,8 @@ void purple_mime_document_write(PurpleMi
  *
  * @doc: The MIME document.
  *
- * Returns: (TODO const): A list of strings indicating the fields (but not the values
- *              of the fields) in the header of doc.
+ * Returns: (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);
 
@@ -98,7 +98,7 @@ GList *purple_mime_document_get_fields(P
  * @doc:   The MIME document.
  * @field: Case-insensitive field name.
  *
- * Returns:s     Value associated with the indicated header field, or
+ * Returns:     Value associated with the indicated header field, or
  *              NULL if the field doesn't exist.
  */
 const char *purple_mime_document_get_field(PurpleMimeDocument *doc,
@@ -122,7 +122,7 @@ void purple_mime_document_set_field(Purp
  *
  * @doc: The MIME document.
  *
- * Returns: (TODO const):   List of PurpleMimePart contained within doc.
+ * Returns: (transfer none):   List of PurpleMimePart contained within doc.
  */
 GList *purple_mime_document_get_parts(PurpleMimeDocument *doc);
 
@@ -139,8 +139,8 @@ PurpleMimePart *purple_mime_part_new(Pur
  *
  * @part: The MIME document part.
  *
- * Returns: (TODO const): List of strings indicating the fields (but not the values
- *              of the fields) in the header of part.
+ * Returns: (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);
 
@@ -151,7 +151,7 @@ GList *purple_mime_part_get_fields(Purpl
  * @part:  The MIME document part.
  * @field: Case-insensitive name of the header field.
  *
- * Returns:s     Value of the specified header field, or NULL if the
+ * Returns:     Value of the specified header field, or NULL if the
  *              field doesn't exist.
  */
 const char *purple_mime_part_get_field(PurpleMimePart *part,
@@ -182,7 +182,7 @@ void purple_mime_part_set_field(PurpleMi
  *
  * @part: The MIME document part.
  *
- * Returns:s    NULL-terminated data found in the document part
+ * Returns:    NULL-terminated data found in the document part
  */
 const char *purple_mime_part_get_data(PurpleMimePart *part);
 
@@ -203,7 +203,7 @@ void purple_mime_part_get_data_decoded(P
  * Get the length of the data portion of a MIME document part.
  *
  * @part: The MIME document part.
- * Returns:s    Length of the data in the document part.
+ * Returns:    Length of the data in the document part.
  */
 gsize purple_mime_part_get_length(PurpleMimePart *part);
 
diff --git a/libpurple/nat-pmp.h b/libpurple/nat-pmp.h
--- a/libpurple/nat-pmp.h
+++ b/libpurple/nat-pmp.h
@@ -62,7 +62,7 @@ char *purple_pmp_get_public_ip(void);
  * @lifetime:    The lifetime of the mapping. It is recommended that this
  *                    be PURPLE_PMP_LIFETIME.
  *
- * Returns:s TRUE if successful; FALSE if unsuccessful
+ * Returns: TRUE if successful; FALSE if unsuccessful
  */
 gboolean purple_pmp_create_map(PurplePmpType type, unsigned short privateport,
                                unsigned short publicport, int lifetime);
@@ -73,7 +73,7 @@ gboolean purple_pmp_create_map(PurplePmp
  * @type:        The PurplePmpType
  * @privateport: The private port on which the mapping was previously made
  *
- * Returns:s TRUE if successful; FALSE if unsuccessful
+ * Returns: TRUE if successful; FALSE if unsuccessful
  */
 gboolean purple_pmp_destroy_map(PurplePmpType type, unsigned short privateport);
 
diff --git a/libpurple/network.h b/libpurple/network.h
--- a/libpurple/network.h
+++ b/libpurple/network.h
@@ -285,7 +285,7 @@ void purple_network_remove_port_mapping(
  * @in:      The hostname to be converted.
  * @out:     The output buffer where an allocated string will be returned.
  *                The caller is responsible for freeing this.
- * Returns:s       0 on success, -1 if the out is NULL, or an error code
+ * Returns:       0 on success, -1 if the out is NULL, or an error code
  *                that currently corresponds to the Idna_rc enum in libidn.
  */
 int purple_network_convert_idn_to_ascii(const gchar *in, gchar **out);
diff --git a/libpurple/notify.h b/libpurple/notify.h
--- a/libpurple/notify.h
+++ b/libpurple/notify.h
@@ -464,7 +464,7 @@ void purple_notify_user_info_destroy(Pur
  *
  * @user_info:  The PurpleNotifyUserInfo
  *
- * Returns: (TODO const): A GQueue of PurpleNotifyUserInfoEntry objects.
+ * Returns: (transfer none): A GQueue of PurpleNotifyUserInfoEntry objects.
  */
 GQueue *purple_notify_user_info_get_entries(PurpleNotifyUserInfo *user_info);
 
diff --git a/libpurple/pluginpref.h b/libpurple/pluginpref.h
--- a/libpurple/pluginpref.h
+++ b/libpurple/pluginpref.h
@@ -83,7 +83,7 @@ void purple_plugin_pref_frame_add(Purple
  * Get the plugin preferences from a plugin preference frame
  *
  * @frame: The plugin frame to get the plugin preferences from
- * Returns: (TODO const): a GList of plugin preferences
+ * Returns: (transfer none): a GList of plugin preferences
  */
 GList *purple_plugin_pref_frame_get_prefs(PurplePluginPrefFrame *frame);
 
@@ -205,7 +205,7 @@ void purple_plugin_pref_add_choice(Purpl
  * Get the choices for a choices plugin pref



More information about the Commits mailing list