diff options
author | Elliott Sales de Andrade <quantum.analyst@gmail.com> | 2022-09-28 19:32:50 -0500 |
---|---|---|
committer | Elliott Sales de Andrade <quantum.analyst@gmail.com> | 2022-09-28 19:32:50 -0500 |
commit | 7988df1496d5991baf02d908d099a7d18fbaaada (patch) | |
tree | 066c37c8a529c19c4f5f3bd190c3c6955a756ea7 /libpurple/account.h | |
parent | 7d2c125a7432cf2e522c2c3245edd1482ad06e45 (diff) | |
download | pidgin-7988df1496d5991baf02d908d099a7d18fbaaada.tar.gz |
Fix various small documentation errors
Fix missing transfer annotations, remove old syntax from gtk-doc, correct an `element-type` annotation, and fix a typo.
Testing Done:
Compiled with docs on, and got fewer warnings. Also functions with added transfer annotations are no longer unavailable to bindings.
Reviewed at https://reviews.imfreedom.org/r/1855/
Diffstat (limited to 'libpurple/account.h')
-rw-r--r-- | libpurple/account.h | 55 |
1 files changed, 32 insertions, 23 deletions
diff --git a/libpurple/account.h b/libpurple/account.h index a1c644aa69..222604ab68 100644 --- a/libpurple/account.h +++ b/libpurple/account.h @@ -361,17 +361,25 @@ void purple_account_set_status_types(PurpleAccount *account, GList *status_types /** * purple_account_set_status: - * @account: The account. + * @account: The account. * @status_id: The ID of the status. - * @active: Whether @a status_id is to be activated (%TRUE) or - * deactivated (%FALSE). - * @...: A %NULL-terminated list of pairs of <type>const char *</type> - * attribute name followed by <type>const char *</type> attribute - * value for the status. (For example, one pair might be - * <literal>"message"</literal> followed by - * <literal>"hello, talk to me!"</literal>.) + * @active: Whether @status_id is to be activated (%TRUE) or deactivated + * (%FALSE). + * @...: A %NULL-terminated list of pairs of `const char *` attribute name + * followed by `const char *` attribute value for the status. (For + * example, one pair might be `"message"` followed by `"hello, talk to + * me!"`.) + * + * Activates or deactivates a status. * - * Variadic version of purple_account_set_status_attrs(). + * All changes to the statuses of an account go through this function or + * [method@Purple.Account.set_status_attrs]. + * + * You can only deactivate an exclusive status by activating another exclusive + * status. So, if @status_id is an exclusive status and @active is %FALSE, this + * function does nothing. + * + * Variadic version of [method@Purple.Account.set_status_attrs]. */ void purple_account_set_status(PurpleAccount *account, const char *status_id, gboolean active, ...) G_GNUC_NULL_TERMINATED; @@ -379,22 +387,23 @@ void purple_account_set_status(PurpleAccount *account, const char *status_id, /** * purple_account_set_status_attrs: - * @account: The account. + * @account: The account. * @status_id: The ID of the status. - * @active: Whether @a status_id is to be activated (%TRUE) or - * deactivated (%FALSE). - * @attrs: (element-type utf8 gpointer): A hash table of - * <type>const char *</type> attribute names followed by - * <type>gpointer</type> attribute values for the status. - * (For example, one pair might be <literal>"message"</literal> - * followed by <literal>"hello, talk to me!"</literal>.) + * @active: Whether @status_id is to be activated (%TRUE) or deactivated + * (%FALSE). + * @attrs: (element-type utf8 utf8): A hash table with keys of attribute + * names and values of attributes for the status. (For example, one + * pair might be a key of `"message"` with a value of `"hello, talk to + * me!"`.) + * + * Activates or deactivates a status. * - * Activates or deactivates a status. All changes to the statuses of - * an account go through this function or purple_account_set_status(). + * All changes to the statuses of an account go through this function or + * [method@Purple.Account.set_status]. * * You can only deactivate an exclusive status by activating another exclusive - * status. So, if @a status_id is an exclusive status and @a active is @c - * FALSE, this function does nothing. + * status. So, if @status_id is an exclusive status and @active is %FALSE, this + * function does nothing. * * Since: 3.0.0 */ @@ -622,7 +631,7 @@ gboolean purple_account_get_enabled(PurpleAccount *account); * * Returns the account's proxy information. * - * Returns (transfer none): The proxy information. + * Returns: (transfer none): The proxy information. */ PurpleProxyInfo *purple_account_get_proxy_info(PurpleAccount *account); @@ -989,7 +998,7 @@ gboolean purple_account_supports_offline_message(PurpleAccount *account, PurpleB * 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. + * account-error-changed signal is emitted for @account. */ const PurpleConnectionErrorInfo *purple_account_get_current_error(PurpleAccount *account); |