pidgin/pidgin

Fix various small documentation errors

18 months ago, Elliott Sales de Andrade
316c1207f787
Parents 3a7d151716fe
Children abf413211063
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/
--- a/libpurple/account.h Wed Sep 28 05:44:45 2022 -0500
+++ b/libpurple/account.h Wed Sep 28 19:32:50 2022 -0500
@@ -361,17 +361,25 @@
/**
* 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 @@
/**
* 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. All changes to the statuses of
- * an account go through this function or purple_account_set_status().
+ * Activates or deactivates a 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 @@
*
* 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 @@
* 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);
--- a/libpurple/buddyicon.h Wed Sep 28 05:44:45 2022 -0500
+++ b/libpurple/buddyicon.h Wed Sep 28 19:32:50 2022 -0500
@@ -155,10 +155,9 @@
/**
* purple_buddy_icon_set_data:
* @icon: The buddy icon.
- * @data: The buddy icon data, which the buddy icon code
- * takes ownership of and will free.
- * @len: The length of the data in @a data.
- * @checksum: A protocol checksum from the protocol or %NULL.
+ * @data: (transfer full): The buddy icon data.
+ * @len: The length of the data in @data.
+ * @checksum: A protocol checksum from the protocol or %NULL.
*
* Sets the buddy icon's data.
*/
@@ -271,12 +270,11 @@
/**
* purple_buddy_icons_set_for_user:
- * @account: The account the user is on.
- * @username: The username of the user.
- * @icon_data: The buddy icon data, which the buddy icon code
- * takes ownership of and will free.
- * @icon_len: The length of the icon data.
- * @checksum: A protocol checksum from the protocol or %NULL.
+ * @account: The account the user is on.
+ * @username: The username of the user.
+ * @icon_data: (transfer full): The buddy icon data.
+ * @icon_len: The length of the icon data.
+ * @checksum: A protocol checksum from the protocol or %NULL.
*
* Sets a buddy icon for a user.
*/
--- a/libpurple/idle.h Wed Sep 28 05:44:45 2022 -0500
+++ b/libpurple/idle.h Wed Sep 28 19:32:50 2022 -0500
@@ -61,10 +61,9 @@
/**
* purple_idle_set_ui:
- * @ui: An instance of [iface@IdleUi].
+ * @ui: (transfer full): An instance of [iface@IdleUi].
*
- * Sets the user interface idle reporter. This function assumes ownership of
- * @ui.
+ * Sets the user interface idle reporter.
*
* Since: 3.0.0
*/
--- a/libpurple/proxy.h Wed Sep 28 05:44:45 2022 -0500
+++ b/libpurple/proxy.h Wed Sep 28 19:32:50 2022 -0500
@@ -44,7 +44,7 @@
*
* Returns purple's global proxy information.
*
- * Returns: The global proxy information.
+ * Returns: (transfer none): The global proxy information.
*/
PurpleProxyInfo *purple_global_proxy_get_info(void);
@@ -89,7 +89,7 @@
*
* Returns configuration of a proxy.
*
- * Returns: The configuration of a proxy.
+ * Returns: (transfer none): The configuration of a proxy.
*/
PurpleProxyInfo *purple_proxy_get_setup(PurpleAccount *account);
--- a/libpurple/purpleaccountoption.h Wed Sep 28 05:44:45 2022 -0500
+++ b/libpurple/purpleaccountoption.h Wed Sep 28 19:32:50 2022 -0500
@@ -53,10 +53,10 @@
* @text: The text of the option.
* @pref_name: The account preference name for the option.
*
- * Creates a new account option. If you know what @a type will be in advance,
- * consider using purple_account_option_bool_new(),
- * purple_account_option_int_new(), purple_account_option_string_new() or
- * purple_account_option_list_new() (as appropriate) instead.
+ * Creates a new account option. If you know what @type will be in advance,
+ * consider using [ctor@Purple.AccountOption.bool_new],
+ * [ctor@Purple.AccountOption.int_new], [ctor@Purple.AccountOption.string_new]
+ * or [ctor@Purple.AccountOption.list_new] (as appropriate) instead.
*
* Returns: The account option.
*/
@@ -238,8 +238,8 @@
* purple_account_option_get_setting:
* @option: The account option.
*
- * Returns the name of an account option. This corresponds to the @c pref_name
- * parameter supplied to purple_account_option_new() or one of the
+ * Returns the name of an account option. This corresponds to the %pref_name
+ * parameter supplied to [ctor@Purple.AccountOption.new] or one of the
* type-specific constructors.
*
* Returns: The option's name.
--- a/libpurple/purplecontact.h Wed Sep 28 05:44:45 2022 -0500
+++ b/libpurple/purplecontact.h Wed Sep 28 19:32:50 2022 -0500
@@ -191,8 +191,8 @@
*
* Gets the [class@Purple.Presence] for @contact.
*
- * Returns: (nullable): The presence for @contact if one is set, otherwise
- * %NULL.
+ * Returns: (transfer none) (nullable): The presence for @contact if one is
+ * set, otherwise %NULL.
*
* Since: 3.0.0
*/
--- a/libpurple/purpleprotocolwhiteboard.h Wed Sep 28 05:44:45 2022 -0500
+++ b/libpurple/purpleprotocolwhiteboard.h Wed Sep 28 19:32:50 2022 -0500
@@ -82,7 +82,7 @@
*
* Since: 3.0.0
*/
-PurpleWhiteboard *purple_protocol_whiteboard_create(PurpleProtocolWhiteboard *actions, PurpleAccount *account, const gchar *who, gint state);
+PurpleWhiteboard *purple_protocol_whiteboard_create(PurpleProtocolWhiteboard *whiteboard, PurpleAccount *account, const gchar *who, gint state);
G_END_DECLS