--- a/finch/libgnt/gnttree.h Wed Jan 29 10:10:12 2014 +0530
+++ b/finch/libgnt/gnttree.h Wed Jan 29 10:49:02 2014 +0530
@@ -102,14 +102,14 @@
- * Returns: The GType for GntTree
+ * @return The GType for GntTree GType gnt_tree_get_gtype(void);
* Create a tree with one column.
- * Returns: The newly created tree
+ * @return The newly created tree * @see gnt_tree_new_with_columns
@@ -118,9 +118,9 @@
* Create a tree with a specified number of columns.
- * @columns: Number of columns
+ * @param columns Number of columns - * Returns: The newly created tree
+ * @return The newly created tree @@ -129,25 +129,25 @@
* The number of rows the tree should display at a time.
- * @rows: The number of rows
+ * @param rows The number of rows void gnt_tree_set_visible_rows(GntTree *tree, int rows);
* Get the number visible rows.
- * Returns: The number of visible rows
+ * @return The number of visible rows int gnt_tree_get_visible_rows(GntTree *tree);
* Scroll the contents of the tree.
- * @count: If positive, the tree will be scrolled down by count rows,
+ * @param count If positive, the tree will be scrolled down by count rows, * otherwise, it will be scrolled up by count rows.
void gnt_tree_scroll(GntTree *tree, int count);
@@ -155,13 +155,13 @@
* Insert a row in the tree.
- * @key: The key for the row
- * @row: The row to insert
- * @parent: The key for the parent row
- * @bigbro: The key for the row to insert the new row after.
+ * @param key The key for the row + * @param row The row to insert + * @param parent The key for the parent row + * @param bigbro The key for the row to insert the new row after. - * Returns: The inserted row
+ * @return The inserted row * @see gnt_tree_create_row
* @see gnt_tree_add_row_last
@@ -172,12 +172,12 @@
* Insert a row at the end of the tree.
- * @key: The key for the row
- * @row: The row to insert
- * @parent: The key for the parent row
+ * @param key The key for the row + * @param row The row to insert + * @param parent The key for the parent row - * Returns: The inserted row
+ * @return The inserted row * @see gnt_tree_create_row
* @see gnt_tree_add_row_after
@@ -188,18 +188,18 @@
* Get the key for the selected row.
- * Returns: The key for the selected row
+ * @return The key for the selected row gpointer gnt_tree_get_selection_data(GntTree *tree);
* Get the text displayed for the selected row.
- * Returns: The text, which needs to be freed by the caller
+ * @return The text, which needs to be freed by the caller * @see gnt_tree_get_row_text_list
* @see gnt_tree_get_selection_text_list
@@ -208,12 +208,12 @@
* Get a list of text for a row.
- * @key: A key corresponding to the row in question. If key
- * is %NULL, the text list for the selected row will
+ * @param key A key corresponding to the row in question. If key + * is @c NULL, the text list for the selected row will - * Returns: A list of texts of a row. The list and its data should be
+ * @return A list of texts of a row. The list and its data should be * freed by the caller. The caller should make sure that if
* any column of the tree contains binary data, it's not freed.
* @see gnt_tree_get_selection_text_list
@@ -224,10 +224,10 @@
- * @row: The GntTreeRow object
+ * @param row The GntTreeRow object - * Returns: The key of the row.
+ * @return The key of the row. * @since 2.8.0 (gnt), 2.7.2 (pidgin)
gpointer gnt_tree_row_get_key(GntTree *tree, GntTreeRow *row);
@@ -235,10 +235,10 @@
- * @row: The GntTreeRow object
+ * @param row The GntTreeRow object - * Returns: The next row.
+ * @return The next row. * @since 2.8.0 (gnt), 2.7.2 (pidgin)
GntTreeRow * gnt_tree_row_get_next(GntTree *tree, GntTreeRow *row);
@@ -246,10 +246,10 @@
- * @row: The GntTreeRow object
+ * @param row The GntTreeRow object - * Returns: The previous row.
+ * @return The previous row. * @since 2.8.0 (gnt), 2.7.2 (pidgin)
GntTreeRow * gnt_tree_row_get_prev(GntTree *tree, GntTreeRow *row);
@@ -257,10 +257,10 @@
- * @row: The GntTreeRow object
+ * @param row The GntTreeRow object - * Returns: The child row.
+ * @return The child row. * @since 2.8.0 (gnt), 2.7.2 (pidgin)
GntTreeRow * gnt_tree_row_get_child(GntTree *tree, GntTreeRow *row);
@@ -268,10 +268,10 @@
- * @row: The GntTreeRow object
+ * @param row The GntTreeRow object - * Returns: The parent row.
+ * @return The parent row. * @since 2.8.0 (gnt), 2.7.2 (pidgin)
GntTreeRow * gnt_tree_row_get_parent(GntTree *tree, GntTreeRow *row);
@@ -279,9 +279,9 @@
* Get a list of text of the current row.
- * Returns: A list of texts of the currently selected row. The list
+ * @return A list of texts of the currently selected row. The list * and its data should be freed by the caller. The caller
* should make sure that if any column of the tree contains
* binary data, it's not freed.
@@ -293,56 +293,56 @@
* Returns the list of rows in the tree.
- * Returns: The list of the rows. The list should not be modified by the caller.
+ * @return The list of the rows. The list should not be modified by the caller. GList *gnt_tree_get_rows(GntTree *tree);
* Remove a row from the tree.
- * @key: The key for the row to remove
+ * @param key The key for the row to remove void gnt_tree_remove(GntTree *tree, gpointer key);
* Remove all the item from the tree.
void gnt_tree_remove_all(GntTree *tree);
* Get the visible line number of the selected row.
- * Returns: The line number of the currently selected row
+ * @return The line number of the currently selected row int gnt_tree_get_selection_visible_line(GntTree *tree);
* Change the text of a column in a row.
- * @key: The key for the row
- * @colno: The index of the column
+ * @param key The key for the row + * @param colno The index of the column + * @param text The new text void gnt_tree_change_text(GntTree *tree, gpointer key, int colno, const char *text);
* Add a checkable item in the tree.
- * @key: The key for the row
- * @parent: The parent of the row, or %NULL
- * @bigbro: The row to insert after, or %NULL
+ * @param key The key for the row + * @param row The row to add + * @param parent The parent of the row, or @c NULL + * @param bigbro The row to insert after, or @c NULL - * Returns: The row inserted.
+ * @return The row inserted. * @see gnt_tree_create_row
* @see gnt_tree_create_row_from_list
@@ -354,37 +354,37 @@
* Set whether a checkable item is checked or not.
- * @key: The key for the row
- * @set: %TRUE if the item should be checked, %FALSE if not
+ * @param key The key for the row + * @param set @c TRUE if the item should be checked, @c FALSE if not void gnt_tree_set_choice(GntTree *tree, void *key, gboolean set);
* Return whether a row is selected or not, where the row is a checkable item.
- * @key: The key for the row
+ * @param key The key for the row - * Returns: %TRUE if the row is checked, %FALSE otherwise.
+ * @return @c TRUE if the row is checked, @c FALSE otherwise. gboolean gnt_tree_get_choice(GntTree *tree, void *key);
* Set flags for the text in a row in the tree.
- * @key: The key for the row
- * @flags: The flags to set
+ * @param key The key for the row + * @param flags The flags to set void gnt_tree_set_row_flags(GntTree *tree, void *key, GntTextFormatFlags flags);
* Set color for the text in a row in the tree.
- * @key: The key for the row
+ * @param key The key for the row + * @param color The color void gnt_tree_set_row_color(GntTree *tree, void *key, int color);
@@ -392,18 +392,18 @@
- * @key: The key of the row to select
+ * @param key The key of the row to select void gnt_tree_set_selected(GntTree *tree , void *key);
* Create a row to insert in the tree.
- * @...: A string for each column in the tree
+ * @param ... A string for each column in the tree
* @see gnt_tree_create_row_from_list
* @see gnt_tree_add_row_after
@@ -415,10 +415,10 @@
* Create a row from a list of text.
- * @list: The list containing the text for each column
+ * @param list The list containing the text for each column
* @see gnt_tree_create_row
* @see gnt_tree_add_row_after
@@ -430,9 +430,9 @@
* Set the width of a column in the tree.
- * @col: The index of the column
- * @width: The width for the column
+ * @param col The index of the column + * @param width The width for the column * @see gnt_tree_set_column_width_ratio
* @see gnt_tree_set_column_resizable
@@ -442,9 +442,9 @@
* Set the title for a column.
- * @index: The index of the column
- * @title: The title for the column
+ * @param index The index of the column + * @param title The title for the column * @see gnt_tree_set_column_titles
* @see gnt_tree_set_show_title
@@ -456,8 +456,8 @@
* Set the titles of the columns
- * @...: One title for each column in the tree
+ * @param ... One title for each column in the tree * @see gnt_tree_set_column_title
* @see gnt_tree_set_show_title
@@ -467,8 +467,8 @@
* Set whether to display the title of the columns.
- * @set: If %TRUE, the column titles are displayed
+ * @param set If @c TRUE, the column titles are displayed * @see gnt_tree_set_column_title
* @see gnt_tree_set_column_titles
@@ -478,8 +478,8 @@
* Set the compare function for sorting the data.
- * @func: The comparison function, which is used to compare
+ * @param func The comparison function, which is used to compare @@ -489,25 +489,25 @@
* Set whether a row, which has child rows, should be expanded.
- * @key: The key of the row
- * @expanded: Whether to expand the child rows
+ * @param key The key of the row + * @param expanded Whether to expand the child rows void gnt_tree_set_expanded(GntTree *tree, void *key, gboolean expanded);
* Set whether to show column separators.
- * @set: If %TRUE, the column separators are displayed
+ * @param set If @c TRUE, the column separators are displayed void gnt_tree_set_show_separator(GntTree *tree, gboolean set);
* Sort a row in the tree.
- * @row: The row to sort
+ * @param row The row to sort * @see gnt_tree_set_compare_func
@@ -516,17 +516,17 @@
* Automatically adjust the width of the columns in the tree.
void gnt_tree_adjust_columns(GntTree *tree);
* Set the hash functions to use to hash, compare and free the keys.
- * @hash: The hashing function
- * @eq: The function to compare keys
- * @kd: The function to use to free the keys when a row is removed
+ * @param hash The hashing function + * @param eq The function to compare keys + * @param kd The function to use to free the keys when a row is removed void gnt_tree_set_hash_fns(GntTree *tree, gpointer hash, gpointer eq, gpointer kd);
@@ -536,9 +536,9 @@
* This can be useful when, for example, we want to store some data
* which we don't want/need to display.
- * @col: The index of the column
- * @vis: If %FALSE, the column will not be displayed
+ * @param col The index of the column + * @param vis If @c FALSE, the column will not be displayed void gnt_tree_set_column_visible(GntTree *tree, int col, gboolean vis);
@@ -546,9 +546,9 @@
* Set whether a column can be resized to keep the same ratio when the
- * @col: The index of the column
- * @res: If %FALSE, the column will not be resized when the
+ * @param col The index of the column + * @param res If @c FALSE, the column will not be resized when the * @see gnt_tree_set_col_width
@@ -562,18 +562,18 @@
* Set whether data in a column should be considered as binary data, and
* not as strings. A column containing binary data will be display empty text.
- * @col: The index of the column
- * @bin: %TRUE if the data for the column is binary
+ * @param col The index of the column + * @param bin @c TRUE if the data for the column is binary void gnt_tree_set_column_is_binary(GntTree *tree, int col, gboolean bin);
* Set whether text in a column should be right-aligned.
- * @col: The index of the column
- * @right: %TRUE if the text in the column should be right aligned
+ * @param col The index of the column + * @param right @c TRUE if the text in the column should be right aligned * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -583,8 +583,8 @@
* Set column widths to use when calculating column widths after a tree
- * @cols: Array of widths. The width must have the same number
+ * @param cols Array of widths. The width must have the same number * of entries as the number of columns in the tree, or
* end with a negative value for a column-width.
@@ -598,8 +598,8 @@
* Set the column to use for typeahead searching.
- * @col: The index of the column
+ * @param col The index of the column * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -608,8 +608,8 @@
* Check whether the user is currently in the middle of a search.
- * Returns: %TRUE if the user is searching, %FALSE otherwise.
+ * @return @c TRUE if the user is searching, @c FALSE otherwise. * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -618,11 +618,11 @@
* Set a custom search function.
- * @func: The custom search function. The search function is
+ * @param func The custom search function. The search function is * sent the tree itself, the key of a row, the search
* string and the content of row in the search column.
- * If the function returns %TRUE, the row is dislayed,
+ * If the function returns @c TRUE, the row is dislayed, * @since 2.0.0 (gnt), 2.1.0 (pidgin)
@@ -633,10 +633,10 @@
* Get the parent key for a row.
- * @key: The key for the row.
+ * @param key The key for the row. - * Returns: The key of the parent row.
+ * @return The key of the parent row. gpointer gnt_tree_get_parent_key(GntTree *tree, gpointer key);
--- a/libpurple/account.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/account.h Wed Jan 29 10:49:02 2014 +0530
@@ -36,7 +36,9 @@
#define PURPLE_IS_ACCOUNT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_ACCOUNT))
#define PURPLE_ACCOUNT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_ACCOUNT, PurpleAccountClass))
+/** @copydoc _PurpleAccount */ typedef struct _PurpleAccount PurpleAccount;
+/** @copydoc _PurpleAccountClass */ typedef struct _PurpleAccountClass PurpleAccountClass;
typedef gboolean (*PurpleFilterAccountFunc)(PurpleAccount *account);
@@ -57,19 +59,14 @@
- * PurpleAccountRequestType:
- * @PURPLE_ACCOUNT_REQUEST_AUTHORIZATION: Account authorization request
- PURPLE_ACCOUNT_REQUEST_AUTHORIZATION = 0
+ PURPLE_ACCOUNT_REQUEST_AUTHORIZATION = 0 /* Account authorization request */ } PurpleAccountRequestType;
- * PurpleAccountRequestResponse:
* Account request response types
@@ -81,8 +78,6 @@
} PurpleAccountRequestResponse;
- * PurpleAccountPrivacyType:
@@ -95,8 +90,6 @@
} PurpleAccountPrivacyType;
* Structure representing an account.
@@ -132,113 +125,95 @@
- * purple_account_get_type:
* Returns the GType for the Account object.
GType purple_account_get_type(void);
- * @username: The username.
- * @protocol_id: The protocol ID.
- * Returns: The new account.
+ * @param username The username. + * @param protocol_id The protocol ID. + * @return The new account. PurpleAccount *purple_account_new(const char *username, const char *protocol_id);
- * purple_account_connect:
- * @account: The account to connect to.
+ * Connects to an account. - * Connects to an account.
+ * @param account The account to connect to. void purple_account_connect(PurpleAccount *account);
- * purple_account_set_register_callback:
- * @account: The account for which this callback should be used
- * @user_data: The user data passed to the callback
+ * Sets the callback for successful registration. - * Sets the callback for successful registration.
+ * @param account The account for which this callback should be used + * @param cb The callback + * @param user_data The user data passed to the callback void purple_account_set_register_callback(PurpleAccount *account, PurpleAccountRegistrationCb cb, void *user_data);
- * purple_account_register:
- * @account: The account to register.
+ * Registers an account. - * Registers an account.
+ * @param account The account to register. void purple_account_register(PurpleAccount *account);
- * purple_account_register_completed:
- * @account: The account being registered.
- * @succeeded: Was the account registration successful?
* Registration of the account was completed.
* Calls the registration call-back set with purple_account_set_register_callback().
+ * @param account The account being registered. + * @param succeeded Was the account registration successful? void purple_account_register_completed(PurpleAccount *account, gboolean succeeded);
- * purple_account_unregister:
- * @account: The account to unregister.
- * @cb: Optional callback to be called when unregistration is complete
- * @user_data: user data to pass to the callback
+ * Unregisters an account (deleting it from the server). - * Unregisters an account (deleting it from the server).
+ * @param account The account to unregister. + * @param cb Optional callback to be called when unregistration is complete + * @param user_data user data to pass to the callback void purple_account_unregister(PurpleAccount *account, PurpleAccountUnregistrationCb cb, void *user_data);
- * purple_account_disconnect:
- * @account: The account to disconnect from.
+ * Disconnects from an account. - * Disconnects from an account.
+ * @param account The account to disconnect from. void purple_account_disconnect(PurpleAccount *account);
- * purple_account_is_disconnecting:
- * @account: The account
* Indicates if the account is currently being disconnected.
- * Returns: TRUE if the account is being disconnected.
+ * @param account The account + * @return TRUE if the account is being disconnected. gboolean purple_account_is_disconnecting(const PurpleAccount *account);
- * purple_account_notify_added:
- * @account: The account that was added.
- * @remote_user: The name of the user that added this account.
- * @id: The optional ID of the local account. Rarely used.
- * @alias: The optional alias of the user.
- * @message: The optional message sent from the user adding you.
* Notifies the user that the account was added to a remote user's
* This will present a dialog informing the user that he was added to the
* remote user's buddy list.
+ * @param account The account that was added. + * @param remote_user The name of the user that added this account. + * @param id The optional ID of the local account. Rarely used. + * @param alias The optional alias of the user. + * @param message The optional message sent from the user adding you. void purple_account_notify_added(PurpleAccount *account, const char *remote_user,
const char *id, const char *alias,
- * purple_account_request_add:
- * @account: The account that was added.
- * @remote_user: The name of the user that added this account.
- * @id: The optional ID of the local account. Rarely used.
- * @alias: The optional alias of the user.
- * @message: The optional message sent from the user adding you.
* Notifies the user that the account was addded to a remote user's buddy
* list and asks ther user if they want to add the remote user to their buddy
@@ -246,651 +221,592 @@
* This will present a dialog informing the local user that the remote user
* added them to the remote user's buddy list and will ask if they want to add
* the remote user to the buddy list.
+ * @param account The account that was added. + * @param remote_user The name of the user that added this account. + * @param id The optional ID of the local account. Rarely used. + * @param alias The optional alias of the user. + * @param message The optional message sent from the user adding you. void purple_account_request_add(PurpleAccount *account, const char *remote_user,
const char *id, const char *alias,
- * purple_account_request_authorization:
- * @account: The account that was added
- * @remote_user: The name of the user that added this account.
- * @id: The optional ID of the local account. Rarely used.
- * @alias: The optional alias of the remote user.
- * @message: The optional message sent by the user wanting to add you.
- * @on_list: Is the remote user already on the buddy list?
- * @auth_cb: The callback called when the local user accepts
- * @deny_cb: The callback called when the local user rejects
- * @user_data: Data to be passed back to the above callbacks
* Notifies the user that a remote user has wants to add the local user
* to his or her buddy list and requires authorization to do so.
* This will present a dialog informing the user of this and ask if the
* user authorizes or denies the remote user from adding him.
- * Returns: A UI-specific handle.
+ * @param account The account that was added + * @param remote_user The name of the user that added this account. + * @param id The optional ID of the local account. Rarely used. + * @param alias The optional alias of the remote user. + * @param message The optional message sent by the user wanting to add you. + * @param on_list Is the remote user already on the buddy list? + * @param auth_cb The callback called when the local user accepts + * @param deny_cb The callback called when the local user rejects + * @param user_data Data to be passed back to the above callbacks + * @return A UI-specific handle. void *purple_account_request_authorization(PurpleAccount *account, const char *remote_user,
const char *id, const char *alias, const char *message, gboolean on_list,
PurpleAccountRequestAuthorizationCb auth_cb, PurpleAccountRequestAuthorizationCb deny_cb, void *user_data);
- * purple_account_request_close_with_account:
- * @account: The account for which requests should be closed
+ * Close account requests registered for the given PurpleAccount - * Close account requests registered for the given PurpleAccount
+ * @param account The account for which requests should be closed void purple_account_request_close_with_account(PurpleAccount *account);
- * purple_account_request_close:
- * @ui_handle: The ui specific handle for which requests should be closed
+ * Close the account request for the given ui handle - * Close the account request for the given ui handle
+ * @param ui_handle The ui specific handle for which requests should be closed void purple_account_request_close(void *ui_handle);
- * purple_account_request_password:
- * @account: The account to request the password for.
- * @ok_cb: The callback for the OK button.
- * @cancel_cb: The callback for the cancel button.
- * @user_data: User data to be passed into callbacks.
* Requests a password from the user for the account. Does not set the
* account password on success; do that in ok_cb if desired.
+ * @param account The account to request the password for. + * @param ok_cb The callback for the OK button. + * @param cancel_cb The callback for the cancel button. + * @param user_data User data to be passed into callbacks. void purple_account_request_password(PurpleAccount *account, GCallback ok_cb,
GCallback cancel_cb, void *user_data);
- * purple_account_request_change_password:
- * @account: The account to change the password on.
+ * Requests information from the user to change the account's password. - * Requests information from the user to change the account's password.
+ * @param account The account to change the password on. void purple_account_request_change_password(PurpleAccount *account);
- * purple_account_request_change_user_info:
- * @account: The account to change the user information on.
* Requests information from the user to change the account's
+ * @param account The account to change the user information on. void purple_account_request_change_user_info(PurpleAccount *account);
- * purple_account_set_username:
- * @account: The account.
- * @username: The username.
+ * Sets the account's username. - * Sets the account's username.
+ * @param account The account. + * @param username The username. void purple_account_set_username(PurpleAccount *account, const char *username);
- * purple_account_set_password:
- * @account: The account.
- * @password: The password.
- * @cb: A callback for once the password is saved.
- * @data: A pointer to be passed to the callback.
* Sets the account's password.
* The password in the keyring might not be immediately updated, but the cached
* version will be, and it is therefore safe to read the password back before
* the callback has been triggered. One can also set a NULL callback if
* notification of saving to the keyring is not required.
+ * @param account The account. + * @param password The password. + * @param cb A callback for once the password is saved. + * @param data A pointer to be passed to the callback. void purple_account_set_password(PurpleAccount *account, const gchar *password,
PurpleKeyringSaveCallback cb, gpointer data);
- * purple_account_set_private_alias:
- * @account: The account.
+ * Sets the account's private alias. - * Sets the account's private alias.
+ * @param account The account. + * @param alias The alias. void purple_account_set_private_alias(PurpleAccount *account, const char *alias);
- * purple_account_set_user_info:
- * @account: The account.
- * @user_info: The user information.
+ * Sets the account's user information - * Sets the account's user information
+ * @param account The account. + * @param user_info The user information. void purple_account_set_user_info(PurpleAccount *account, const char *user_info);
- * purple_account_set_buddy_icon_path:
- * @account: The account.
- * @path: The buddy icon non-cached path.
+ * Sets the account's buddy icon path. - * Sets the account's buddy icon path.
+ * @param account The account. + * @param path The buddy icon non-cached path. void purple_account_set_buddy_icon_path(PurpleAccount *account, const char *path);
- * purple_account_set_protocol_id:
- * @account: The account.
- * @protocol_id: The protocol ID.
+ * Sets the account's protocol ID. - * Sets the account's protocol ID.
+ * @param account The account. + * @param protocol_id The protocol ID. void purple_account_set_protocol_id(PurpleAccount *account,
const char *protocol_id);
- * purple_account_set_connection:
- * @account: The account.
+ * Sets the account's connection. - * Sets the account's connection.
+ * @param account The account. + * @param gc The connection. void purple_account_set_connection(PurpleAccount *account, PurpleConnection *gc);
- * purple_account_set_remember_password:
- * @account: The account.
- * @value: %TRUE if it should remember the password.
+ * Sets whether or not this account should save its password. - * Sets whether or not this account should save its password.
+ * @param account The account. + * @param value @c TRUE if it should remember the password. void purple_account_set_remember_password(PurpleAccount *account, gboolean value);
- * purple_account_set_check_mail:
- * @account: The account.
- * @value: %TRUE if it should check for mail.
+ * Sets whether or not this account should check for mail. - * Sets whether or not this account should check for mail.
+ * @param account The account. + * @param value @c TRUE if it should check for mail. void purple_account_set_check_mail(PurpleAccount *account, gboolean value);
- * purple_account_set_enabled:
- * @account: The account.
- * @value: %TRUE if it is enabled.
* Sets whether or not this account is enabled for the specified
+ * @param account The account. + * @param value @c TRUE if it is enabled. void purple_account_set_enabled(PurpleAccount *account, const char *ui,
- * purple_account_set_proxy_info:
- * @account: The account.
- * @info: The proxy information.
+ * Sets the account's proxy information. - * Sets the account's proxy information.
+ * @param account The account. + * @param info The proxy information. void purple_account_set_proxy_info(PurpleAccount *account, PurpleProxyInfo *info);
- * purple_account_set_privacy_type:
- * @account: The account.
- * @privacy_type: The privacy type.
+ * Sets the account's privacy type. - * Sets the account's privacy type.
+ * @param account The account. + * @param privacy_type The privacy type. void purple_account_set_privacy_type(PurpleAccount *account, PurpleAccountPrivacyType privacy_type);
- * purple_account_set_status_types:
- * @account: The account.
- * @status_types: The list of status types.
+ * Sets the account's status types. - * Sets the account's status types.
+ * @param account The account. + * @param status_types The list of status types. void purple_account_set_status_types(PurpleAccount *account, GList *status_types);
- * @account: The account.
- * @status_id: The ID of the status.
- * @active: Whether @a status_id is to be activated (<tt>TRUE</tt>) or
- * deactivated (<tt>FALSE</tt>).
- * @...: A NULL-terminated list of pairs of <tt>const char *</tt>
- * attribute name followed by <tt>const char *</tt> attribute value
- * for the status. (For example, one pair might be
- * <tt>"message"</tt> followed by <tt>"hello, talk to me!"</tt>.)
+ * Variadic version of purple_account_set_status_list(); the variadic list + * replaces @a attrs, and should be <tt>NULL</tt>-terminated. - * Variadic version of purple_account_set_status_list().
+ * @copydoc purple_account_set_status_list() void purple_account_set_status(PurpleAccount *account, const char *status_id,
gboolean active, ...) G_GNUC_NULL_TERMINATED;
- * purple_account_set_status_list:
- * @account: The account.
- * @status_id: The ID of the status.
- * @active: Whether @a status_id is to be activated (<tt>TRUE</tt>) or
- * deactivated (<tt>FALSE</tt>).
- * @attrs: A list of <tt>const char *</tt> attribute names followed by
- * <tt>const char *</tt> attribute values for the status.
- * (For example, one pair might be <tt>"message"</tt> followed
- * by <tt>"hello, talk to me!"</tt>.)
* Activates or deactivates a status. All changes to the statuses of
* an account go through this function or 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.
+ * @param account The account. + * @param status_id The ID of the status. + * @param active Whether @a status_id is to be activated (<tt>TRUE</tt>) or + * deactivated (<tt>FALSE</tt>). + * @param attrs A list of <tt>const char *</tt> attribute names followed by + * <tt>const char *</tt> attribute values for the status. + * (For example, one pair might be <tt>"message"</tt> followed + * by <tt>"hello, talk to me!"</tt>.) void purple_account_set_status_list(PurpleAccount *account,
const char *status_id, gboolean active, GList *attrs);
- * purple_account_set_public_alias:
- * @account: The account
- * @alias: The new public alias for this account or NULL
- * to unset the alias/nickname (or return it to
- * a protocol-specific "default", like the username)
- * @success_cb: A callback which will be called if the alias
- * is successfully set on the server (or NULL).
- * @failure_cb: A callback which will be called if the alias
- * is not successfully set on the server (or NULL).
* Set a server-side (public) alias for this account. The account
* must already be connected.
* Currently, the public alias is not stored locally, although this
* may change in a later version.
+ * @param account The account + * @param alias The new public alias for this account or NULL + * to unset the alias/nickname (or return it to + * a protocol-specific "default", like the username) + * @param success_cb A callback which will be called if the alias + * is successfully set on the server (or NULL). + * @param failure_cb A callback which will be called if the alias + * is not successfully set on the server (or NULL). void purple_account_set_public_alias(PurpleAccount *account,
const char *alias, PurpleSetPublicAliasSuccessCallback success_cb,
PurpleSetPublicAliasFailureCallback failure_cb);
- * purple_account_get_public_alias:
- * @account: The account
- * @success_cb: A callback which will be called with the alias
- * @failure_cb: A callback which will be called if the protocol is
- * unable to retrieve the server-side alias.
* Fetch the server-side (public) alias for this account. The account
* must already be connected.
+ * @param account The account + * @param success_cb A callback which will be called with the alias + * @param failure_cb A callback which will be called if the protocol is + * unable to retrieve the server-side alias. void purple_account_get_public_alias(PurpleAccount *account,
PurpleGetPublicAliasSuccessCallback success_cb,
PurpleGetPublicAliasFailureCallback failure_cb);
- * purple_account_get_silence_suppression:
- * @account: The account.
* Return whether silence suppression is used during voice call.
- * Returns: %TRUE if suppression is used, or %FALSE if not.
+ * @param account The account. + * @return @c TRUE if suppression is used, or @c FALSE if not. gboolean purple_account_get_silence_suppression(const PurpleAccount *account);
- * purple_account_set_silence_suppression:
- * @account: The account.
- * @value: %TRUE if suppression should be used.
+ * Sets whether silence suppression is used during voice call. - * Sets whether silence suppression is used during voice call.
+ * @param account The account. + * @param value @c TRUE if suppression should be used. void purple_account_set_silence_suppression(PurpleAccount *account,
- * purple_account_clear_settings:
- * @account: The account.
+ * Clears all protocol-specific settings on an account. - * Clears all protocol-specific settings on an account.
+ * @param account The account. void purple_account_clear_settings(PurpleAccount *account);
- * purple_account_remove_setting:
- * @account: The account.
- * @setting: The setting to remove.
+ * Removes an account-specific setting by name. - * Removes an account-specific setting by name.
+ * @param account The account. + * @param setting The setting to remove. void purple_account_remove_setting(PurpleAccount *account, const char *setting);
- * purple_account_set_int:
- * @account: The account.
- * @name: The name of the setting.
- * @value: The setting's value.
+ * Sets a protocol-specific integer setting for an account. - * Sets a protocol-specific integer setting for an account.
+ * @param account The account. + * @param name The name of the setting. + * @param value The setting's value. void purple_account_set_int(PurpleAccount *account, const char *name, int value);
- * purple_account_set_string:
- * @account: The account.
- * @name: The name of the setting.
- * @value: The setting's value.
+ * Sets a protocol-specific string setting for an account. - * Sets a protocol-specific string setting for an account.
+ * @param account The account. + * @param name The name of the setting. + * @param value The setting's value. void purple_account_set_string(PurpleAccount *account, const char *name,
- * purple_account_set_bool:
- * @account: The account.
- * @name: The name of the setting.
- * @value: The setting's value.
+ * Sets a protocol-specific boolean setting for an account. - * Sets a protocol-specific boolean setting for an account.
+ * @param account The account. + * @param name The name of the setting. + * @param value The setting's value. void purple_account_set_bool(PurpleAccount *account, const char *name,
- * purple_account_set_ui_int:
- * @account: The account.
- * @name: The name of the setting.
- * @value: The setting's value.
+ * Sets a UI-specific integer setting for an account. - * Sets a UI-specific integer setting for an account.
+ * @param account The account. + * @param ui The UI name. + * @param name The name of the setting. + * @param value The setting's value. void purple_account_set_ui_int(PurpleAccount *account, const char *ui,
const char *name, int value);
- * purple_account_set_ui_string:
- * @account: The account.
- * @name: The name of the setting.
- * @value: The setting's value.
+ * Sets a UI-specific string setting for an account. - * Sets a UI-specific string setting for an account.
+ * @param account The account. + * @param ui The UI name. + * @param name The name of the setting. + * @param value The setting's value. void purple_account_set_ui_string(PurpleAccount *account, const char *ui,
const char *name, const char *value);
- * purple_account_set_ui_bool:
- * @account: The account.
- * @name: The name of the setting.
- * @value: The setting's value.
+ * Sets a UI-specific boolean setting for an account. - * Sets a UI-specific boolean setting for an account.
+ * @param account The account. + * @param ui The UI name. + * @param name The name of the setting. + * @param value The setting's value. void purple_account_set_ui_bool(PurpleAccount *account, const char *ui,
const char *name, gboolean value);
- * purple_account_set_ui_data:
- * @account: The account.
- * @ui_data: A pointer to associate with this object.
+ * Set the UI data associated with this account. - * Set the UI data associated with this account.
+ * @param account The account. + * @param ui_data A pointer to associate with this object. void purple_account_set_ui_data(PurpleAccount *account, gpointer ui_data);
- * purple_account_get_ui_data:
- * @account: The account.
* Returns the UI data associated with this account.
- * Returns: The UI data associated with this account. This is a
+ * @param account The account. + * @return The UI data associated with this account. This is a * convenience field provided to the UIs--it is not
* used by the libpurple core.
gpointer purple_account_get_ui_data(const PurpleAccount *account);
- * purple_account_is_connected:
- * @account: The account.
* Returns whether or not the account is connected.
- * Returns: %TRUE if connected, or %FALSE otherwise.
+ * @param account The account. + * @return @c TRUE if connected, or @c FALSE otherwise. gboolean purple_account_is_connected(const PurpleAccount *account);
- * purple_account_is_connecting:
- * @account: The account.
* Returns whether or not the account is connecting.
- * Returns: %TRUE if connecting, or %FALSE otherwise.
+ * @param account The account. + * @return @c TRUE if connecting, or @c FALSE otherwise. gboolean purple_account_is_connecting(const PurpleAccount *account);
- * purple_account_is_disconnected:
- * @account: The account.
* Returns whether or not the account is disconnected.
- * Returns: %TRUE if disconnected, or %FALSE otherwise.
+ * @param account The account. + * @return @c TRUE if disconnected, or @c FALSE otherwise. gboolean purple_account_is_disconnected(const PurpleAccount *account);
- * purple_account_get_username:
- * @account: The account.
* Returns the account's username.
- * Returns: The username.
+ * @param account The account. + * @return The username. const char *purple_account_get_username(const PurpleAccount *account);
- * purple_account_get_password:
- * @account: The account.
- * @cb: The callback to give the password.
- * @data: A pointer passed to the callback.
* Reads the password for the account.
* This is an asynchronous call, that will return the password in a callback
* once it has been read from the keyring. If the account is connected, and you
* require the password immediately, then consider using @ref
* purple_connection_get_password instead.
+ * @param account The account. + * @param cb The callback to give the password. + * @param data A pointer passed to the callback. void purple_account_get_password(PurpleAccount *account,
PurpleKeyringReadCallback cb, gpointer data);
- * purple_account_get_private_alias:
- * @account: The account.
* Returns the account's private alias.
+ * @param account The account. const char *purple_account_get_private_alias(const PurpleAccount *account);
- * purple_account_get_user_info:
- * @account: The account.
* Returns the account's user information.
- * Returns: The user information.
+ * @param account The account. + * @return The user information. const char *purple_account_get_user_info(const PurpleAccount *account);
- * purple_account_get_buddy_icon_path:
- * @account: The account.
* Gets the account's buddy icon path.
- * Returns: The buddy icon's non-cached path.
+ * @param account The account. + * @return The buddy icon's non-cached path. const char *purple_account_get_buddy_icon_path(const PurpleAccount *account);
- * purple_account_get_protocol_id:
- * @account: The account.
* Returns the account's protocol ID.
- * Returns: The protocol ID.
+ * @param account The account. + * @return The protocol ID. const char *purple_account_get_protocol_id(const PurpleAccount *account);
- * purple_account_get_protocol_name:
- * @account: The account.
* Returns the account's protocol name.
- * Returns: The protocol name.
+ * @param account The account. + * @return The protocol name. const char *purple_account_get_protocol_name(const PurpleAccount *account);
- * purple_account_get_connection:
- * @account: The account.
* Returns the account's connection.
- * Returns: The connection.
+ * @param account The account. + * @return The connection. PurpleConnection *purple_account_get_connection(const PurpleAccount *account);
- * purple_account_get_name_for_display:
- * @account: The account.
* Returns a name for this account appropriate for display to the user. In
* order of preference: the account's alias; the contact or buddy alias (if
* the account exists on its own buddy list); the connection's display name;
* the account's username.
- * Returns: The name to display.
+ * @param account The account. + * @return The name to display. const gchar *purple_account_get_name_for_display(const PurpleAccount *account);
- * purple_account_get_remember_password:
- * @account: The account.
* Returns whether or not this account should save its password.
- * Returns: %TRUE if it should remember the password.
+ * @param account The account. + * @return @c TRUE if it should remember the password. gboolean purple_account_get_remember_password(const PurpleAccount *account);
- * purple_account_get_check_mail:
- * @account: The account.
* Returns whether or not this account should check for mail.
- * Returns: %TRUE if it should check for mail.
+ * @param account The account. + * @return @c TRUE if it should check for mail. gboolean purple_account_get_check_mail(const PurpleAccount *account);
- * purple_account_get_enabled:
- * @account: The account.
* Returns whether or not this account is enabled for the
- * Returns: %TRUE if it enabled on this UI.
+ * @param account The account. + * @return @c TRUE if it enabled on this UI. gboolean purple_account_get_enabled(const PurpleAccount *account,
- * purple_account_get_proxy_info:
- * @account: The account.
* Returns the account's proxy information.
- * Returns: The proxy information.
+ * @param account The account. + * @return The proxy information. PurpleProxyInfo *purple_account_get_proxy_info(const PurpleAccount *account);
- * purple_account_get_privacy_type:
- * @account: The account.
* Returns the account's privacy type.
- * Returns: The privacy type.
+ * @param account The account. + * @return The privacy type. PurpleAccountPrivacyType purple_account_get_privacy_type(const PurpleAccount *account);
- * purple_account_privacy_permit_add:
- * @account: The account.
- * @name: The name of the user to add to the list.
- * @local_only: If TRUE, only the local list is updated, and not
+ * Adds a user to the account's permit list. + * @param account The account. + * @param name The name of the user to add to the list. + * @param local_only If TRUE, only the local list is updated, and not - * Adds a user to the account's permit list.
- * Returns: TRUE if the user was added successfully, or %FALSE otherwise.
+ * @return TRUE if the user was added successfully, or @c FALSE otherwise. gboolean purple_account_privacy_permit_add(PurpleAccount *account,
const char *name, gboolean local_only);
- * purple_account_privacy_permit_remove:
- * @account: The account.
- * @name: The name of the user to add to the list.
- * @local_only: If TRUE, only the local list is updated, and not
+ * Removes a user from the account's permit list. + * @param account The account. + * @param name The name of the user to add to the list. + * @param local_only If TRUE, only the local list is updated, and not - * Removes a user from the account's permit list.
- * Returns: TRUE if the user was removed successfully, or %FALSE otherwise.
+ * @return TRUE if the user was removed successfully, or @c FALSE otherwise. gboolean purple_account_privacy_permit_remove(PurpleAccount *account,
const char *name, gboolean local_only);
- * purple_account_privacy_deny_add:
- * @account: The account.
- * @name: The name of the user to add to the list.
- * @local_only: If TRUE, only the local list is updated, and not
+ * Adds a user to the account's deny list. + * @param account The account. + * @param name The name of the user to add to the list. + * @param local_only If TRUE, only the local list is updated, and not - * Adds a user to the account's deny list.
- * Returns: TRUE if the user was added successfully, or %FALSE otherwise.
+ * @return TRUE if the user was added successfully, or @c FALSE otherwise. gboolean purple_account_privacy_deny_add(PurpleAccount *account,
const char *name, gboolean local_only);
- * purple_account_privacy_deny_remove:
- * @account: The account.
- * @name: The name of the user to add to the list.
- * @local_only: If TRUE, only the local list is updated, and not
+ * Removes a user from the account's deny list. + * @param account The account. + * @param name The name of the user to add to the list. + * @param local_only If TRUE, only the local list is updated, and not - * Removes a user from the account's deny list.
- * Returns: TRUE if the user was removed successfully, or %FALSE otherwise.
+ * @return TRUE if the user was removed successfully, or @c FALSE otherwise. gboolean purple_account_privacy_deny_remove(PurpleAccount *account,
const char *name, gboolean local_only);
- * purple_account_privacy_allow:
- * @account: The account.
- * @who: The name of the user.
* Allow a user to send messages. If current privacy setting for the account is:
* PURPLE_ACCOUNT_PRIVACY_ALLOW_USERS: The user is added to the allow-list.
* PURPLE_ACCOUNT_PRIVACY_DENY_USERS : The user is removed from the
@@ -908,14 +824,13 @@
* The changes are reflected on the server. The previous allow/deny list is not
* restored if the privacy setting is changed.
+ * @param account The account. + * @param who The name of the user. void purple_account_privacy_allow(PurpleAccount *account, const char *who);
- * purple_account_privacy_deny:
- * @account: The account.
- * @who: The name of the user.
* Block messages from a user. If current privacy setting for the account is:
* PURPLE_ACCOUNT_PRIVACY_ALLOW_USERS: The user is removed from the
@@ -933,332 +848,305 @@
* The changes are reflected on the server. The previous allow/deny list is not
* restored if the privacy setting is changed.
+ * @param account The account. + * @param who The name of the user. void purple_account_privacy_deny(PurpleAccount *account, const char *who);
- * purple_account_privacy_get_permitted:
- * @account: The account.
* Returns the account's permit list.
- * Returns: (transfer none): A list of the permitted users
+ * @param account The account. + * @constreturn A list of the permitted users GSList *purple_account_privacy_get_permitted(PurpleAccount *account);
- * purple_account_privacy_get_denied:
- * @account: The account.
* Returns the account's deny list.
- * Returns: (transfer none): A list of the denied users
+ * @param account The account. + * @constreturn A list of the denied users GSList *purple_account_privacy_get_denied(PurpleAccount *account);
- * purple_account_privacy_check:
- * @account: The account.
- * @who: The name of the user.
* Check the privacy-setting for a user.
- * Returns: %FALSE if the specified account's privacy settings block the user
- * or %TRUE otherwise. The meaning of "block" is protocol-dependent and
+ * @param account The account. + * @param who The name of the user. + * @return @c FALSE if the specified account's privacy settings block the user + * or @c TRUE otherwise. The meaning of "block" is protocol-dependent and * generally relates to status and/or sending of messages.
gboolean purple_account_privacy_check(PurpleAccount *account, const char *who);
- * purple_account_get_active_status:
- * @account: The account.
* Returns the active status for this account. This looks through
* the PurplePresence associated with this account and returns the
* PurpleStatus that has its active flag set to "TRUE." There can be
* only one active PurpleStatus in a PurplePresence.
- * Returns: The active status.
+ * @param account The account. + * @return The active status. PurpleStatus *purple_account_get_active_status(const PurpleAccount *account);
- * purple_account_get_status:
- * @account: The account.
- * @status_id: The status ID.
* Returns the account status with the specified ID.
* Note that this works differently than purple_buddy_get_status() in that
* it will only return NULL if the status was not registered.
- * Returns: The status, or NULL if it was never registered.
+ * @param account The account. + * @param status_id The status ID. + * @return The status, or NULL if it was never registered. PurpleStatus *purple_account_get_status(const PurpleAccount *account,
- * purple_account_get_status_type:
- * @account: The account.
- * @id: The ID of the status type to find.
* Returns the account status type with the specified ID.
- * Returns: The status type if found, or NULL.
+ * @param account The account. + * @param id The ID of the status type to find. + * @return The status type if found, or NULL. PurpleStatusType *purple_account_get_status_type(const PurpleAccount *account,
- * purple_account_get_status_type_with_primitive:
- * @account: The account.
- * @primitive: The type of the status type to find.
* Returns the account status type with the specified primitive.
* Note: It is possible for an account to have more than one
* PurpleStatusType with the same primitive. In this case, the
* first PurpleStatusType is returned.
- * Returns: The status if found, or NULL.
+ * @param account The account. + * @param primitive The type of the status type to find. + * @return The status if found, or NULL. PurpleStatusType *purple_account_get_status_type_with_primitive(
const PurpleAccount *account,
PurpleStatusPrimitive primitive);
- * purple_account_get_presence:
- * @account: The account.
* Returns the account's presence.
- * Returns: The account's presence.
+ * @param account The account. + * @return The account's presence. PurplePresence *purple_account_get_presence(const PurpleAccount *account);
- * purple_account_is_status_active:
- * @account: The account.
- * @status_id: The status ID.
* Returns whether or not an account status is active.
- * Returns: TRUE if active, or FALSE if not.
+ * @param account The account. + * @param status_id The status ID. + * @return TRUE if active, or FALSE if not. gboolean purple_account_is_status_active(const PurpleAccount *account,
- * purple_account_get_status_types:
- * @account: The account.
* Returns the account's status types.
- * Returns: (transfer none): The account's status types.
+ * @param account The account. + * @constreturn The account's status types. GList *purple_account_get_status_types(const PurpleAccount *account);
- * purple_account_get_int:
- * @account: The account.
- * @name: The name of the setting.
- * @default_value: The default value.
* Returns a protocol-specific integer setting for an account.
+ * @param account The account. + * @param name The name of the setting. + * @param default_value The default value. int purple_account_get_int(const PurpleAccount *account, const char *name,
- * purple_account_get_string:
- * @account: The account.
- * @name: The name of the setting.
- * @default_value: The default value.
* Returns a protocol-specific string setting for an account.
+ * @param account The account. + * @param name The name of the setting. + * @param default_value The default value. const char *purple_account_get_string(const PurpleAccount *account,
const char *default_value);
- * purple_account_get_bool:
- * @account: The account.
- * @name: The name of the setting.
- * @default_value: The default value.
* Returns a protocol-specific boolean setting for an account.
+ * @param account The account. + * @param name The name of the setting. + * @param default_value The default value. gboolean purple_account_get_bool(const PurpleAccount *account, const char *name,
- * purple_account_get_ui_int:
- * @account: The account.
- * @name: The name of the setting.
- * @default_value: The default value.
* Returns a UI-specific integer setting for an account.
+ * @param account The account. + * @param ui The UI name. + * @param name The name of the setting. + * @param default_value The default value. int purple_account_get_ui_int(const PurpleAccount *account, const char *ui,
const char *name, int default_value);
- * purple_account_get_ui_string:
- * @account: The account.
- * @name: The name of the setting.
- * @default_value: The default value.
* Returns a UI-specific string setting for an account.
+ * @param account The account. + * @param ui The UI name. + * @param name The name of the setting. + * @param default_value The default value. const char *purple_account_get_ui_string(const PurpleAccount *account,
const char *ui, const char *name,
const char *default_value);
- * purple_account_get_ui_bool:
- * @account: The account.
- * @name: The name of the setting.
- * @default_value: The default value.
* Returns a UI-specific boolean setting for an account.
+ * @param account The account. + * @param ui The UI name. + * @param name The name of the setting. + * @param default_value The default value. gboolean purple_account_get_ui_bool(const PurpleAccount *account, const char *ui,
const char *name, gboolean default_value);
- * purple_account_get_log:
- * @account: The account.
- * @create: Should it be created if it doesn't exist?
* Returns the system log for an account.
- * Note: Callers should almost always pass %FALSE for @a create.
- * Passing %TRUE could result in an existing log being reopened,
+ * @param account The account. + * @param create Should it be created if it doesn't exist? + * @note Callers should almost always pass @c FALSE for @a create. + * Passing @c TRUE could result in an existing log being reopened, * if the log has already been closed, which not all loggers deal
PurpleLog *purple_account_get_log(PurpleAccount *account, gboolean create);
- * purple_account_destroy_log:
- * @account: The account.
+ * Frees the system log of an account - * Frees the system log of an account
+ * @param account The account. void purple_account_destroy_log(PurpleAccount *account);
- * purple_account_add_buddy:
- * @account: The account.
- * @buddy: The buddy to add.
- * @message: The invite message. This may be ignored by a protocol.
+ * Adds a buddy to the server-side buddy list for the specified account. - * Adds a buddy to the server-side buddy list for the specified account.
+ * @param account The account. + * @param buddy The buddy to add. + * @param message The invite message. This may be ignored by a protocol. void purple_account_add_buddy(PurpleAccount *account, PurpleBuddy *buddy, const char *message);
- * purple_account_add_buddies:
- * @account: The account.
- * @buddies: The list of PurpleBlistNodes representing the buddies to add.
- * @message: The invite message. This may be ignored by a protocol.
+ * Adds a list of buddies to the server-side buddy list. - * Adds a list of buddies to the server-side buddy list.
+ * @param account The account. + * @param buddies The list of PurpleBlistNodes representing the buddies to add. + * @param message The invite message. This may be ignored by a protocol. void purple_account_add_buddies(PurpleAccount *account, GList *buddies, const char *message);
- * purple_account_remove_buddy:
- * @account: The account.
- * @buddy: The buddy to remove.
- * @group: The group to remove the buddy from.
+ * Removes a buddy from the server-side buddy list. - * Removes a buddy from the server-side buddy list.
+ * @param account The account. + * @param buddy The buddy to remove. + * @param group The group to remove the buddy from. void purple_account_remove_buddy(PurpleAccount *account, PurpleBuddy *buddy,
- * purple_account_remove_buddies:
- * @account: The account.
- * @buddies: The list of buddies to remove.
- * @groups: The list of groups to remove buddies from. Each node of this
- * list should match the corresponding node of buddies.
* Removes a list of buddies from the server-side buddy list.
- * Note: The lists buddies and groups are parallel lists. Be sure that node n of
+ * @note The lists buddies and groups are parallel lists. Be sure that node n of * groups matches node n of buddies.
+ * @param account The account. + * @param buddies The list of buddies to remove. + * @param groups The list of groups to remove buddies from. Each node of this + * list should match the corresponding node of buddies. void purple_account_remove_buddies(PurpleAccount *account, GList *buddies,
- * purple_account_remove_group:
- * @account: The account.
- * @group: The group to remove.
+ * Removes a group from the server-side buddy list. - * Removes a group from the server-side buddy list.
+ * @param account The account. + * @param group The group to remove. void purple_account_remove_group(PurpleAccount *account, PurpleGroup *group);
- * purple_account_change_password:
- * @account: The account.
- * @orig_pw: The old password.
- * @new_pw: The new password.
+ * Changes the password on the specified account. - * Changes the password on the specified account.
+ * @param account The account. + * @param orig_pw The old password. + * @param new_pw The new password. void purple_account_change_password(PurpleAccount *account, const char *orig_pw,
- * purple_account_supports_offline_message:
- * @account: The account
+ * Whether the account supports sending offline messages to buddy. - * Whether the account supports sending offline messages to buddy.
+ * @param account The account + * @param buddy The buddy gboolean purple_account_supports_offline_message(PurpleAccount *account, PurpleBuddy *buddy);
- * purple_account_get_current_error:
- * @account: The account whose error should be retrieved.
- * Get the error that caused the account to be disconnected, or %NULL if the
+ * Get the error that caused the account to be disconnected, or @c NULL if the * account is happily connected or disconnected without an error.
- * 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.
+ * @param account The account whose error should be retrieved. + * @constreturn The type of error and a human-readable description of the + * current error, or @c 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. const PurpleConnectionErrorInfo *purple_account_get_current_error(PurpleAccount *account);
- * purple_account_clear_current_error:
- * @account: The account whose error state should be cleared.
+ * Clear an account's current error state, resetting it to @c NULL. - * Clear an account's current error state, resetting it to %NULL.
+ * @param account The account whose error state should be cleared. void purple_account_clear_current_error(PurpleAccount *account);
--- a/libpurple/accountopt.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/accountopt.h Wed Jan 29 10:49:02 2014 +0530
@@ -50,11 +50,11 @@
* purple_account_option_int_new(), purple_account_option_string_new() or
* purple_account_option_list_new() (as appropriate) instead.
- * @type: The type of option.
- * @text: The text of the option.
- * @pref_name: The account preference name for the option.
+ * @param type The type of option. + * @param text The text of the option. + * @param pref_name The account preference name for the option. - * Returns: The account option.
+ * @return The account option. PurpleAccountOption *purple_account_option_new(PurplePrefType type,
const char *text, const char *pref_name);
@@ -62,11 +62,11 @@
* Creates a new boolean account option.
- * @text: The text of the option.
- * @pref_name: The account preference name for the option.
- * @default_value: The default value.
+ * @param text The text of the option. + * @param pref_name The account preference name for the option. + * @param default_value The default value. - * Returns: The account option.
+ * @return The account option. PurpleAccountOption *purple_account_option_bool_new(const char *text,
const char *pref_name, gboolean default_value);
@@ -74,11 +74,11 @@
* Creates a new integer account option.
- * @text: The text of the option.
- * @pref_name: The account preference name for the option.
- * @default_value: The default value.
+ * @param text The text of the option. + * @param pref_name The account preference name for the option. + * @param default_value The default value. - * Returns: The account option.
+ * @return The account option. PurpleAccountOption *purple_account_option_int_new(const char *text,
const char *pref_name, int default_value);
@@ -86,11 +86,11 @@
* Creates a new string account option.
- * @text: The text of the option.
- * @pref_name: The account preference name for the option.
- * @default_value: The default value.
+ * @param text The text of the option. + * @param pref_name The account preference name for the option. + * @param default_value The default value. - * Returns: The account option.
+ * @return The account option. PurpleAccountOption *purple_account_option_string_new(const char *text,
const char *pref_name, const char *default_value);
@@ -106,11 +106,11 @@
* the internal ID that should be passed to purple_account_set_string() to
- * @text: The text of the option.
- * @pref_name: The account preference name for the option.
- * @list: The key, value list.
+ * @param text The text of the option. + * @param pref_name The account preference name for the option. + * @param list The key, value list. - * Returns: The account option.
+ * @return The account option. PurpleAccountOption *purple_account_option_list_new(const char *text,
const char *pref_name, GList *list);
@@ -118,15 +118,15 @@
* Destroys an account option.
- * @option: The option to destroy.
+ * @param option The option to destroy. void purple_account_option_destroy(PurpleAccountOption *option);
* Sets the default boolean value for an account option.
- * @option: The account option.
- * @value: The default boolean value.
+ * @param option The account option. + * @param value The default boolean value. void purple_account_option_set_default_bool(PurpleAccountOption *option,
@@ -134,8 +134,8 @@
* Sets the default integer value for an account option.
- * @option: The account option.
- * @value: The default integer value.
+ * @param option The account option. + * @param value The default integer value. void purple_account_option_set_default_int(PurpleAccountOption *option,
@@ -143,8 +143,8 @@
* Sets the default string value for an account option.
- * @option: The account option.
- * @value: The default string value.
+ * @param option The account option. + * @param value The default string value. void purple_account_option_set_default_string(PurpleAccountOption *option,
@@ -154,8 +154,8 @@
* as a hint to the UI that the option's value should be obscured from
- * @option: The account option.
- * @masked: The masking.
+ * @param option The account option. + * @param masked The masking. purple_account_option_string_set_masked(PurpleAccountOption *option, gboolean masked);
@@ -166,8 +166,8 @@
* The list passed will be owned by the account option, and the
* strings inside will be freed automatically.
- * @option: The account option.
- * @hints: The list of hints, stored as strings.
+ * @param option The account option. + * @param hints The list of hints, stored as strings. void purple_account_option_string_set_hints(PurpleAccountOption *option,
@@ -181,17 +181,17 @@
* The list is in key, value pairs. The key is the ID stored and used
* internally, and the value is the label displayed.
- * @option: The account option.
- * @values: The default list value.
+ * @param option The account option. + * @param values The default list value. void purple_account_option_set_list(PurpleAccountOption *option, GList *values);
* Adds an item to a list account option.
- * @option: The account option.
+ * @param option The account option. + * @param value The value. void purple_account_option_add_list_item(PurpleAccountOption *option,
const char *key, const char *value);
@@ -199,18 +199,18 @@
* Returns the specified account option's type.
- * @option: The account option.
+ * @param option The account option. - * Returns: The account option's type.
+ * @return The account option's type. PurplePrefType purple_account_option_get_type(const PurpleAccountOption *option);
* Returns the text for an account option.
- * @option: The account option.
+ * @param option The account option. - * Returns: The account option's text.
+ * @return The account option's text. const char *purple_account_option_get_text(const PurpleAccountOption *option);
@@ -219,36 +219,36 @@
* parameter supplied to purple_account_option_new() or one of the
* type-specific constructors.
- * @option: The account option.
+ * @param option The account option. - * Returns: The option's name.
+ * @return The option's name. const char *purple_account_option_get_setting(const PurpleAccountOption *option);
* Returns the default boolean value for an account option.
- * @option: The account option.
+ * @param option The account option. - * Returns: The default boolean value.
+ * @return The default boolean value. gboolean purple_account_option_get_default_bool(const PurpleAccountOption *option);
* Returns the default integer value for an account option.
- * @option: The account option.
+ * @param option The account option. - * Returns: The default integer value.
+ * @return The default integer value. int purple_account_option_get_default_int(const PurpleAccountOption *option);
* Returns the default string value for an account option.
- * @option: The account option.
+ * @param option The account option. - * Returns: The default string value.
+ * @return The default string value. const char *purple_account_option_get_default_string(
const PurpleAccountOption *option);
@@ -256,9 +256,9 @@
* Returns the default string value for a list account option.
- * @option: The account option.
+ * @param option The account option. - * Returns: The default list string value.
+ * @return The default list string value. const char *purple_account_option_get_default_list_value(
const PurpleAccountOption *option);
@@ -268,9 +268,9 @@
* password. If so, the UI might display each character of the option
* as a '*' (for example).
- * @option: The account option.
+ * @param option The account option. - * Returns: %TRUE if the option's value should be obscured.
+ * @return %TRUE if the option's value should be obscured. purple_account_option_string_get_masked(const PurpleAccountOption *option);
@@ -278,18 +278,18 @@
* Returns the list of hints for an account option.
- * @option: The account option.
+ * @param option The account option. - * Returns: (transfer none): A list of hints, stored as strings.
+ * @constreturn A list of hints, stored as strings. const GSList * purple_account_option_string_get_hints(const PurpleAccountOption *option);
* Returns the list values for an account option.
- * @option: The account option.
+ * @param option The account option. - * Returns: (transfer none): A list of #PurpleKeyValuePair, mapping the human-readable
+ * @constreturn 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
@@ -307,11 +307,11 @@
* Creates a new account username split.
- * @text: The text of the option.
- * @default_value: The default value.
- * @sep: The field separator.
+ * @param text The text of the option. + * @param default_value The default value. + * @param sep The field separator. - * Returns: The new user split.
+ * @return The new user split. PurpleAccountUserSplit *purple_account_user_split_new(const char *text,
const char *default_value,
@@ -320,25 +320,25 @@
* Destroys an account username split.
- * @split: The split to destroy.
+ * @param split The split to destroy. void purple_account_user_split_destroy(PurpleAccountUserSplit *split);
* Returns the text for an account username split.
- * @split: The account username split.
+ * @param split The account username split. - * Returns: The account username split's text.
+ * @return The account username split's text. const char *purple_account_user_split_get_text(const PurpleAccountUserSplit *split);
* Returns the default string value for an account split.
- * @split: The account username split.
+ * @param split The account username split. - * Returns: The default string.
+ * @return The default string. const char *purple_account_user_split_get_default_value(
const PurpleAccountUserSplit *split);
@@ -346,26 +346,26 @@
* Returns the field separator for an account split.
- * @split: The account username split.
+ * @param split The account username split. - * Returns: The field separator.
+ * @return The field separator. char purple_account_user_split_get_separator(const PurpleAccountUserSplit *split);
* Returns the 'reverse' value for an account split.
- * @split: The account username split.
+ * @param split The account username split. - * Returns: The 'reverse' value.
+ * @return The 'reverse' value. gboolean purple_account_user_split_get_reverse(const PurpleAccountUserSplit *split);
* Sets the 'reverse' value for an account split.
- * @split: The account username split.
- * @reverse: The 'reverse' value
+ * @param split The account username split. + * @param reverse The 'reverse' value void purple_account_user_split_set_reverse(PurpleAccountUserSplit *split, gboolean reverse);
--- a/libpurple/blistnodetypes.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/blistnodetypes.h Wed Jan 29 10:49:02 2014 +0530
@@ -194,10 +194,10 @@
* to add the buddy to the list and purple_account_add_buddy to sync up
- * @account: The account this buddy will get added to
- * @name: The name of the new buddy
- * @alias: The alias of the new buddy (or NULL if unaliased)
- * Returns: A newly allocated buddy
+ * @param account The account this buddy will get added to + * @param name The name of the new buddy + * @param alias The alias of the new buddy (or NULL if unaliased) + * @return A newly allocated buddy * @see purple_account_add_buddy
* @see purple_blist_add_buddy
@@ -210,8 +210,8 @@
* This should only be called from within Purple. You probably want to
* call purple_buddy_icon_set_data().
- * @icon: The buddy icon.
+ * @param buddy The buddy. + * @param icon The buddy icon. * @see purple_buddy_icon_set_data()
@@ -220,35 +220,35 @@
* Returns a buddy's icon.
+ * @param buddy The buddy. - * Returns: The buddy icon.
+ * @return The buddy icon. PurpleBuddyIcon *purple_buddy_get_icon(const PurpleBuddy *buddy);
* Returns a buddy's account.
+ * @param buddy The buddy.
PurpleAccount *purple_buddy_get_account(const PurpleBuddy *buddy);
+ * @param buddy The buddy. + * @param name The name. void purple_buddy_set_name(PurpleBuddy *buddy, const char *name);
+ * @param buddy The buddy.
const char *purple_buddy_get_name(const PurpleBuddy *buddy);
@@ -257,8 +257,8 @@
* This should only be called from the associated protocol.
- * Returns: The protocol data.
+ * @param buddy The buddy. + * @return The protocol data. * @see purple_buddy_set_protocol_data()
@@ -269,8 +269,8 @@
* This should only be called from the associated protocol.
+ * @param buddy The buddy. + * @param data The data. * @see purple_buddy_get_protocol_data()
@@ -279,18 +279,18 @@
* Returns a buddy's contact.
+ * @param buddy The buddy. - * Returns: The buddy's contact.
+ * @return The buddy's contact. PurpleContact *purple_buddy_get_contact(PurpleBuddy *buddy);
* Returns a buddy's presence.
+ * @param buddy The buddy. - * Returns: The buddy's presence.
+ * @return The buddy's presence. PurplePresence *purple_buddy_get_presence(const PurpleBuddy *buddy);
@@ -299,32 +299,32 @@
* This should only be called from within Purple.
- * @buddy: The buddy whose status has changed.
- * @old_status: The status from which we are changing.
+ * @param buddy The buddy whose status has changed. + * @param old_status The status from which we are changing. void purple_buddy_update_status(PurpleBuddy *buddy, PurpleStatus *old_status);
* Gets the media caps from a buddy.
- * Returns: The media caps.
+ * @param buddy The buddy. + * @return The media caps. PurpleMediaCaps purple_buddy_get_media_caps(const PurpleBuddy *buddy);
* Sets the media caps for a buddy.
- * @buddy: The PurpleBuddy.
- * @media_caps: The PurpleMediaCaps.
+ * @param buddy The PurpleBuddy. + * @param media_caps The PurpleMediaCaps. void purple_buddy_set_media_caps(PurpleBuddy *buddy, PurpleMediaCaps media_caps);
* Returns the alias of a buddy.
- * @buddy: The buddy whose alias will be returned.
- * Returns: The alias (if set), server alias (if set),
+ * @param buddy The buddy whose alias will be returned. + * @return The alias (if set), server alias (if set), const char *purple_buddy_get_alias_only(PurpleBuddy *buddy);
@@ -332,16 +332,16 @@
* Sets the server alias for a buddy.
- * @alias: The server alias to be set.
+ * @param buddy The buddy. + * @param alias The server alias to be set. void purple_buddy_set_server_alias(PurpleBuddy *buddy, const char *alias);
* Gets the server alias for a buddy.
- * @buddy: The buddy whose server alias will be returned
- * Returns: The server alias, or NULL if it is not set.
+ * @param buddy The buddy whose server alias will be returned + * @return The server alias, or NULL if it is not set. const char *purple_buddy_get_server_alias(PurpleBuddy *buddy);
@@ -350,8 +350,8 @@
* into account. In order of precedence: the buddy's alias; the buddy's
* contact alias; the buddy's server alias; the buddy's user name.
- * @buddy: The buddy whose alias will be returned
- * Returns: The appropriate name or alias, or NULL.
+ * @param buddy The buddy whose alias will be returned + * @return The appropriate name or alias, or NULL. const char *purple_buddy_get_contact_alias(PurpleBuddy *buddy);
@@ -361,32 +361,32 @@
* the buddy's local alias; the buddy's server alias; the buddy's contact alias;
- * @buddy: The buddy whose alias will be returned.
- * Returns: The appropriate name or alias, or NULL
+ * @param buddy The buddy whose alias will be returned. + * @return The appropriate name or alias, or NULL const char *purple_buddy_get_alias(PurpleBuddy *buddy);
* Sets the local alias for the buddy.
- * @alias: The local alias for the buddy
+ * @param buddy The buddy + * @param alias The local alias for the buddy void purple_buddy_set_local_alias(PurpleBuddy *buddy, const char *alias);
- * Returns the local alias for the buddy, or %NULL if none exists.
+ * Returns the local alias for the buddy, or @c NULL if none exists.
- * Returns: The local alias for the buddy
+ * @param buddy The buddy + * @return The local alias for the buddy const char *purple_buddy_get_local_alias(PurpleBuddy *buddy);
* Returns the group of which the buddy is a member.
- * Returns: The group or NULL if the buddy is not in a group
+ * @param buddy The buddy + * @return The group or NULL if the buddy is not in a group PurpleGroup *purple_buddy_get_group(PurpleBuddy *buddy);
@@ -405,49 +405,49 @@
- * Returns: A new contact struct
+ * @return A new contact struct PurpleContact *purple_contact_new(void);
* Gets the PurpleGroup from a PurpleContact
- * @contact: The contact
+ * @param contact The contact PurpleGroup *purple_contact_get_group(const PurpleContact *contact);
* Returns the highest priority buddy for a given contact.
- * @contact: The contact
- * Returns: The highest priority buddy
+ * @param contact The contact + * @return The highest priority buddy PurpleBuddy *purple_contact_get_priority_buddy(PurpleContact *contact);
* Sets the alias for a contact.
- * @contact: The contact
+ * @param contact The contact + * @param alias The alias void purple_contact_set_alias(PurpleContact *contact, const char *alias);
* Gets the alias for a contact.
- * @contact: The contact
- * Returns: The alias, or NULL if it is not set.
+ * @param contact The contact + * @return The alias, or NULL if it is not set. const char *purple_contact_get_alias(PurpleContact *contact);
* Determines whether an account owns any buddies in a given contact
- * @contact: The contact to search through.
- * @account: The account.
+ * @param contact The contact to search through. + * @param account The account. - * Returns: TRUE if there are any buddies from account in the contact, or FALSE otherwise.
+ * @return TRUE if there are any buddies from account in the contact, or FALSE otherwise. gboolean purple_contact_on_account(PurpleContact *contact, PurpleAccount *account);
@@ -455,7 +455,7 @@
* Invalidates the priority buddy so that the next call to
* purple_contact_get_priority_buddy recomputes it.
- * @contact: The contact
+ * @param contact The contact void purple_contact_invalidate_priority_buddy(PurpleContact *contact);
@@ -464,8 +464,8 @@
* All of the buddies from source will be moved to target
- * @source: The contact to merge
- * @node: The place to merge to (a buddy or contact)
+ * @param source The contact to merge + * @param node The place to merge to (a buddy or contact) void purple_contact_merge(PurpleContact *source, PurpleBlistNode *node);
@@ -484,63 +484,63 @@
* Creates a new chat for the buddy list
- * @account: The account this chat will get added to
- * @alias: The alias of the new chat
- * @components: The info the protocol needs to join the chat. The
+ * @param account The account this chat will get added to + * @param alias The alias of the new chat + * @param components The info the protocol needs to join the chat. The * hash function should be g_str_hash() and the
* equal function should be g_str_equal().
- * Returns: A newly allocated chat
+ * @return A newly allocated chat PurpleChat *purple_chat_new(PurpleAccount *account, const char *alias, GHashTable *components);
* Returns the correct name to display for a blist chat.
- * @chat: The chat whose name will be returned.
- * Returns: The alias (if set), or first component value.
+ * @param chat The chat whose name will be returned. + * @return The alias (if set), or first component value. const char *purple_chat_get_name(PurpleChat *chat);
* Returns the name of the chat
- * @chat: The chat whose name will be returned.
- * Returns: The first component value.
+ * @param chat The chat whose name will be returned. + * @return The first component value. const char *purple_chat_get_name_only(PurpleChat *chat);
* Sets the alias for a blist chat.
+ * @param alias The alias void purple_chat_set_alias(PurpleChat *chat, const char *alias);
* Returns the group of which the chat is a member.
+ * @param chat The chat. - * Returns: The parent group, or %NULL if the chat is not in a group.
+ * @return The parent group, or @c NULL if the chat is not in a group. PurpleGroup *purple_chat_get_group(PurpleChat *chat);
* Returns the account the chat belongs to.
+ * @param chat The chat. - * Returns: The account the chat belongs to.
+ * @return The account the chat belongs to. PurpleAccount *purple_chat_get_account(PurpleChat *chat);
* Get a hashtable containing information about a chat.
+ * @param chat The chat. - * Returns: (transfer none): The hashtable.
+ * @constreturn The hashtable. GHashTable *purple_chat_get_components(PurpleChat *chat);
@@ -562,8 +562,8 @@
* You can't have more than one group with the same name. Sorry. If you pass
* this the name of a group that already exists, it will return that group.
- * @name: The name of the new group
- * Returns: A new group struct
+ * @param name The name of the new group + * @return A new group struct PurpleGroup *purple_group_new(const char *name);
@@ -572,7 +572,7 @@
- * Returns: A GSList of accounts (which must be freed), or NULL if the group
+ * @return A GSList of accounts (which must be freed), or NULL if the group GSList *purple_group_get_accounts(PurpleGroup *g);
@@ -581,26 +581,26 @@
* Determines whether an account owns any buddies in a given group
* @param g The group to search through.
- * @account: The account.
+ * @param account The account. - * Returns: TRUE if there are any buddies in the group, or FALSE otherwise.
+ * @return TRUE if there are any buddies in the group, or FALSE otherwise. gboolean purple_group_on_account(PurpleGroup *g, PurpleAccount *account);
* Sets the name of a group.
- * @name: The name of the group.
+ * @param group The group. + * @param name The name of the group. void purple_group_set_name(PurpleGroup *group, const char *name);
* Returns the name of a group.
+ * @param group The group. - * Returns: The name of the group.
+ * @return The name of the group. const char *purple_group_get_name(PurpleGroup *group);
--- a/libpurple/buddyicon.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/buddyicon.h Wed Jan 29 10:49:02 2014 +0530
@@ -53,7 +53,7 @@
/** @copydoc PurpleBuddyIconSpec */
struct _PurpleBuddyIconSpec {
- /** This is a comma-delimited list of image formats or %NULL if icons
+ /** This is a comma-delimited list of image formats or @c NULL if icons * are not supported. Neither the core nor the protocol will actually
* check to see if the data it's given matches this; it's entirely up
* to the UI to do what it wants
@@ -86,13 +86,13 @@
* If an icon for this account+username already exists, you'll get a reference
* to that structure, which will have been updated with the data supplied.
- * @account: The account the user is on.
- * @username: The username the icon belongs to.
- * @icon_data: The buddy icon data.
- * @icon_len: The buddy icon length.
- * @checksum: A protocol checksum from the protocol or %NULL.
+ * @param account The account the user is on. + * @param username The username the icon belongs to. + * @param icon_data The buddy icon data. + * @param icon_len The buddy icon length. + * @param checksum A protocol checksum from the protocol or @c NULL. - * Returns: The buddy icon structure, with a reference for the caller.
+ * @return The buddy icon structure, with a reference for the caller. PurpleBuddyIcon *purple_buddy_icon_new(PurpleAccount *account, const char *username,
void *icon_data, size_t icon_len,
@@ -101,9 +101,9 @@
* Increments the reference count on a buddy icon.
- * @icon: The buddy icon.
+ * @param icon The buddy icon.
PurpleBuddyIcon *purple_buddy_icon_ref(PurpleBuddyIcon *icon);
@@ -112,25 +112,25 @@
* If the reference count reaches 0, the icon will be destroyed.
- * @icon: The buddy icon.
+ * @param icon The buddy icon. void purple_buddy_icon_unref(PurpleBuddyIcon *icon);
* Updates every instance of this icon.
- * @icon: The buddy icon.
+ * @param icon The buddy icon. void purple_buddy_icon_update(PurpleBuddyIcon *icon);
* Sets the buddy icon's data.
- * @icon: The buddy icon.
- * @data: The buddy icon data, which the buddy icon code
+ * @param icon The buddy icon. + * @param 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.
+ * @param len The length of the data in @a data. + * @param checksum A protocol checksum from the protocol or @c NULL. purple_buddy_icon_set_data(PurpleBuddyIcon *icon, guchar *data,
@@ -139,18 +139,18 @@
* Returns the buddy icon's account.
- * @icon: The buddy icon.
+ * @param icon The buddy icon. - * Returns: The account.
PurpleAccount *purple_buddy_icon_get_account(const PurpleBuddyIcon *icon);
* Returns the buddy icon's username.
- * @icon: The buddy icon.
+ * @param icon The buddy icon. - * Returns: The username.
+ * @return The username. const char *purple_buddy_icon_get_username(const PurpleBuddyIcon *icon);
@@ -159,29 +159,29 @@
* This function is really only for protocol use.
- * @icon: The buddy icon.
+ * @param icon The buddy icon. - * Returns: The checksum.
+ * @return The checksum. const char *purple_buddy_icon_get_checksum(const PurpleBuddyIcon *icon);
* Returns the buddy icon's data.
- * @icon: The buddy icon.
- * @len: If not %NULL, the length of the icon data returned will be
+ * @param icon The buddy icon. + * @param len If not @c NULL, the length of the icon data returned will be * set in the location pointed to by this.
- * Returns: A pointer to the icon data.
+ * @return A pointer to the icon data. gconstpointer purple_buddy_icon_get_data(const PurpleBuddyIcon *icon, size_t *len);
* Returns an extension corresponding to the buddy icon's file type.
- * @icon: The buddy icon.
+ * @param icon The buddy icon. - * Returns: The icon's extension, "icon" if unknown, or %NULL if
+ * @return The icon's extension, "icon" if unknown, or @c NULL if * the image data has disappeared.
const char *purple_buddy_icon_get_extension(const PurpleBuddyIcon *icon);
@@ -196,9 +196,9 @@
* directly. If you find yourself wanting to use this function, think
* very long and hard about it, and then don't.
- * @icon: The buddy icon
+ * @param icon The buddy icon - * Returns: A full path to the file, or %NULL under various conditions.
+ * @return A full path to the file, or @c NULL under various conditions. char *purple_buddy_icon_get_full_path(PurpleBuddyIcon *icon);
@@ -212,12 +212,12 @@
* Sets a buddy icon for a 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
+ * @param account The account the user is on. + * @param username The username of the user. + * @param 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.
+ * @param icon_len The length of the icon data. + * @param checksum A protocol checksum from the protocol or @c NULL. purple_buddy_icons_set_for_user(PurpleAccount *account, const char *username,
@@ -230,9 +230,9 @@
* This avoids loading the icon image data from the cache if it's
* not already loaded for some other reason.
+ * @param buddy The buddy - * Returns: The checksum.
+ * @return The checksum. purple_buddy_icons_get_checksum_for_user(PurpleBuddy *buddy);
@@ -240,10 +240,10 @@
* Returns the buddy icon information for a user.
- * @account: The account the user is on.
- * @username: The username of the user.
+ * @param account The account the user is on. + * @param username The username of the user. - * Returns: The icon (with a reference for the caller) if found, or %NULL if
+ * @return The icon (with a reference for the caller) if found, or @c NULL if @@ -259,9 +259,9 @@
* needed, so it should be called in any case where you want the
- * @account: The account
+ * @param account The account - * Returns: The account's buddy icon image.
+ * @return The account's buddy icon image. purple_buddy_icons_find_account_icon(PurpleAccount *account);
@@ -272,12 +272,12 @@
* This function will deal with saving a record of the icon,
- * @account: The account for which to set a custom icon.
- * @icon_data: The image data of the icon, which the
+ * @param account The account for which to set a custom icon. + * @param icon_data The image data of the icon, which the * buddy icon code will free.
- * @icon_len: The length of the data in @a icon_data.
+ * @param icon_len The length of the data in @a icon_data. - * Returns: The icon that was set. The caller does NOT own
+ * @return The icon that was set. The caller does NOT own * a reference to this, and must call purple_imgstore_ref()
@@ -291,9 +291,9 @@
* This is intended for use in protocols that require a timestamp for
* buddy icon update reasons.
- * @account: The account
+ * @param account The account - * Returns: The time the icon was set, or 0 if an error occurred.
+ * @return The time the icon was set, or 0 if an error occurred. purple_buddy_icons_get_account_icon_timestamp(PurpleAccount *account);
@@ -301,9 +301,9 @@
* Returns a boolean indicating if a given blist node has a custom buddy icon.
- * @node: The blist node.
+ * @param node The blist node. - * Returns: A boolean indicating if @a node has a custom buddy icon.
+ * @return A boolean indicating if @a node has a custom buddy icon. purple_buddy_icons_node_has_custom_icon(PurpleBlistNode *node);
@@ -318,9 +318,9 @@
* needed, so it should be called in any case where you want the
+ * @param node The node. - * Returns: The custom buddy icon.
+ * @return The custom buddy icon. purple_buddy_icons_node_find_custom_icon(PurpleBlistNode *node);
@@ -331,12 +331,12 @@
* This function will deal with saving a record of the icon, caching the data,
- * @node: The blist node for which to set a custom icon.
- * @icon_data: The image data of the icon, which the buddy icon code will
+ * @param node The blist node for which to set a custom icon. + * @param icon_data The image data of the icon, which the buddy icon code will * free. Use NULL to unset the icon.
- * @icon_len: The length of the data in @a icon_data.
+ * @param icon_len The length of the data in @a icon_data. - * Returns: The icon that was set. The caller does NOT own a reference to this,
+ * @return The icon that was set. The caller does NOT own a reference to this, * and must call purple_imgstore_ref() if it wants one.
@@ -349,11 +349,11 @@
* Convenience wrapper around purple_buddy_icons_node_set_custom_icon.
* @see purple_buddy_icons_node_set_custom_icon()
- * @node: The blist node for which to set a custom icon.
- * @filename: The path to the icon to set for the blist node. Use NULL
+ * @param node The blist node for which to set a custom icon. + * @param filename The path to the icon to set for the blist node. Use NULL * to unset the custom icon.
- * Returns: The icon that was set. The caller does NOT own a reference to this,
+ * @return The icon that was set. The caller does NOT own a reference to this, * and must call purple_imgstore_ref() if it wants one.
@@ -363,7 +363,7 @@
* Sets whether or not buddy icon caching is enabled.
- * @caching: TRUE if buddy icon caching should be enabled, or
+ * @param caching TRUE if buddy icon caching should be enabled, or void purple_buddy_icons_set_caching(gboolean caching);
@@ -374,14 +374,14 @@
* The default is TRUE, unless otherwise specified by
* purple_buddy_icons_set_caching().
- * Returns: TRUE if buddy icon caching is enabled, or FALSE otherwise.
+ * @return TRUE if buddy icon caching is enabled, or FALSE otherwise. gboolean purple_buddy_icons_is_caching(void);
* Sets the directory used to store buddy icon cache files.
- * @cache_dir: The directory to store buddy icon cache files to.
+ * @param cache_dir The directory to store buddy icon cache files to. void purple_buddy_icons_set_cache_dir(const char *cache_dir);
@@ -391,14 +391,14 @@
* The default directory is PURPLEDIR/icons, unless otherwise specified
* by purple_buddy_icons_set_cache_dir().
- * Returns: The directory to store buddy icon cache files to.
+ * @return The directory to store buddy icon cache files to. const char *purple_buddy_icons_get_cache_dir(void);
* Returns the buddy icon subsystem handle.
- * Returns: The subsystem handle.
+ * @return The subsystem handle. void *purple_buddy_icons_get_handle(void);
@@ -427,16 +427,16 @@
* Creates a new #PurpleBuddyIconSpec instance.
- * @format: A comma-delimited list of image formats or %NULL if
+ * @param format A comma-delimited list of image formats or @c NULL if * icons are not supported
- * @min_width: Minimum width of an icon
- * @min_height: Minimum height of an icon
- * @max_width: Maximum width of an icon
- * @max_height: Maximum height of an icon
- * @max_filesize: Maximum file size in bytes
- * @scale_rules: How to stretch this icon
+ * @param min_width Minimum width of an icon + * @param min_height Minimum height of an icon + * @param max_width Maximum width of an icon + * @param max_height Maximum height of an icon + * @param max_filesize Maximum file size in bytes + * @param scale_rules How to stretch this icon - * Returns: A new buddy icon spec.
+ * @return A new buddy icon spec. PurpleBuddyIconSpec *purple_buddy_icon_spec_new(char *format, int min_width,
int min_height, int max_width, int max_height, size_t max_filesize,
--- a/libpurple/certificate.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/certificate.h Wed Jan 29 10:49:02 2014 +0530
@@ -93,8 +93,8 @@
* Callback function for the results of a verification check
- * @userdata: User-defined data
+ * @param st Status code + * @param userdata User-defined data typedef void (*PurpleCertificateVerifiedCallback)
(PurpleCertificateVerificationStatus st,
@@ -141,7 +141,7 @@
* Upon calling purple_certificate_register_pool() , this function will
* be called. May be NULL.
- * Returns: TRUE if the initialization succeeded, otherwise FALSE
+ * @return TRUE if the initialization succeeded, otherwise FALSE @@ -158,7 +158,7 @@
PurpleCertificate * (* get_cert)(const gchar *id);
/** Add a certificate to the pool. Must overwrite any other
* certificates sharing the same ID in the pool.
- * Returns: TRUE if the operation succeeded, otherwise FALSE
+ * @return TRUE if the operation succeeded, otherwise FALSE gboolean (* put_cert)(const gchar *id, PurpleCertificate *crt);
/** Delete a certificate from the pool */
@@ -200,8 +200,8 @@
/** Imports a certificate from a file
- * @filename: File to import the certificate from
- * Returns: Pointer to the newly allocated Certificate struct
+ * @param filename File to import the certificate from + * @return Pointer to the newly allocated Certificate struct PurpleCertificate * (* import_certificate)(const gchar * filename);
@@ -209,9 +209,9 @@
* Exports a certificate to a file
- * @filename: File to export the certificate to
- * @crt: Certificate to export
- * Returns: TRUE if the export succeeded, otherwise FALSE
+ * @param filename File to export the certificate to + * @param crt Certificate to export + * @return TRUE if the export succeeded, otherwise FALSE * @see purple_certificate_export()
gboolean (* export_certificate)(const gchar *filename, PurpleCertificate *crt);
@@ -222,7 +222,7 @@
* Certificates are generally assumed to be read-only, so feel free to
* do any sort of reference-counting magic you want here. If this ever
* changes, please remember to change the magic accordingly.
- * Returns: Reference to the new copy
+ * @return Reference to the new copy PurpleCertificate * (* copy_certificate)(PurpleCertificate *crt);
@@ -231,7 +231,7 @@
* Destroys a Certificate's internal data structures and calls
- * @crt: Certificate instance to be destroyed. It WILL NOT be
+ * @param crt Certificate instance to be destroyed. It WILL NOT be * destroyed if it is not of the correct
* CertificateScheme. Can be NULL
@@ -243,8 +243,8 @@
* Retrieves the certificate public key fingerprint using SHA1
- * @crt: Certificate instance
- * Returns: Binary representation of SHA1 hash - must be freed using
+ * @param crt Certificate instance + * @return Binary representation of SHA1 hash - must be freed using GByteArray * (* get_fingerprint_sha1)(PurpleCertificate *crt);
@@ -252,8 +252,8 @@
* Retrieves a unique certificate identifier
- * @crt: Certificate instance
- * Returns: Newly allocated string that can be used to uniquely
+ * @param crt Certificate instance + * @return Newly allocated string that can be used to uniquely * identify the certificate.
gchar * (* get_unique_id)(PurpleCertificate *crt);
@@ -261,8 +261,8 @@
* Retrieves a unique identifier for the certificate's issuer
- * @crt: Certificate instance
- * Returns: Newly allocated string that can be used to uniquely
+ * @param crt Certificate instance + * @return Newly allocated string that can be used to uniquely * identify the issuer's certificate.
gchar * (* get_issuer_unique_id)(PurpleCertificate *crt);
@@ -275,15 +275,15 @@
* @see purple_certificate_get_subject_name()
- * @crt: Certificate instance
- * Returns: Newly allocated string with the certificate subject.
+ * @param crt Certificate instance + * @return Newly allocated string with the certificate subject. gchar * (* get_subject_name)(PurpleCertificate *crt);
* Check the subject name against that on the certificate
* @see purple_certificate_check_subject_name()
- * Returns: TRUE if it is a match, else FALSE
+ * @return TRUE if it is a match, else FALSE gboolean (* check_subject_name)(PurpleCertificate *crt, const gchar *name);
@@ -292,8 +292,8 @@
/** Imports certificates from a file
- * @filename: File to import the certificates from
- * Returns: GSList of pointers to the newly allocated Certificate structs
+ * @param filename File to import the certificates from + * @return GSList of pointers to the newly allocated Certificate structs GSList * (* import_certificates)(const gchar * filename);
@@ -301,8 +301,8 @@
* Retrieves the certificate data in DER form
- * @crt: Certificate instance
- * Returns: Binary DER representation of certificate - must be freed using
+ * @param crt Certificate instance + * @return Binary DER representation of certificate - must be freed using GByteArray * (* get_der_data)(PurpleCertificate *crt);
@@ -310,8 +310,8 @@
* Retrieves a string representation of the certificate suitable for display
- * @crt: Certificate instance
- * Returns: User-displayable string representation of certificate - must be
+ * @param crt Certificate instance + * @return User-displayable string representation of certificate - must be gchar * (* get_display_string)(PurpleCertificate *crt);
@@ -349,7 +349,7 @@
* given VerificationRequest to check the certificate and callback
* the requester with the verification results.
- * @vrq: Request to process
+ * @param vrq Request to process void (* start_verification)(PurpleCertificateVerificationRequest *vrq);
@@ -359,7 +359,7 @@
* whatever PurpleCertificateVerificationRequest::data points to.
* It should not call free(vrq)
- * @vrq: Request to destroy
+ * @param vrq Request to destroy void (* destroy_request)(PurpleCertificateVerificationRequest *vrq);
@@ -421,22 +421,22 @@
* It is possible that the callback will be called immediately upon calling
* this function. Plan accordingly.
- * @verifier: Verification logic to use.
+ * @param verifier Verification logic to use. * @see purple_certificate_find_verifier()
- * @subject_name: Name that should match the first certificate in the
+ * @param subject_name Name that should match the first certificate in the * chain for the certificate to be valid. Will be strdup'd
* into the Request struct
- * @cert_chain: Certificate chain to check. If there is more than one
+ * @param cert_chain Certificate chain to check. If there is more than one * certificate in the chain (X.509), the peer's
* certificate comes first, then the issuer/signer's
* certificate, etc. The whole list is duplicated into the
- * @cb: Callback function to be called with whether the
+ * @param cb Callback function to be called with whether the * certificate was approved or not.
- * @cb_data: User-defined data for the above.
+ * @param cb_data User-defined data for the above. purple_certificate_verify (PurpleCertificateVerifier *verifier,
@@ -447,8 +447,8 @@
* Completes and destroys a VerificationRequest
- * @vrq: Request to conclude
- * @st: Success/failure code to pass to the request's
+ * @param vrq Request to conclude + * @param st Success/failure code to pass to the request's @@ -470,8 +470,8 @@
* Makes a duplicate of a certificate
- * @crt: Instance to duplicate
- * Returns: Pointer to new instance
+ * @param crt Instance to duplicate + * @return Pointer to new instance purple_certificate_copy(PurpleCertificate *crt);
@@ -479,8 +479,8 @@
* Duplicates an entire list of certificates
- * @crt_list: List to duplicate
- * Returns: New list copy
+ * @param crt_list List to duplicate + * @return New list copy purple_certificate_copy_list(GList *crt_list);
@@ -488,7 +488,7 @@
* Destroys and free()'s a Certificate
- * @crt: Instance to destroy. May be NULL.
+ * @param crt Instance to destroy. May be NULL. purple_certificate_destroy (PurpleCertificate *crt);
@@ -496,7 +496,7 @@
* Destroy an entire list of Certificate instances and the containing list
- * @crt_list: List of certificates to destroy. May be NULL.
+ * @param crt_list List of certificates to destroy. May be NULL. purple_certificate_destroy_list (GList * crt_list);
@@ -504,10 +504,10 @@
* Check whether 'crt' has a valid signature made by 'issuer'
- * @crt: Certificate instance to check signature of
- * @issuer: Certificate thought to have signed 'crt'
+ * @param crt Certificate instance to check signature of + * @param issuer Certificate thought to have signed 'crt' - * Returns: TRUE if 'crt' has a valid signature made by 'issuer',
+ * @return TRUE if 'crt' has a valid signature made by 'issuer', * @todo Find a way to give the reason (bad signature, not the issuer, etc.)
@@ -521,12 +521,12 @@
* in the chain carries a valid signature from the next. A single-certificate
* chain is considered to be valid.
- * @chain: List of PurpleCertificate instances comprising the chain,
+ * @param chain List of PurpleCertificate instances comprising the chain, * in the order certificate, issuer, issuer's issuer, etc.
- * @failing: A pointer to a PurpleCertificate*. If not NULL, if the
+ * @param failing A pointer to a PurpleCertificate*. If not NULL, if the * chain fails to validate, this will be set to the
* certificate whose signature could not be validated.
- * Returns: TRUE if the chain is valid. See description.
+ * @return TRUE if the chain is valid. See description. purple_certificate_check_signature_chain(GList *chain,
@@ -535,9 +535,9 @@
* Imports a PurpleCertificate from a file
- * @scheme: Scheme to import under
- * @filename: File path to import from
- * Returns: Pointer to a new PurpleCertificate, or NULL on failure
+ * @param scheme Scheme to import under + * @param filename File path to import from + * @return Pointer to a new PurpleCertificate, or NULL on failure purple_certificate_import(PurpleCertificateScheme *scheme, const gchar *filename);
@@ -545,9 +545,9 @@
* Imports a list of PurpleCertificates from a file
- * @scheme: Scheme to import under
- * @filename: File path to import from
- * Returns: Pointer to a GSList of new PurpleCertificates, or NULL on failure
+ * @param scheme Scheme to import under + * @param filename File path to import from + * @return Pointer to a GSList of new PurpleCertificates, or NULL on failure purple_certificates_import(PurpleCertificateScheme *scheme, const gchar *filename);
@@ -555,9 +555,9 @@
* Exports a PurpleCertificate to a file
- * @filename: File to export the certificate to
- * @crt: Certificate to export
- * Returns: TRUE if the export succeeded, otherwise FALSE
+ * @param filename File to export the certificate to + * @param crt Certificate to export + * @return TRUE if the export succeeded, otherwise FALSE purple_certificate_export(const gchar *filename, PurpleCertificate *crt);
@@ -566,8 +566,8 @@
* Retrieves the certificate public key fingerprint using SHA1.
- * @crt: Certificate instance
- * Returns: Binary representation of the hash. You are responsible for free()ing
+ * @param crt Certificate instance + * @return Binary representation of the hash. You are responsible for free()ing * @see purple_base16_encode_chunked()
@@ -577,8 +577,8 @@
* Get a unique identifier for the certificate
- * @crt: Certificate instance
- * Returns: String representing the certificate uniquely. Must be g_free()'ed
+ * @param crt Certificate instance + * @return String representing the certificate uniquely. Must be g_free()'ed purple_certificate_get_unique_id(PurpleCertificate *crt);
@@ -586,8 +586,8 @@
* Get a unique identifier for the certificate's issuer
- * @crt: Certificate instance
- * Returns: String representing the certificate's issuer uniquely. Must be
+ * @param crt Certificate instance + * @return String representing the certificate's issuer uniquely. Must be @@ -599,17 +599,17 @@
* For X.509, this is the "Common Name" field, as we're only using it
* for hostname verification at the moment
- * @crt: Certificate instance
- * Returns: Newly allocated string with the certificate subject.
+ * @param crt Certificate instance + * @return Newly allocated string with the certificate subject. purple_certificate_get_subject_name(PurpleCertificate *crt);
* Check the subject name against that on the certificate
- * @crt: Certificate instance
- * @name: Name to check.
- * Returns: TRUE if it is a match, else FALSE
+ * @param crt Certificate instance + * @param name Name to check. + * @return TRUE if it is a match, else FALSE purple_certificate_check_subject_name(PurpleCertificate *crt, const gchar *name);
@@ -617,12 +617,12 @@
* Get the expiration/activation times.
- * @crt: Certificate instance
- * @activation: Reference to store the activation time at. May be NULL
+ * @param crt Certificate instance + * @param activation Reference to store the activation time at. May be NULL * if you don't actually want it.
- * @expiration: Reference to store the expiration time at. May be NULL
+ * @param expiration Reference to store the expiration time at. May be NULL * if you don't actually want it.
- * Returns: TRUE if the requested values were obtained, otherwise FALSE.
+ * @return TRUE if the requested values were obtained, otherwise FALSE. purple_certificate_get_times(PurpleCertificate *crt, gint64 *activation, gint64 *expiration);
@@ -630,9 +630,9 @@
* Retrieves the certificate data in DER form.
- * @crt: Certificate instance
+ * @param crt Certificate instance - * Returns: Binary DER representation of the certificate - must be freed using
+ * @return Binary DER representation of the certificate - must be freed using @@ -641,9 +641,9 @@
* Retrieves a string suitable for displaying a certificate to the user.
- * @crt: Certificate instance
+ * @param crt Certificate instance - * Returns: String representing the certificate that may be displayed to the user
+ * @return String representing the certificate that may be displayed to the user * - must be freed using g_free().
@@ -670,9 +670,9 @@
* All components will be escaped for filesystem friendliness.
- * @pool: CertificatePool to build a path for
- * @id: Key to look up a Certificate by. May be NULL.
- * Returns: A newly allocated path of the form
+ * @param pool CertificatePool to build a path for + * @param id Key to look up a Certificate by. May be NULL. + * @return A newly allocated path of the form * ~/.purple/certificates/scheme_name/pool_name/unique_id
@@ -683,9 +683,9 @@
* Checks whether the associated CertificateScheme is loaded.
+ * @param pool Pool to check - * Returns: TRUE if the pool can be used, otherwise FALSE
+ * @return TRUE if the pool can be used, otherwise FALSE purple_certificate_pool_usable(PurpleCertificatePool *pool);
@@ -693,9 +693,9 @@
* Looks up the scheme the pool operates under
- * @pool: Pool to get the scheme of
+ * @param pool Pool to get the scheme of - * Returns: Pointer to the pool's scheme, or NULL if it isn't loaded.
+ * @return Pointer to the pool's scheme, or NULL if it isn't loaded. * @see purple_certificate_pool_usable()
PurpleCertificateScheme *
@@ -703,18 +703,18 @@
* Check for presence of an ID in a pool.
- * @pool: Pool to look in
- * Returns: TRUE if the ID is in the pool, else FALSE
+ * @param pool Pool to look in + * @param id ID to look for + * @return TRUE if the ID is in the pool, else FALSE purple_certificate_pool_contains(PurpleCertificatePool *pool, const gchar *id);
* Retrieve a certificate from a pool.
- * @pool: Pool to fish in
- * Returns: Retrieved certificate, or NULL if it wasn't there
+ * @param pool Pool to fish in + * @param id ID to look up + * @return Retrieved certificate, or NULL if it wasn't there purple_certificate_pool_retrieve(PurpleCertificatePool *pool, const gchar *id);
@@ -724,10 +724,10 @@
* Any pre-existing certificate of the same ID will be overwritten.
- * @pool: Pool to add to
- * @id: ID to store the certificate with
- * @crt: Certificate to store
- * Returns: TRUE if the operation succeeded, otherwise FALSE
+ * @param pool Pool to add to + * @param id ID to store the certificate with + * @param crt Certificate to store + * @return TRUE if the operation succeeded, otherwise FALSE purple_certificate_pool_store(PurpleCertificatePool *pool, const gchar *id, PurpleCertificate *crt);
@@ -735,9 +735,9 @@
* Remove a certificate from a pool
- * @pool: Pool to remove from
- * Returns: TRUE if the operation succeeded, otherwise FALSE
+ * @param pool Pool to remove from + * @param id ID to remove + * @return TRUE if the operation succeeded, otherwise FALSE purple_certificate_pool_delete(PurpleCertificatePool *pool, const gchar *id);
@@ -745,8 +745,8 @@
* Get the list of IDs currently in the pool.
- * @pool: Pool to enumerate
- * Returns: GList pointing to newly-allocated id strings. Free using
+ * @param pool Pool to enumerate + * @return GList pointing to newly-allocated id strings. Free using * purple_certificate_pool_destroy_idlist()
@@ -755,7 +755,7 @@
* Destroys the result given by purple_certificate_pool_get_idlist()
- * @idlist: ID List to destroy
+ * @param idlist ID List to destroy purple_certificate_pool_destroy_idlist(GList *idlist);
@@ -786,8 +786,8 @@
purple_certificate_get_handle(void);
/** Look up a registered CertificateScheme by name
- * @name: The scheme name. Case insensitive.
- * Returns: Pointer to the located Scheme, or NULL if it isn't found.
+ * @param name The scheme name. Case insensitive. + * @return Pointer to the located Scheme, or NULL if it isn't found. PurpleCertificateScheme *
purple_certificate_find_scheme(const gchar *name);
@@ -795,7 +795,7 @@
* Get all registered CertificateSchemes
- * Returns: GList pointing to all registered CertificateSchemes . This value
+ * @return GList pointing to all registered CertificateSchemes . This value @@ -806,26 +806,26 @@
* No two schemes can be registered with the same name; this function enforces
- * @scheme: Pointer to the scheme to register.
- * Returns: TRUE if the scheme was successfully added, otherwise FALSE
+ * @param scheme Pointer to the scheme to register. + * @return TRUE if the scheme was successfully added, otherwise FALSE purple_certificate_register_scheme(PurpleCertificateScheme *scheme);
/** Unregister a CertificateScheme from libpurple
- * @scheme: Scheme to unregister.
+ * @param scheme Scheme to unregister. * If the scheme is not registered, this is a no-op.
- * Returns: TRUE if the unregister completed successfully
+ * @return TRUE if the unregister completed successfully purple_certificate_unregister_scheme(PurpleCertificateScheme *scheme);
/** Look up a registered PurpleCertificateVerifier by scheme and name
- * @scheme_name: Scheme name. Case insensitive.
- * @ver_name: The verifier name. Case insensitive.
- * Returns: Pointer to the located Verifier, or NULL if it isn't found.
+ * @param scheme_name Scheme name. Case insensitive. + * @param ver_name The verifier name. Case insensitive. + * @return Pointer to the located Verifier, or NULL if it isn't found. PurpleCertificateVerifier *
purple_certificate_find_verifier(const gchar *scheme_name, const gchar *ver_name);
@@ -833,7 +833,7 @@
* Get the list of registered CertificateVerifiers
- * Returns: GList of all registered PurpleCertificateVerifier. This value
+ * @return GList of all registered PurpleCertificateVerifier. This value @@ -842,8 +842,8 @@
* Register a CertificateVerifier with libpurple
- * @vr: Verifier to register.
- * Returns: TRUE if register succeeded, otherwise FALSE
+ * @param vr Verifier to register. + * @return TRUE if register succeeded, otherwise FALSE purple_certificate_register_verifier(PurpleCertificateVerifier *vr);
@@ -851,16 +851,16 @@
* Unregister a CertificateVerifier with libpurple
- * @vr: Verifier to unregister.
- * Returns: TRUE if unregister succeeded, otherwise FALSE
+ * @param vr Verifier to unregister. + * @return TRUE if unregister succeeded, otherwise FALSE purple_certificate_unregister_verifier(PurpleCertificateVerifier *vr);
/** Look up a registered PurpleCertificatePool by scheme and name
- * @scheme_name: Scheme name. Case insensitive.
- * @pool_name: Pool name. Case insensitive.
- * Returns: Pointer to the located Pool, or NULL if it isn't found.
+ * @param scheme_name Scheme name. Case insensitive. + * @param pool_name Pool name. Case insensitive. + * @return Pointer to the located Pool, or NULL if it isn't found. purple_certificate_find_pool(const gchar *scheme_name, const gchar *pool_name);
@@ -868,7 +868,7 @@
* Get the list of registered Pools
- * Returns: GList of all registered PurpleCertificatePool s. This value
+ * @return GList of all registered PurpleCertificatePool s. This value @@ -877,8 +877,8 @@
* Register a CertificatePool with libpurple and call its init function
- * @pool: Pool to register.
- * Returns: TRUE if the register succeeded, otherwise FALSE
+ * @param pool Pool to register. + * @return TRUE if the register succeeded, otherwise FALSE purple_certificate_register_pool(PurpleCertificatePool *pool);
@@ -886,8 +886,8 @@
* Unregister a CertificatePool with libpurple and call its uninit function
- * @pool: Pool to unregister.
- * Returns: TRUE if the unregister succeeded, otherwise FALSE
+ * @param pool Pool to unregister. + * @return TRUE if the unregister succeeded, otherwise FALSE purple_certificate_unregister_pool(PurpleCertificatePool *pool);
@@ -898,7 +898,7 @@
* Add a search path for certificates.
- * @path: Path to search for certificates.
+ * @param path Path to search for certificates. void purple_certificate_add_ca_search_path(const char *path);
--- a/libpurple/conversation.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/conversation.h Wed Jan 29 10:49:02 2014 +0530
@@ -123,7 +123,7 @@
* The conversation can be an IM or a chat.
- * Note: When a conversation is destroyed with the last g_object_unref(), the
+ * @note When a conversation is destroyed with the last g_object_unref(), the * specified conversation is removed from the parent window. If this
* conversation is the only one contained in the parent window, that
* window is also destroyed.
@@ -178,14 +178,14 @@
/** Called just before @a conv is freed. */
void (*destroy_conversation)(PurpleConversation *conv);
- /** Write a message to a chat. If this field is %NULL, libpurple will
+ /** Write a message to a chat. If this field is @c NULL, libpurple will * fall back to using #write_conv.
* @see purple_chat_conversation_write()
void (*write_chat)(PurpleChatConversation *chat, const char *who,
const char *message, PurpleMessageFlags flags,
- /** Write a message to an IM conversation. If this field is %NULL,
+ /** Write a message to an IM conversation. If this field is @c NULL, * libpurple will fall back to using #write_conv.
* @see purple_im_conversation_write()
@@ -208,8 +208,8 @@
/** Add @a cbuddies to a chat.
- * @cbuddies: A @c GList of #PurpleChatUser structs.
- * @new_arrivals: Whether join notices should be shown.
+ * @param cbuddies A @c GList of #PurpleChatUser structs. + * @param new_arrivals Whether join notices should be shown. * (Join notices are actually written to the
* #purple_chat_conversation_add_users().)
@@ -219,13 +219,13 @@
/** Rename the user in this chat named @a old_name to @a new_name. (The
* rename message is written to the conversation by libpurple.)
- * @new_alias: @a new_name's new alias, if they have one.
+ * @param new_alias @a new_name's new alias, if they have one. * @see purple_chat_conversation_add_users()
void (*chat_rename_user)(PurpleChatConversation *chat, const char *old_name,
const char *new_name, const char *new_alias);
/** Remove @a users from a chat.
- * @users: A @c GList of <tt>const char *</tt>s.
+ * @param users A @c GList of <tt>const char *</tt>s. * @see purple_chat_conversation_rename_user()
void (*chat_remove_users)(PurpleChatConversation *chat, GList *users);
@@ -240,8 +240,8 @@
void (*present)(PurpleConversation *conv);
/** If this UI has a concept of focus (as in a windowing system) and
- * this conversation has the focus, return %TRUE; otherwise, return
+ * this conversation has the focus, return @c TRUE; otherwise, return gboolean (*has_focus)(PurpleConversation *conv);
@@ -254,7 +254,7 @@
/** Prompt the user for confirmation to send @a message. This function
* should arrange for the message to be sent if the user accepts. If
- * this field is %NULL, libpurple will fall back to using
+ * this field is @c NULL, libpurple will fall back to using * #purple_request_action().
void (*send_confirm)(PurpleConversation *conv, const char *message);
@@ -281,15 +281,15 @@
* Present a conversation to the user. This allows core code to initiate a
* conversation by displaying the IM dialog.
- * @conv: The conversation to present
+ * @param conv The conversation to present void purple_conversation_present(PurpleConversation *conv);
* Sets the specified conversation's UI operations structure.
- * @conv: The conversation.
- * @ops: The UI conversation operations structure.
+ * @param conv The conversation. + * @param ops The UI conversation operations structure. void purple_conversation_set_ui_ops(PurpleConversation *conv,
PurpleConversationUiOps *ops);
@@ -297,9 +297,9 @@
* Returns the specified conversation's UI operations structure.
- * @conv: The conversation.
+ * @param conv The conversation. - * Returns: The operations structure.
+ * @return The operations structure. PurpleConversationUiOps *purple_conversation_get_ui_ops(const PurpleConversation *conv);
@@ -309,8 +309,8 @@
* This purple_account represents the user using purple, not the person the user
* is having a conversation/chat/flame with.
- * @conv: The conversation.
- * @account: The purple_account.
+ * @param conv The conversation. + * @param account The purple_account. void purple_conversation_set_account(PurpleConversation *conv,
@@ -321,35 +321,35 @@
* This purple_account represents the user using purple, not the person the user
* is having a conversation/chat/flame with.
- * @conv: The conversation.
+ * @param conv The conversation. - * Returns: The conversation's purple_account.
+ * @return The conversation's purple_account. PurpleAccount *purple_conversation_get_account(const PurpleConversation *conv);
* Returns the specified conversation's purple_connection.
- * @conv: The conversation.
+ * @param conv The conversation. - * Returns: The conversation's purple_connection.
+ * @return The conversation's purple_connection. PurpleConnection *purple_conversation_get_connection(const PurpleConversation *conv);
* Sets the specified conversation's title.
- * @conv: The conversation.
+ * @param conv The conversation. + * @param title The title. void purple_conversation_set_title(PurpleConversation *conv, const char *title);
* Returns the specified conversation's title.
- * @conv: The conversation.
+ * @param conv The conversation.
const char *purple_conversation_get_title(const PurpleConversation *conv);
@@ -359,24 +359,24 @@
* This function takes OPT_IM_ALIAS_TAB into account, as well as the
- * @conv: The conversation.
+ * @param conv The conversation. void purple_conversation_autoset_title(PurpleConversation *conv);
* Sets the specified conversation's name.
- * @conv: The conversation.
- * @name: The conversation's name.
+ * @param conv The conversation. + * @param name The conversation's name. void purple_conversation_set_name(PurpleConversation *conv, const char *name);
* Returns the specified conversation's name.
- * @conv: The conversation.
+ * @param conv The conversation. - * Returns: The conversation's name. If the conversation is an IM with a PurpleBuddy,
+ * @return The conversation's name. If the conversation is an IM with a PurpleBuddy, * then it's the name of the PurpleBuddy.
const char *purple_conversation_get_name(const PurpleConversation *conv);
@@ -384,8 +384,8 @@
* Sets current E2EE state for the conversation.
- * @conv: The conversation.
- * @state: The E2EE state.
+ * @param conv The conversation. + * @param state The E2EE state. purple_conversation_set_e2ee_state(PurpleConversation *conv,
@@ -394,9 +394,9 @@
* Gets current conversation's E2EE state.
- * @conv: The conversation.
+ * @param conv The conversation. - * Returns: Current E2EE state for conversation.
+ * @return Current E2EE state for conversation. purple_conversation_get_e2ee_state(PurpleConversation *conv);
@@ -404,17 +404,17 @@
* Enables or disables logging for this conversation.
- * @conv: The conversation.
- * @log: %TRUE if logging should be enabled, or %FALSE otherwise.
+ * @param conv The conversation. + * @param log @c TRUE if logging should be enabled, or @c FALSE otherwise. void purple_conversation_set_logging(PurpleConversation *conv, gboolean log);
* Returns whether or not logging is enabled for this conversation.
- * @conv: The conversation.
+ * @param conv The conversation. - * Returns: %TRUE if logging is enabled, or %FALSE otherwise.
+ * @return @c TRUE if logging is enabled, or @c FALSE otherwise. gboolean purple_conversation_is_logging(const PurpleConversation *conv);
@@ -425,7 +425,7 @@
* message, if the conversation has logging enabled. To disable logging for
* the remainder of the conversation, use purple_conversation_set_logging().
- * @conv: The conversation.
+ * @param conv The conversation. void purple_conversation_close_logs(PurpleConversation *conv);
@@ -441,11 +441,11 @@
* This can be used to write generic messages, such as "so and so closed
* the conversation window."
- * @conv: The conversation.
- * @who: The user who sent the message.
- * @message: The message.
- * @flags: The message flags.
- * @mtime: The time the message was sent.
+ * @param conv The conversation. + * @param who The user who sent the message. + * @param message The message. + * @param flags The message flags. + * @param mtime The time the message was sent. * @see purple_conversation_write_message()
@@ -456,11 +456,11 @@
* Writes to a chat or an IM.
- * @conv: The conversation.
- * @who: The user who sent the message.
- * @message: The message to write.
- * @flags: The message flags.
- * @mtime: The time the message was sent.
+ * @param conv The conversation. + * @param who The user who sent the message. + * @param message The message to write. + * @param flags The message flags. + * @param mtime The time the message was sent. void purple_conversation_write_message(PurpleConversation *conv,
const char *who, const char *message,
@@ -470,17 +470,17 @@
* Sends a message to this conversation. This function calls
* purple_conversation_send_with_flags() with no additional flags.
- * @conv: The conversation.
- * @message: The message to send.
+ * @param conv The conversation. + * @param message The message to send. void purple_conversation_send(PurpleConversation *conv, const char *message);
* Sends a message to this conversation with specified flags.
- * @conv: The conversation.
- * @message: The message to send.
- * @flags: The PurpleMessageFlags flags to use in addition to
+ * @param conv The conversation. + * @param message The message to send. + * @param flags The PurpleMessageFlags flags to use in addition to void purple_conversation_send_with_flags(PurpleConversation *conv, const char *message,
@@ -488,8 +488,8 @@
Set the features as supported for the given conversation.
- @conv: The conversation
- @features: Bitset defining supported features
+ @param conv The conversation + @param features Bitset defining supported features void purple_conversation_set_features(PurpleConversation *conv,
PurpleConnectionFlags features);
@@ -497,16 +497,16 @@
Get the features supported by the given conversation.
- @conv: The conversation
+ @param conv The conversation PurpleConnectionFlags purple_conversation_get_features(PurpleConversation *conv);
* Determines if a conversation has focus
- * @conv: The conversation.
+ * @param conv The conversation. - * Returns: %TRUE if the conversation has focus, %FALSE if
+ * @return @c TRUE if the conversation has focus, @c FALSE if * it does not or the UI does not have a concept of conversation focus
gboolean purple_conversation_has_focus(PurpleConversation *conv);
@@ -514,17 +514,17 @@
* Updates the visual status and UI of a conversation.
- * @conv: The conversation.
- * @type: The update type.
+ * @param conv The conversation. + * @param type The update type. void purple_conversation_update(PurpleConversation *conv, PurpleConversationUpdateType type);
* Retrieve the message history of a conversation.
- * @conv: The conversation
+ * @param conv The conversation - * Returns: A GList of PurpleConversationMessage's. The must not modify the list or the data within.
+ * @return A GList of PurpleConversationMessage's. The must not modify the list or the data within. * The list contains the newest message at the beginning, and the oldest message at
@@ -533,24 +533,24 @@
* Clear the message history of a conversation.
- * @conv: The conversation
+ * @param conv The conversation void purple_conversation_clear_message_history(PurpleConversation *conv);
* Set the UI data associated with this conversation.
- * @conv: The conversation.
- * @ui_data: A pointer to associate with this conversation.
+ * @param conv The conversation. + * @param ui_data A pointer to associate with this conversation. void purple_conversation_set_ui_data(PurpleConversation *conv, gpointer ui_data);
* Get the UI data associated with this conversation.
- * @conv: The conversation.
+ * @param conv The conversation. - * Returns: The UI data associated with this conversation. This is a
+ * @return The UI data associated with this conversation. This is a * convenience field provided to the UIs--it is not
* used by the libpurple core.
@@ -565,28 +565,28 @@
* The confirmation ensures that the user isn't sending a
- * @conv: The conversation.
- * @message: The message to send.
+ * @param conv The conversation. + * @param message The message to send. void purple_conversation_send_confirm(PurpleConversation *conv, const char *message);
* Adds a smiley to the conversation's smiley tree. If this returns
- * %TRUE you should call purple_conversation_custom_smiley_write() one or more
+ * @c TRUE you should call purple_conversation_custom_smiley_write() one or more * times, and then purple_conversation_custom_smiley_close(). If this returns
- * %FALSE, either the conv or smile were invalid, or the icon was
+ * @c FALSE, either the conv or smile were invalid, or the icon was * found in the cache. In either case, calling write or close would
- * @conv: The conversation to associate the smiley with.
- * @smile: The text associated with the smiley
- * @cksum_type: The type of checksum.
- * @chksum: The checksum, as a NUL terminated base64 string.
- * @remote: %TRUE if the custom smiley is set by the remote user (buddy).
- * Returns: %TRUE if an icon is expected, else FALSE. Note that
+ * @param conv The conversation to associate the smiley with. + * @param smile The text associated with the smiley + * @param cksum_type The type of checksum. + * @param chksum The checksum, as a NUL terminated base64 string. + * @param remote @c TRUE if the custom smiley is set by the remote user (buddy). + * @return @c TRUE if an icon is expected, else FALSE. Note that * it is an error to never call purple_conversation_custom_smiley_close if
- * this function returns %TRUE, but an error to call it if
+ * this function returns @c TRUE, but an error to call it if + * @c FALSE is returned. gboolean purple_conversation_custom_smiley_add(PurpleConversation *conv, const char *smile,
@@ -596,10 +596,10 @@
* Updates the image associated with the current smiley.
- * @conv: The conversation associated with the smiley.
- * @smile: The text associated with the smiley.
- * @data: The actual image data.
- * @size: The length of the data.
+ * @param conv The conversation associated with the smiley. + * @param smile The text associated with the smiley. + * @param data The actual image data. + * @param size The length of the data. void purple_conversation_custom_smiley_write(PurpleConversation *conv,
@@ -612,8 +612,8 @@
* purple_conversation_custom_smiley_write, and it is no longer valid
* to call that function on that smiley.
- * @conv: The purple conversation associated with the smiley.
- * @smile: The text associated with the smiley
+ * @param conv The purple conversation associated with the smiley. + * @param smile The text associated with the smiley void purple_conversation_custom_smiley_close(PurpleConversation *conv, const char *smile);
@@ -621,9 +621,9 @@
* Retrieves the extended menu items for the conversation.
- * @conv: The conversation.
+ * @param conv The conversation. - * Returns: A list of PurpleMenuAction items, harvested by the
+ * @return A list of PurpleMenuAction items, harvested by the * chat-extended-menu signal. The list and the menuaction
* items should be freed by the caller.
@@ -632,13 +632,13 @@
* Perform a command in a conversation. Similar to @see purple_cmd_do_command
- * @conv: The conversation.
- * @cmdline: The entire command including the arguments.
- * @markup: %NULL, or the formatted command line.
- * @error: If the command failed errormsg is filled in with the appropriate error
- * message, if not %NULL. It must be freed by the caller with g_free().
+ * @param conv The conversation. + * @param cmdline The entire command including the arguments. + * @param markup @c NULL, or the formatted command line. + * @param error If the command failed errormsg is filled in with the appropriate error + * message, if not @c NULL. It must be freed by the caller with g_free(). - * Returns: %TRUE if the command was executed successfully, %FALSE otherwise.
+ * @return @c TRUE if the command was executed successfully, @c FALSE otherwise. gboolean purple_conversation_do_command(PurpleConversation *conv,
const gchar *cmdline, const gchar *markup, gchar **error);
@@ -648,9 +648,9 @@
* @see PurplePluginProtocolInfo#get_max_message_size
- * @conv: The conversation to query.
+ * @param conv The conversation to query. - * Returns: Maximum message size, 0 if unspecified, -1 for infinite.
+ * @return Maximum message size, 0 if unspecified, -1 for infinite. purple_conversation_get_max_message_size(PurpleConversation *conv);
@@ -670,10 +670,10 @@
* the function will return FALSE and the calling function can attempt to present
* the error another way (purple_notify_error, most likely)
- * @who: The user this error is about
- * @account: The account this error is on
- * Returns: TRUE if the error was presented, else FALSE
+ * @param who The user this error is about + * @param account The account this error is on + * @param what The error + * @return TRUE if the error was presented, else FALSE gboolean purple_conversation_present_error(const char *who, PurpleAccount *account, const char *what);
@@ -692,54 +692,54 @@
* Get the sender from a PurpleConversationMessage
- * @msg: A PurpleConversationMessage
+ * @param msg A PurpleConversationMessage - * Returns: The name of the sender of the message
+ * @return The name of the sender of the message const char *purple_conversation_message_get_sender(const PurpleConversationMessage *msg);
* Get the message from a PurpleConversationMessage
- * @msg: A PurpleConversationMessage
+ * @param msg A PurpleConversationMessage - * Returns: The name of the sender of the message
+ * @return The name of the sender of the message const char *purple_conversation_message_get_message(const PurpleConversationMessage *msg);
* Get the message-flags of a PurpleConversationMessage
- * @msg: A PurpleConversationMessage
+ * @param msg A PurpleConversationMessage - * Returns: The message flags
+ * @return The message flags PurpleMessageFlags purple_conversation_message_get_flags(const PurpleConversationMessage *msg);
* Get the timestamp of a PurpleConversationMessage
- * @msg: A PurpleConversationMessage
+ * @param msg A PurpleConversationMessage - * Returns: The timestamp of the message
+ * @return The timestamp of the message time_t purple_conversation_message_get_timestamp(const PurpleConversationMessage *msg);
* Get the alias from a PurpleConversationMessage
- * @msg: A PurpleConversationMessage
+ * @param msg A PurpleConversationMessage - * Returns: The alias of the sender of the message
+ * @return The alias of the sender of the message const char *purple_conversation_message_get_alias(const PurpleConversationMessage *msg);
* Get the conversation associated with the PurpleConversationMessage
- * @msg: A PurpleConversationMessage
+ * @param msg A PurpleConversationMessage - * Returns: The conversation
+ * @return The conversation PurpleConversation *purple_conversation_message_get_conversation(const PurpleConversationMessage *msg);
--- a/libpurple/conversationtypes.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/conversationtypes.h Wed Jan 29 10:49:02 2014 +0530
@@ -174,11 +174,11 @@
* Creates a new IM conversation.
- * @account: The account opening the conversation window on the purple
+ * @param account The account opening the conversation window on the purple - * @name: Name of the buddy.
+ * @param name Name of the buddy. - * Returns: The new conversation.
+ * @return The new conversation. PurpleIMConversation *purple_im_conversation_new(PurpleAccount *account,
@@ -189,8 +189,8 @@
* This should only be called from within Purple. You probably want to
* call purple_buddy_icon_set_data().
- * @icon: The buddy icon.
+ * @param icon The buddy icon. * @see purple_buddy_icon_set_data()
@@ -199,34 +199,34 @@
* Returns the IM's buddy icon.
- * Returns: The buddy icon.
+ * @return The buddy icon. PurpleBuddyIcon *purple_im_conversation_get_icon(const PurpleIMConversation *im);
* Sets the IM's typing state.
- * @state: The typing state.
+ * @param state The typing state. void purple_im_conversation_set_typing_state(PurpleIMConversation *im, PurpleIMTypingState state);
* Returns the IM's typing state.
- * Returns: The IM's typing state.
+ * @return The IM's typing state. PurpleIMTypingState purple_im_conversation_get_typing_state(const PurpleIMConversation *im);
* Starts the IM's typing timeout.
- * @timeout: How long in seconds to wait before setting the typing state
+ * @param timeout How long in seconds to wait before setting the typing state * to PURPLE_IM_NOT_TYPING.
void purple_im_conversation_start_typing_timeout(PurpleIMConversation *im, int timeout);
@@ -234,16 +234,16 @@
* Stops the IM's typing timeout.
void purple_im_conversation_stop_typing_timeout(PurpleIMConversation *im);
* Returns the IM's typing timeout.
- * Returns: The timeout.
guint purple_im_conversation_get_typing_timeout(const PurpleIMConversation *im);
@@ -253,8 +253,8 @@
* typing after this quiet-period, then another PURPLE_IM_TYPING message
- * @val: The number of seconds to wait before allowing another
+ * @param val The number of seconds to wait before allowing another * PURPLE_IM_TYPING message to be sent to the user. Or 0 to
* not send another PURPLE_IM_TYPING message.
@@ -263,9 +263,9 @@
* Returns the time after which another PURPLE_IM_TYPING message should be sent.
- * Returns: The time in seconds since the epoch. Or 0 if no additional
+ * @return The time in seconds since the epoch. Or 0 if no additional * PURPLE_IM_TYPING message should be sent.
time_t purple_im_conversation_get_type_again(const PurpleIMConversation *im);
@@ -273,30 +273,30 @@
* Starts the IM's type again timeout.
void purple_im_conversation_start_send_typed_timeout(PurpleIMConversation *im);
* Stops the IM's type again timeout.
void purple_im_conversation_stop_send_typed_timeout(PurpleIMConversation *im);
* Returns the IM's type again timeout interval.
- * Returns: The type again timeout interval.
+ * @return The type again timeout interval. guint purple_im_conversation_get_send_typed_timeout(const PurpleIMConversation *im);
* Updates the visual typing notification for an IM conversation.
void purple_im_conversation_update_typing(PurpleIMConversation *im);
@@ -315,11 +315,11 @@
* Creates a new chat conversation.
- * @account: The account opening the conversation window on the purple
+ * @param account The account opening the conversation window on the purple - * @name: The name of the conversation.
+ * @param name The name of the conversation. - * Returns: The new conversation.
+ * @return The new conversation. PurpleChatConversation *purple_chat_conversation_new(PurpleAccount *account,
@@ -328,44 +328,44 @@
* Returns a list of users in the chat room. The members of the list
* are PurpleChatUser objects.
+ * @param chat The chat. - * Returns: (transfer none): The list of users.
+ * @constreturn The list of users. GList *purple_chat_conversation_get_users(const PurpleChatConversation *chat);
* Ignores a user in a chat room.
- * @name: The name of the user.
+ * @param chat The chat. + * @param name The name of the user. void purple_chat_conversation_ignore(PurpleChatConversation *chat, const char *name);
* Unignores a user in a chat room.
- * @name: The name of the user.
+ * @param chat The chat. + * @param name The name of the user. void purple_chat_conversation_unignore(PurpleChatConversation *chat, const char *name);
* Sets the list of ignored users in the chat room.
- * @ignored: The list of ignored users.
+ * @param chat The chat. + * @param ignored The list of ignored users. - * Returns: The list passed.
+ * @return The list passed. GList *purple_chat_conversation_set_ignored(PurpleChatConversation *chat, GList *ignored);
* Returns the list of ignored users in the chat room.
+ * @param chat The chat. - * Returns: (transfer none): The list of ignored users.
+ * @constreturn The list of ignored users. GList *purple_chat_conversation_get_ignored(const PurpleChatConversation *chat);
@@ -377,22 +377,22 @@
* returned. The username passed to the function does not have to have this
- * @user: The user to check in the ignore list.
+ * @param chat The chat. + * @param user The user to check in the ignore list. - * Returns: The ignored user if found, complete with prefixes, or %NULL
+ * @return The ignored user if found, complete with prefixes, or @c NULL const char *purple_chat_conversation_get_ignored_user(const PurpleChatConversation *chat,
- * Returns %TRUE if the specified user is ignored.
+ * Returns @c TRUE if the specified user is ignored.
+ * @param chat The chat. + * @param user The user. - * Returns: %TRUE if the user is in the ignore list; %FALSE otherwise.
+ * @return @c TRUE if the user is in the ignore list; @c FALSE otherwise. gboolean purple_chat_conversation_is_ignored_user(const PurpleChatConversation *chat,
@@ -400,9 +400,9 @@
* Sets the chat room's topic.
- * @who: The user that set the topic.
+ * @param chat The chat. + * @param who The user that set the topic. + * @param topic The topic. void purple_chat_conversation_set_topic(PurpleChatConversation *chat, const char *who,
@@ -410,46 +410,46 @@
* Returns the chat room's topic.
+ * @param chat The chat. - * Returns: The chat's topic.
+ * @return The chat's topic. const char *purple_chat_conversation_get_topic(const PurpleChatConversation *chat);
* Returns who set the chat room's topic.
+ * @param chat The chat. - * Returns: Who set the topic.
+ * @return Who set the topic. const char *purple_chat_conversation_get_topic_who(const PurpleChatConversation *chat);
* Sets the chat room's ID.
+ * @param chat The chat. void purple_chat_conversation_set_id(PurpleChatConversation *chat, int id);
* Returns the chat room's ID.
+ * @param chat The chat.
int purple_chat_conversation_get_id(const PurpleChatConversation *chat);
- * @user: The user to add.
- * @extra_msg: An extra message to display with the join message.
- * @flags: The users flags
- * @new_arrival: Decides whether or not to show a join notice.
+ * @param chat The chat. + * @param user The user to add. + * @param extra_msg An extra message to display with the join message. + * @param flags The users flags + * @param new_arrival Decides whether or not to show a join notice. void purple_chat_conversation_add_user(PurpleChatConversation *chat, const char *user,
const char *extra_msg, PurpleChatUserFlags flags,
@@ -461,16 +461,16 @@
* The data is copied from @a users, @a extra_msgs, and @a flags, so it is up to
* the caller to free this list after calling this function.
- * @users: The list of users to add.
- * @extra_msgs: An extra message to display with the join message for each
+ * @param chat The chat. + * @param users The list of users to add. + * @param extra_msgs An extra message to display with the join message for each * user. This list may be shorter than @a users, in which
* case, the users after the end of extra_msgs will not have
* an extra message. By extension, this means that extra_msgs
- * can simply be %NULL and none of the users will have an
+ * can simply be @c NULL and none of the users will have an - * @flags: The list of flags for each user.
- * @new_arrivals: Decides whether or not to show join notices.
+ * @param flags The list of flags for each user. + * @param new_arrivals Decides whether or not to show join notices. void purple_chat_conversation_add_users(PurpleChatConversation *chat,
GList *users, GList *extra_msgs, GList *flags, gboolean new_arrivals);
@@ -478,9 +478,9 @@
* Renames a user in a chat.
- * @old_user: The old username.
- * @new_user: The new username.
+ * @param chat The chat. + * @param old_user The old username. + * @param new_user The new username. void purple_chat_conversation_rename_user(PurpleChatConversation *chat,
const char *old_user, const char *new_user);
@@ -490,9 +490,9 @@
* It is up to the developer to free this list after calling this function.
- * @user: The user that is being removed.
- * @reason: The optional reason given for the removal. Can be %NULL.
+ * @param chat The chat. + * @param user The user that is being removed. + * @param reason The optional reason given for the removal. Can be @c NULL. void purple_chat_conversation_remove_user(PurpleChatConversation *chat,
const char *user, const char *reason);
@@ -500,9 +500,9 @@
* Removes a list of users from a chat, optionally with a single reason.
- * @users: The users that are being removed.
- * @reason: The optional reason given for the removal. Can be %NULL.
+ * @param chat The chat. + * @param users The users that are being removed. + * @param reason The optional reason given for the removal. Can be @c NULL. void purple_chat_conversation_remove_users(PurpleChatConversation *chat,
GList *users, const char *reason);
@@ -510,10 +510,10 @@
* Checks if a user is in a chat
- * @user: The user to look for.
+ * @param chat The chat. + * @param user The user to look for. - * Returns: TRUE if the user is in the chat, FALSE if not
+ * @return TRUE if the user is in the chat, FALSE if not gboolean purple_chat_conversation_has_user(PurpleChatConversation *chat,
@@ -521,15 +521,15 @@
* Clears all users from a chat.
+ * @param chat The chat. void purple_chat_conversation_clear_users(PurpleChatConversation *chat);
* Sets your nickname (used for hilighting) for a chat.
+ * @param chat The chat. + * @param nick The nick. void purple_chat_conversation_set_nick(PurpleChatConversation *chat,
@@ -537,8 +537,8 @@
* Gets your nickname (used for hilighting) for a chat.
+ * @param chat The chat. const char *purple_chat_conversation_get_nick(PurpleChatConversation *chat);
@@ -546,15 +546,15 @@
* Lets the core know we left a chat, without destroying it.
* Called from serv_got_chat_left().
+ * @param chat The chat. void purple_chat_conversation_leave(PurpleChatConversation *chat);
* Find a chat user in a chat
- * @name: The name of the chat user to find.
+ * @param chat The chat. + * @param name The name of the chat user to find. PurpleChatUser *purple_chat_conversation_find_user(PurpleChatConversation *chat,
@@ -564,11 +564,11 @@
* The user will be prompted to enter the user's name or a message if one is
- * @user: The user to invite to the chat.
- * @message: The message to send with the invitation.
- * @confirm: Prompt before sending the invitation. The user is always
- * prompted if either \a user or \a message is %NULL.
+ * @param chat The chat. + * @param user The user to invite to the chat. + * @param message The message to send with the invitation. + * @param confirm Prompt before sending the invitation. The user is always + * prompted if either \a user or \a message is @c NULL. void purple_chat_conversation_invite_user(PurpleChatConversation *chat,
const char *user, const char *message, gboolean confirm);
@@ -577,9 +577,9 @@
* Returns true if we're no longer in this chat,
* and just left the window open.
+ * @param chat The chat. - * Returns: %TRUE if we left the chat already, %FALSE if
+ * @return @c TRUE if we left the chat already, @c FALSE if gboolean purple_chat_conversation_has_left(PurpleChatConversation *chat);
@@ -599,8 +599,8 @@
* Set the chat conversation associated with this chat user.
- * @chat: The chat conversation that the buddy belongs to.
+ * @param cb The chat user + * @param chat The chat conversation that the buddy belongs to. void purple_chat_user_set_chat(PurpleChatUser *cb,
PurpleChatConversation *chat);
@@ -608,21 +608,21 @@
* Get the chat conversation associated with this chat user.
+ * @param cb The chat user. - * Returns: The chat conversation that the buddy belongs to.
+ * @return The chat conversation that the buddy belongs to. PurpleChatConversation *purple_chat_user_get_chat(const PurpleChatUser *cb);
* Creates a new chat user
- * @chat: The chat that the buddy belongs to.
+ * @param chat The chat that the buddy belongs to. + * @param name The name. + * @param alias The alias. + * @param flags The flags. - * Returns: The new chat user
+ * @return The new chat user PurpleChatUser *purple_chat_user_new(PurpleChatConversation *chat,
const char *name, const char *alias, PurpleChatUserFlags flags);
@@ -630,17 +630,17 @@
* Set the UI data associated with this chat user.
- * @ui_data: A pointer to associate with this chat user.
+ * @param cb The chat user + * @param ui_data A pointer to associate with this chat user. void purple_chat_user_set_ui_data(PurpleChatUser *cb, gpointer ui_data);
* Get the UI data associated with this chat user.
+ * @param cb The chat user. - * Returns: The UI data associated with this chat user. This is a
+ * @return The UI data associated with this chat user. This is a * convenience field provided to the UIs--it is not
* used by the libpurple core.
@@ -649,44 +649,44 @@
* Get the alias of a chat user
+ * @param cb The chat user. - * Returns: The alias of the chat user.
+ * @return The alias of the chat user. const char *purple_chat_user_get_alias(const PurpleChatUser *cb);
* Get the name of a chat user
+ * @param cb The chat user. - * Returns: The name of the chat user.
+ * @return The name of the chat user. const char *purple_chat_user_get_name(const PurpleChatUser *cb);
* Set the flags of a chat user.
- * @flags: The new flags.
+ * @param cb The chat user. + * @param flags The new flags. void purple_chat_user_set_flags(PurpleChatUser *cb, PurpleChatUserFlags flags);
* Get the flags of a chat user.
+ * @param cb The chat user. - * Returns: The flags of the chat user.
+ * @return The flags of the chat user. PurpleChatUserFlags purple_chat_user_get_flags(const PurpleChatUser *cb);
* Indicates if this chat user is on the buddy list.
+ * @param cb The chat user. - * Returns: TRUE if the chat user is on the buddy list.
+ * @return TRUE if the chat user is on the buddy list. gboolean purple_chat_user_is_buddy(const PurpleChatUser *cb);
--- a/libpurple/http.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/http.h Wed Jan 29 10:49:02 2014 +0530
@@ -84,12 +84,12 @@
* An callback for getting large request contents (ie. from file stored on
- * @http_conn: Connection, which requests data.
- * @buffer: Buffer to store data to (with offset ignored).
- * @offset: Position, from where to read data.
- * @length: Length of data to read.
- * @user_data: The user data passed with callback function.
- * @cb: The function to call after storing data to buffer.
+ * @param http_conn Connection, which requests data. + * @param buffer Buffer to store data to (with offset ignored). + * @param offset Position, from where to read data. + * @param length Length of data to read. + * @param user_data The user data passed with callback function. + * @param cb The function to call after storing data to buffer. typedef void (*PurpleHttpContentReader)(PurpleHttpConnection *http_conn,
gchar *buffer, size_t offset, size_t length, gpointer user_data,
@@ -98,14 +98,14 @@
* An callback for writting large response contents.
- * @http_conn: Connection, which requests data.
- * @response: Response at point got so far (may change later).
- * @buffer: Buffer to read data from (with offset ignored).
- * @offset: Position of data got (its value is offset + length of
+ * @param http_conn Connection, which requests data. + * @param response Response at point got so far (may change later). + * @param buffer Buffer to read data from (with offset ignored). + * @param offset Position of data got (its value is offset + length of * previous call), can be safely ignored.
- * @length: Length of data read.
- * @user_data: The user data passed with callback function.
- * Returns: TRUE, if succeeded, FALSE otherwise.
+ * @param length Length of data read. + * @param user_data The user data passed with callback function. + * @return TRUE, if succeeded, FALSE otherwise. typedef gboolean (*PurpleHttpContentWriter)(PurpleHttpConnection *http_conn,
PurpleHttpResponse *response, const gchar *buffer, size_t offset,
@@ -114,12 +114,12 @@
* An callback for watching HTTP connection progress.
- * @http_conn: The HTTP Connection.
- * @reading_state: FALSE, is we are sending the request, TRUE, when reading
+ * @param http_conn The HTTP Connection. + * @param reading_state FALSE, is we are sending the request, TRUE, when reading - * @processed: The amount of data already processed.
- * @total: Total amount of data (in current state).
- * @user_data: The user data passed with callback function.
+ * @param processed The amount of data already processed. + * @param total Total amount of data (in current state). + * @param user_data The user data passed with callback function. typedef void (*PurpleHttpProgressWatcher)(PurpleHttpConnection *http_conn,
gboolean reading_state, int processed, int total, gpointer user_data);
@@ -135,11 +135,11 @@
* Fetches the data from a URL with GET request, and passes it to a callback
- * @gc: The connection for which the request is needed, or NULL.
- * @callback: The callback function.
- * @user_data: The user data to pass to the callback function.
- * Returns: The HTTP connection struct.
+ * @param gc The connection for which the request is needed, or NULL. + * @param callback The callback function. + * @param user_data The user data to pass to the callback function. + * @return The HTTP connection struct. PurpleHttpConnection * purple_http_get(PurpleConnection *gc,
PurpleHttpCallback callback, gpointer user_data, const gchar *url);
@@ -148,11 +148,11 @@
* Constructs an URL and fetches the data from it with GET request, then passes
* it to a callback function.
- * @gc: The connection for which the request is needed, or NULL.
- * @callback: The callback function.
- * @user_data: The user data to pass to the callback function.
- * @format: The format string.
- * Returns: The HTTP connection struct.
+ * @param gc The connection for which the request is needed, or NULL. + * @param callback The callback function. + * @param user_data The user data to pass to the callback function. + * @param format The format string. + * @return The HTTP connection struct. PurpleHttpConnection * purple_http_get_printf(PurpleConnection *gc,
PurpleHttpCallback callback, gpointer user_data,
@@ -163,11 +163,11 @@
* Provided request struct can be shared by multiple http requests but can not
* be modified when any of these is running.
- * @gc: The connection for which the request is needed, or NULL.
- * @request: The request.
- * @callback: The callback function.
- * @user_data: The user data to pass to the callback function.
- * Returns: The HTTP connection struct.
+ * @param gc The connection for which the request is needed, or NULL. + * @param request The request. + * @param callback The callback function. + * @param user_data The user data to pass to the callback function. + * @return The HTTP connection struct. PurpleHttpConnection * purple_http_request(PurpleConnection *gc,
PurpleHttpRequest *request, PurpleHttpCallback callback,
@@ -181,30 +181,30 @@
* Cancel a pending HTTP request.
- * @http_conn: The data returned when you initiated the HTTP request.
+ * @param http_conn The data returned when you initiated the HTTP request. void purple_http_conn_cancel(PurpleHttpConnection *http_conn);
* Cancels all HTTP connections associated with the specified handle.
+ * @param gc The handle. void purple_http_conn_cancel_all(PurpleConnection *gc);
* Checks, if provided HTTP request is running.
- * @http_conn: The HTTP connection (may be invalid pointer).
- * Returns: TRUE, if provided connection is currently running.
+ * @param http_conn The HTTP connection (may be invalid pointer). + * @return TRUE, if provided connection is currently running. gboolean purple_http_conn_is_running(PurpleHttpConnection *http_conn);
* Gets PurpleHttpRequest used for specified HTTP connection.
- * @http_conn: The HTTP connection.
- * Returns: The PurpleHttpRequest object.
+ * @param http_conn The HTTP connection. + * @return The PurpleHttpRequest object. PurpleHttpRequest * purple_http_conn_get_request(
PurpleHttpConnection *http_conn);
@@ -212,8 +212,8 @@
* Gets cookie jar used within connection.
- * @http_conn: The HTTP connection.
- * Returns: The cookie jar.
+ * @param http_conn The HTTP connection. + * @return The cookie jar. PurpleHttpCookieJar * purple_http_conn_get_cookie_jar(
PurpleHttpConnection *http_conn);
@@ -221,8 +221,8 @@
* Gets PurpleConnection tied with specified HTTP connection.
- * @http_conn: The HTTP connection.
- * Returns: The PurpleConnection object.
+ * @param http_conn The HTTP connection. + * @return The PurpleConnection object. PurpleConnection * purple_http_conn_get_purple_connection(
PurpleHttpConnection *http_conn);
@@ -231,10 +231,10 @@
* Sets the watcher, called after writing or reading data to/from HTTP stream.
* May be used for updating transfer progress gauge.
- * @http_conn: The HTTP connection.
- * @watcher: The watcher.
- * @user_data: The user data to pass to the callback function.
- * @interval_threshold: Minimum interval (in microseconds) of calls to
+ * @param http_conn The HTTP connection. + * @param watcher The watcher. + * @param user_data The user data to pass to the callback function. + * @param interval_threshold Minimum interval (in microseconds) of calls to * watcher, or -1 for default.
void purple_http_conn_set_progress_watcher(PurpleHttpConnection *http_conn,
@@ -254,8 +254,8 @@
* The returned data must be freed with purple_http_url_free.
- * @url: The URL to parse.
- * Returns: The parsed url or NULL, if the URL is invalid.
+ * @param url The URL to parse. + * @return The parsed url or NULL, if the URL is invalid. purple_http_url_parse(const char *url);
@@ -263,7 +263,7 @@
* Frees the parsed URL struct.
- * @parsed_url: The parsed URL struct, or NULL.
+ * @param parsed_url The parsed URL struct, or NULL. purple_http_url_free(PurpleHttpURL *parsed_url);
@@ -274,8 +274,8 @@
* Example: "https://example.com/path/to/file.html" + "subdir/other-file.html" =
* "https://example.com/path/to/subdir/another-file.html"
- * @base_url: The base URL. The result is stored here.
- * @relative_url: The relative URL.
+ * @param base_url The base URL. The result is stored here. + * @param relative_url The relative URL. purple_http_url_relative(PurpleHttpURL *base_url, PurpleHttpURL *relative_url);
@@ -286,8 +286,8 @@
* The result must be g_free'd.
- * @parsed_url: The URL struct.
- * Returns: The printable form of the URL.
+ * @param parsed_url The URL struct. + * @return The printable form of the URL. purple_http_url_print(PurpleHttpURL *parsed_url);
@@ -295,8 +295,8 @@
* Gets the protocol part of URL.
- * @parsed_url: The URL struct.
- * Returns: The protocol.
+ * @param parsed_url The URL struct. + * @return The protocol. purple_http_url_get_protocol(const PurpleHttpURL *parsed_url);
@@ -304,8 +304,8 @@
* Gets the username part of URL.
- * @parsed_url: The URL struct.
- * Returns: The username.
+ * @param parsed_url The URL struct. + * @return The username. purple_http_url_get_username(const PurpleHttpURL *parsed_url);
@@ -313,8 +313,8 @@
* Gets the password part of URL.
- * @parsed_url: The URL struct.
- * Returns: The password.
+ * @param parsed_url The URL struct. + * @return The password. purple_http_url_get_password(const PurpleHttpURL *parsed_url);
@@ -322,8 +322,8 @@
* Gets the hostname part of URL.
- * @parsed_url: The URL struct.
- * Returns: The hostname.
+ * @param parsed_url The URL struct. + * @return The hostname. purple_http_url_get_host(const PurpleHttpURL *parsed_url);
@@ -331,8 +331,8 @@
* Gets the port part of URL.
- * @parsed_url: The URL struct.
- * Returns: The port number.
+ * @param parsed_url The URL struct. + * @return The port number. purple_http_url_get_port(const PurpleHttpURL *parsed_url);
@@ -340,8 +340,8 @@
* Gets the path part of URL.
- * @parsed_url: The URL struct.
+ * @param parsed_url The URL struct. purple_http_url_get_path(const PurpleHttpURL *parsed_url);
@@ -349,8 +349,8 @@
* Gets the fragment part of URL.
- * @parsed_url: The URL struct.
- * Returns: The fragment.
+ * @param parsed_url The URL struct. + * @return The fragment. purple_http_url_get_fragment(const PurpleHttpURL *parsed_url);
@@ -366,14 +366,14 @@
* Creates new cookie jar,
- * Returns: empty cookie jar.
+ * @return empty cookie jar. PurpleHttpCookieJar * purple_http_cookie_jar_new(void);
* Increment the reference count.
- * @cookie_jar: The cookie jar.
+ * @param cookie_jar The cookie jar. void purple_http_cookie_jar_ref(PurpleHttpCookieJar *cookie_jar);
@@ -382,8 +382,8 @@
* If the reference count reaches zero, the cookie jar will be freed.
- * @cookie_jar: The cookie jar.
- * Returns: @a cookie_jar or %NULL if the reference count reached zero.
+ * @param cookie_jar The cookie jar. + * @return @a cookie_jar or @c NULL if the reference count reached zero. PurpleHttpCookieJar * purple_http_cookie_jar_unref(
PurpleHttpCookieJar *cookie_jar);
@@ -391,9 +391,9 @@
- * @cookie_jar: The cookie jar.
- * @value: Cookie contents.
+ * @param cookie_jar The cookie jar. + * @param name Cookie name. + * @param value Cookie contents. void purple_http_cookie_jar_set(PurpleHttpCookieJar *cookie_jar,
const gchar *name, const gchar *value);
@@ -401,9 +401,9 @@
- * @cookie_jar: The cookie jar.
- * Returns: Cookie contents, or NULL, if cookie doesn't exists.
+ * @param cookie_jar The cookie jar. + * @param name Cookie name. + * @return Cookie contents, or NULL, if cookie doesn't exists. const gchar * purple_http_cookie_jar_get(PurpleHttpCookieJar *cookie_jar,
@@ -411,8 +411,8 @@
* Checks, if the cookie jar contains any cookies.
- * @cookie_jar: The cookie jar.
- * Returns: TRUE, if cookie jar contains any cookie, FALSE otherwise.
+ * @param cookie_jar The cookie jar. + * @return TRUE, if cookie jar contains any cookie, FALSE otherwise. gboolean purple_http_cookie_jar_is_empty(PurpleHttpCookieJar *cookie_jar);
@@ -427,16 +427,16 @@
* Creates the new instance of HTTP request configuration.
- * @url: The URL to request for, or NULL to leave empty (to be set with
+ * @param url The URL to request for, or NULL to leave empty (to be set with * purple_http_request_set_url).
- * Returns: The new instance of HTTP request struct.
+ * @return The new instance of HTTP request struct. PurpleHttpRequest * purple_http_request_new(const gchar *url);
* Increment the reference count.
- * @request: The request.
+ * @param request The request. void purple_http_request_ref(PurpleHttpRequest *request);
@@ -445,24 +445,24 @@
* If the reference count reaches zero, the http request struct will be freed.
- * @request: The request.
- * Returns: @a request or %NULL if the reference count reached zero.
+ * @param request The request. + * @return @a request or @c NULL if the reference count reached zero. PurpleHttpRequest * purple_http_request_unref(PurpleHttpRequest *request);
* Sets URL for HTTP request.
- * @request: The request.
+ * @param request The request. void purple_http_request_set_url(PurpleHttpRequest *request, const gchar *url);
* Constructs and sets an URL for HTTP request.
- * @request: The request.
- * @format: The format string.
+ * @param request The request. + * @param format The format string. void purple_http_request_set_url_printf(PurpleHttpRequest *request,
const gchar *format, ...) G_GNUC_PRINTF(2, 3);
@@ -470,16 +470,16 @@
* Gets URL set for the HTTP request.
- * @request: The request.
- * Returns: URL set for this request.
+ * @param request The request. + * @return URL set for this request. const gchar * purple_http_request_get_url(PurpleHttpRequest *request);
* Sets custom HTTP method used for the request.
- * @request: The request.
- * @method: The method, or NULL for default.
+ * @param request The request. + * @param method The method, or NULL for default. void purple_http_request_set_method(PurpleHttpRequest *request,
@@ -487,8 +487,8 @@
* Gets HTTP method set for the request.
- * @request: The request.
+ * @param request The request. const gchar * purple_http_request_get_method(PurpleHttpRequest *request);
@@ -497,8 +497,8 @@
* It increases pool's reference count.
- * @request: The request.
- * @pool: The new KeepAlive pool, or NULL to reset.
+ * @param request The request. + * @param pool The new KeepAlive pool, or NULL to reset. purple_http_request_set_keepalive_pool(PurpleHttpRequest *request,
@@ -509,8 +509,8 @@
* It doesn't affect pool's reference count.
- * @request: The request.
- * Returns: The KeepAlive pool, used for the request.
+ * @param request The request. + * @return The KeepAlive pool, used for the request. PurpleHttpKeepalivePool *
purple_http_request_get_keepalive_pool(PurpleHttpRequest *request);
@@ -518,9 +518,9 @@
* Sets contents of HTTP request (for example, POST data).
- * @request: The request.
- * @contents: The contents.
- * @length: The length of contents (-1 if it's a NULL-terminated string)
+ * @param request The request. + * @param contents The contents. + * @param length The length of contents (-1 if it's a NULL-terminated string) void purple_http_request_set_contents(PurpleHttpRequest *request,
const gchar *contents, int length);
@@ -529,10 +529,10 @@
* Sets contents reader for HTTP request, used mainly for possible large
- * @request: The request.
- * @reader: The reader callback.
- * @contents_size: The size of all contents.
- * @user_data: The user data to pass to the callback function.
+ * @param request The request. + * @param reader The reader callback. + * @param contents_size The size of all contents. + * @param user_data The user data to pass to the callback function. void purple_http_request_set_contents_reader(PurpleHttpRequest *request,
PurpleHttpContentReader reader, int contents_length, gpointer user_data);
@@ -540,9 +540,9 @@
* Set contents writer for HTTP response.
- * @request: The request.
- * @reader: The writer callback, or NULL to remove existing.
- * @user_data: The user data to pass to the callback function.
+ * @param request The request. + * @param reader The writer callback, or NULL to remove existing. + * @param user_data The user data to pass to the callback function. void purple_http_request_set_response_writer(PurpleHttpRequest *request,
PurpleHttpContentWriter writer, gpointer user_data);
@@ -550,8 +550,8 @@
* Set maximum amount of time, that request is allowed to run.
- * @request: The request.
- * @timeout: Time (in seconds) after that timeout will be cancelled,
+ * @param request The request. + * @param timeout Time (in seconds) after that timeout will be cancelled, void purple_http_request_set_timeout(PurpleHttpRequest *request, int timeout);
@@ -559,16 +559,16 @@
* Get maximum amount of time, that request is allowed to run.
- * @request: The request.
- * Returns: Timeout currently set (-1 for infinite).
+ * @param request The request. + * @return Timeout currently set (-1 for infinite). int purple_http_request_get_timeout(PurpleHttpRequest *request);
* Sets maximum amount of redirects.
- * @request: The request.
- * @max_redirects: Maximum amount of redirects, or -1 for unlimited.
+ * @param request The request. + * @param max_redirects Maximum amount of redirects, or -1 for unlimited. void purple_http_request_set_max_redirects(PurpleHttpRequest *request,
@@ -576,16 +576,16 @@
* Gets maximum amount of redirects.
- * @request: The request.
- * Returns: Current maximum amount of redirects (-1 for unlimited).
+ * @param request The request. + * @return Current maximum amount of redirects (-1 for unlimited). int purple_http_request_get_max_redirects(PurpleHttpRequest *request);
* Sets cookie jar used for the request.
- * @request: The request.
- * @cookie_jar: The cookie jar.
+ * @param request The request. + * @param cookie_jar The cookie jar. void purple_http_request_set_cookie_jar(PurpleHttpRequest *request,
PurpleHttpCookieJar *cookie_jar);
@@ -593,8 +593,8 @@
* Gets cookie jar used for the request.
- * @request: The request.
- * Returns: The cookie jar.
+ * @param request The request. + * @return The cookie jar. PurpleHttpCookieJar * purple_http_request_get_cookie_jar(
PurpleHttpRequest *request);
@@ -602,8 +602,8 @@
* Sets HTTP version to use.
- * @request: The request.
- * @http11: TRUE for HTTP/1.1, FALSE for HTTP/1.0.
+ * @param request The request. + * @param http11 TRUE for HTTP/1.1, FALSE for HTTP/1.0. void purple_http_request_set_http11(PurpleHttpRequest *request,
@@ -611,8 +611,8 @@
* Gets used HTTP version.
- * @request: The request.
- * Returns: TRUE, if we use HTTP/1.1, FALSE for HTTP/1.0.
+ * @param request The request. + * @return TRUE, if we use HTTP/1.1, FALSE for HTTP/1.0. gboolean purple_http_request_is_http11(PurpleHttpRequest *request);
@@ -621,8 +621,8 @@
* Headers length doesn't count here.
- * @request: The request.
- * @max_len: Maximum length of response to read (-1 for the maximum
+ * @param request The request. + * @param max_len Maximum length of response to read (-1 for the maximum void purple_http_request_set_max_len(PurpleHttpRequest *request, int max_len);
@@ -630,17 +630,17 @@
* Gets maximum length of response content to read.
- * @request: The request.
- * Returns: Maximum length of response to read, or -1 if unlimited.
+ * @param request The request. + * @return Maximum length of response to read, or -1 if unlimited. int purple_http_request_get_max_len(PurpleHttpRequest *request);
* Sets (replaces, if exists) specified HTTP request header with provided value.
- * @request: The request.
- * @key: A header to be set.
- * @value: A value to set, or NULL to remove specified header.
+ * @param request The request. + * @param key A header to be set. + * @param value A value to set, or NULL to remove specified header. * @see purple_http_request_header_add
@@ -650,9 +650,9 @@
* Constructs and sets (replaces, if exists) specified HTTP request header.
- * @request: The request.
- * @key: A header to be set.
- * @format: The format string.
+ * @param request The request. + * @param key A header to be set. + * @param format The format string. void purple_http_request_header_set_printf(PurpleHttpRequest *request,
const gchar *key, const gchar *format, ...) G_GNUC_PRINTF(3, 4);
@@ -660,8 +660,8 @@
* Adds (without replacing, if exists) an HTTP request header.
- * @key: A header to be set.
- * @value: A value to set.
+ * @param key A header to be set. + * @param value A value to set. * @see purple_http_request_header_set
@@ -685,7 +685,7 @@
* Increment the reference count.
- * @pool: The HTTP Keep-Alive pool.
+ * @param pool The HTTP Keep-Alive pool. purple_http_keepalive_pool_ref(PurpleHttpKeepalivePool *pool);
@@ -696,8 +696,8 @@
* If the reference count reaches zero, the pool will be freed and all
* connections will be closed.
- * @pool: The HTTP Keep-Alive pool.
- * Returns: @a pool or %NULL if the reference count reached zero.
+ * @param pool The HTTP Keep-Alive pool. + * @return @a pool or @c NULL if the reference count reached zero. PurpleHttpKeepalivePool *
purple_http_keepalive_pool_unref(PurpleHttpKeepalivePool *pool);
@@ -706,8 +706,8 @@
* Sets maximum allowed number of connections to specific host-triple (is_ssl +
- * @pool: The HTTP Keep-Alive pool.
- * @limit: The new limit, 0 for unlimited.
+ * @param pool The HTTP Keep-Alive pool. + * @param limit The new limit, 0 for unlimited. purple_http_keepalive_pool_set_limit_per_host(PurpleHttpKeepalivePool *pool,
@@ -717,8 +717,8 @@
* Gets maximum allowed number of connections to specific host-triple (is_ssl +
- * @pool: The HTTP Keep-Alive pool.
+ * @param pool The HTTP Keep-Alive pool. purple_http_keepalive_pool_get_limit_per_host(PurpleHttpKeepalivePool *pool);
@@ -752,32 +752,32 @@
* Checks, if HTTP request was performed successfully.
- * @response: The response.
- * Returns: TRUE, if request was performed successfully.
+ * @param response The response. + * @return TRUE, if request was performed successfully. gboolean purple_http_response_is_successful(PurpleHttpResponse *response);
* Gets HTTP response code.
- * @response: The response.
- * Returns: HTTP response code.
+ * @param response The response. + * @return HTTP response code. int purple_http_response_get_code(PurpleHttpResponse *response);
* Gets error description.
- * @response: The response.
- * Returns: Localized error description or NULL, if there was no error.
+ * @param response The response. + * @return Localized error description or NULL, if there was no error. const gchar * purple_http_response_get_error(PurpleHttpResponse *response);
* Gets HTTP response data length.
- * @response: The response.
- * Returns: Data length;
+ * @param response The response. gsize purple_http_response_get_data_len(PurpleHttpResponse *response);
@@ -786,17 +786,17 @@
* Response data is not written, if writer callback was set for request.
- * @response: The response.
- * @len: Return address for the size of the data. Can be NULL.
+ * @param response The response. + * @param len Return address for the size of the data. Can be NULL. const gchar * purple_http_response_get_data(PurpleHttpResponse *response, size_t *len);
* Gets all headers got with response.
- * @response: The response.
- * Returns: GList of PurpleKeyValuePair, which keys are header field
+ * @param response The response. + * @return GList of PurpleKeyValuePair, which keys are header field * names (gchar*) and values are its contents (gchar*).
const GList * purple_http_response_get_all_headers(PurpleHttpResponse *response);
@@ -804,9 +804,9 @@
* Gets all headers with specified name got with response.
- * @response: The response.
- * @name: The name of header field.
- * Returns: GList of header field records contents (gchar*).
+ * @param response The response. + * @param name The name of header field. + * @return GList of header field records contents (gchar*). const GList * purple_http_response_get_headers_by_name(
PurpleHttpResponse *response, const gchar *name);
@@ -817,9 +817,9 @@
* To get all headers with the same name, use
* purple_http_response_get_headers_by_name instead.
- * @response: The response.
- * @name: The name of header field.
- * Returns: Header field contents or NULL, if there is no such one.
+ * @param response The response. + * @param name The name of header field. + * @return Header field contents or NULL, if there is no such one. const gchar * purple_http_response_get_header(PurpleHttpResponse *response,
--- a/libpurple/keyring.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/keyring.h Wed Jan 29 10:49:02 2014 +0530
@@ -61,10 +61,10 @@
* If there was a problem, the password will be NULL, and the error set.
- * @account: The account.
- * @password: The password.
- * @error: Error that may have occurred.
- * @data: Data passed to the callback.
+ * @param account The account. + * @param password The password. + * @param error Error that may have occurred. + * @param data Data passed to the callback. typedef void (*PurpleKeyringReadCallback)(PurpleAccount *account,
const gchar *password, GError *error, gpointer data);
@@ -74,9 +74,9 @@
* If there was a problem, the error will be set.
- * @account: The account.
- * @error: Error that may have occurred.
- * @data: Data passed to the callback.
+ * @param account The account. + * @param error Error that may have occurred. + * @param data Data passed to the callback. typedef void (*PurpleKeyringSaveCallback)(PurpleAccount *account, GError *error,
@@ -84,16 +84,16 @@
* Callback for once the master password for a keyring has been changed.
- * @error: Error that has occurred.
- * @data: Data passed to the callback.
+ * @param error Error that has occurred. + * @param data Data passed to the callback. typedef void (*PurpleKeyringChangeMasterCallback)(GError *error, gpointer data);
* Callback for when we change the keyring.
- * @error: An error that might have occurred.
- * @data: A pointer to user supplied data.
+ * @param error An error that might have occurred. + * @param data A pointer to user supplied data. typedef void (*PurpleKeyringSetInUseCallback)(GError *error, gpointer data);
@@ -107,9 +107,9 @@
* Read the password for an account.
- * @account: The account.
- * @cb: A callback for once the password is found.
- * @data: Data to be passed to the callback.
+ * @param account The account. + * @param cb A callback for once the password is found. + * @param data Data to be passed to the callback. typedef void (*PurpleKeyringRead)(PurpleAccount *account,
PurpleKeyringReadCallback cb, gpointer data);
@@ -117,11 +117,11 @@
* Store a password in the keyring.
- * @account: The account.
- * @password: The password to be stored. If the password is NULL, this
+ * @param account The account. + * @param password The password to be stored. If the password is NULL, this * means that the keyring should forget about that password.
- * @cb: A callback for once the password is saved.
- * @data: Data to be passed to the callback.
+ * @param cb A callback for once the password is saved. + * @param data Data to be passed to the callback. typedef void (*PurpleKeyringSave)(PurpleAccount *account, const gchar *password,
PurpleKeyringSaveCallback cb, gpointer data);
@@ -147,11 +147,11 @@
* This is not async because it is not meant to prompt for a master password and
- * @account: The account.
- * @mode: A keyring specific option that was stored. Can be NULL.
- * @data: Data that was stored. Can be NULL.
+ * @param account The account. + * @param mode A keyring specific option that was stored. Can be NULL. + * @param data Data that was stored. Can be NULL. - * Returns: TRUE on success, FALSE on failure.
+ * @return TRUE on success, FALSE on failure. typedef gboolean (*PurpleKeyringImportPassword)(PurpleAccount *account,
const gchar *mode, const gchar *data, GError **error);
@@ -159,15 +159,15 @@
* Export serialized (and maybe encrypted) password.
- * @account: The account.
- * @mode: An option field that can be used by the plugin. This is
+ * @param account The account. + * @param mode An option field that can be used by the plugin. This is * expected to be a static string.
- * @data: The data to be stored in the XML node. This string will be
+ * @param data The data to be stored in the XML node. This string will be * freed using destroy() once not needed anymore.
- * @error: Will be set if a problem occured.
- * @destroy: A function to be called, if non NULL, to free data.
+ * @param error Will be set if a problem occured. + * @param destroy A function to be called, if non NULL, to free data. - * Returns: TRUE on success, FALSE on failure.
+ * @return TRUE on success, FALSE on failure. typedef gboolean (*PurpleKeyringExportPassword)(PurpleAccount *account,
const gchar **mode, gchar **data, GError **error,
@@ -176,7 +176,7 @@
- * Returns: New copy of current settings (must be free'd with
+ * @return New copy of current settings (must be free'd with * purple_request_fields_destroy).
typedef PurpleRequestFields * (*PurpleKeyringReadSettings)(void);
@@ -184,10 +184,10 @@
* Applies modified keyring settings.
- * @notify_handle: A handle that can be passed to purple_notify_message.
- * @fields: Modified settings (originally taken from
+ * @param notify_handle A handle that can be passed to purple_notify_message. + * @param fields Modified settings (originally taken from * PurpleKeyringReadSettings).
- * Returns: TRUE, if succeeded, FALSE otherwise.
+ * @return TRUE, if succeeded, FALSE otherwise. typedef gboolean (*PurpleKeyringApplySettings)(void *notify_handle,
PurpleRequestFields *fields);
@@ -204,9 +204,9 @@
* Find a keyring by an id.
- * @id: The id for the keyring.
+ * @param id The id for the keyring. - * Returns: The keyring, or NULL if not found.
+ * @return The keyring, or NULL if not found. purple_keyring_find_keyring_by_id(const gchar *id);
@@ -225,11 +225,11 @@
* the callback. If it succeeds, it will remove all passwords from the old safe
- * @newkeyring: The new keyring to use.
- * @force: FALSE if the change can be cancelled. If this is TRUE and
+ * @param newkeyring The new keyring to use. + * @param force FALSE if the change can be cancelled. If this is TRUE and * an error occurs, data might be lost.
- * @cb: A callback for once the change is complete.
- * @data: Data to be passed to the callback.
+ * @param cb A callback for once the change is complete. + * @param data Data to be passed to the callback. purple_keyring_set_inuse(PurpleKeyring *newkeyring, gboolean force,
@@ -238,7 +238,7 @@
* Register a keyring plugin.
- * @keyring: The keyring to register.
+ * @param keyring The keyring to register. purple_keyring_register(PurpleKeyring *keyring);
@@ -249,7 +249,7 @@
* In case the keyring is in use, passwords will be moved to a fallback safe,
* and the keyring to unregister will be properly closed.
- * @keyring: The keyring to unregister.
+ * @param keyring The keyring to unregister. purple_keyring_unregister(PurpleKeyring *keyring);
@@ -258,7 +258,7 @@
* Returns a GList containing the IDs and names of the registered
- * Returns: The list of IDs and names.
+ * @return The list of IDs and names. purple_keyring_get_options(void);
@@ -275,12 +275,12 @@
* It's used by account.c while reading a password from xml.
- * @account: The account.
- * @keyring_id: The plugin ID that was stored in the xml file. Can be NULL.
- * @mode: A keyring specific option that was stored. Can be NULL.
- * @data: Data that was stored, can be NULL.
+ * @param account The account. + * @param keyring_id The plugin ID that was stored in the xml file. Can be NULL. + * @param mode A keyring specific option that was stored. Can be NULL. + * @param data Data that was stored, can be NULL. - * Returns: TRUE if the input was accepted, FALSE otherwise.
+ * @return TRUE if the input was accepted, FALSE otherwise. purple_keyring_import_password(PurpleAccount *account, const gchar *keyring_id,
@@ -291,18 +291,18 @@
* It's used by account.c while syncing accounts to xml.
- * @account: The account for which we want the info.
- * @keyring_id: The plugin id to be stored in the XML node. This will be
+ * @param account The account for which we want the info. + * @param keyring_id The plugin id to be stored in the XML node. This will be * NULL or a string that can be considered static.
- * @mode: An option field that can be used by the plugin. This will
+ * @param mode An option field that can be used by the plugin. This will * be NULL or a string that can be considered static.
- * @data: The data to be stored in the XML node. This string must be
+ * @param data The data to be stored in the XML node. This string must be * freed using destroy() once not needed anymore if it is not
- * @error: Will be set if a problem occured.
- * @destroy: A function to be called, if non NULL, to free data.
+ * @param error Will be set if a problem occured. + * @param destroy A function to be called, if non NULL, to free data. - * Returns: TRUE if the info was exported successfully, FALSE otherwise.
+ * @return TRUE if the info was exported successfully, FALSE otherwise. purple_keyring_export_password(PurpleAccount *account, const gchar **keyring_id,
@@ -312,9 +312,9 @@
* Read a password from the current keyring.
- * @account: The account.
- * @cb: A callback for once the password is read.
- * @data: Data passed to the callback.
+ * @param account The account. + * @param cb A callback for once the password is read. + * @param data Data passed to the callback. purple_keyring_get_password(PurpleAccount *account,
@@ -323,10 +323,10 @@
* Save a password to the current keyring.
- * @account: The account.
- * @password: The password to save.
- * @cb: A callback for once the password is saved.
- * @data: Data to be passed to the callback.
+ * @param account The account. + * @param password The password to save. + * @param cb A callback for once the password is saved. + * @param data Data to be passed to the callback. purple_keyring_set_password(PurpleAccount *account, const gchar *password,
@@ -335,7 +335,7 @@
* Reads settings from current keyring.
- * Returns: New copy of current settings (must be free'd with
+ * @return New copy of current settings (must be free'd with * purple_request_fields_destroy).
@@ -344,10 +344,10 @@
* Applies modified settings to current keyring.
- * @notify_handle: A handle that can be passed to purple_notify_message.
- * @fields: Modified settings (originally taken from
+ * @param notify_handle A handle that can be passed to purple_notify_message. + * @param fields Modified settings (originally taken from * PurpleKeyringReadSettings).
- * Returns: TRUE, if succeeded, FALSE otherwise.
+ * @return TRUE, if succeeded, FALSE otherwise. purple_keyring_apply_settings(void *notify_handle, PurpleRequestFields *fields);
@@ -373,7 +373,7 @@
* Frees all data allocated with purple_keyring_new.
- * @keyring: Keyring wrapper struct.
+ * @param keyring Keyring wrapper struct. purple_keyring_free(PurpleKeyring *keyring);
@@ -381,8 +381,8 @@
* Gets friendly user name.
- * @keyring: The keyring.
- * Returns: Friendly user name.
+ * @param keyring The keyring. + * @return Friendly user name. purple_keyring_get_name(const PurpleKeyring *keyring);
@@ -390,8 +390,8 @@
- * @keyring: The keyring.
+ * @param keyring The keyring. purple_keyring_get_id(const PurpleKeyring *keyring);
@@ -425,8 +425,8 @@
* This field is required.
- * @keyring: The keyring.
- * @name: Friendly user name.
+ * @param keyring The keyring. + * @param name Friendly user name. purple_keyring_set_name(PurpleKeyring *keyring, const gchar *name);
@@ -436,8 +436,8 @@
* This field is required.
- * @keyring: The keyring.
+ * @param keyring The keyring. + * @param name Keyring ID. purple_keyring_set_id(PurpleKeyring *keyring, const gchar *id);
@@ -447,8 +447,8 @@
* This field is required.
- * @keyring: The keyring.
- * @read_cb: Read password method.
+ * @param keyring The keyring. + * @param read_cb Read password method. purple_keyring_set_read_password(PurpleKeyring *keyring,
@@ -459,8 +459,8 @@
* This field is required.
- * @keyring: The keyring.
- * @save_cb: Save password method.
+ * @param keyring The keyring. + * @param save_cb Save password method. purple_keyring_set_save_password(PurpleKeyring *keyring,
@@ -500,7 +500,7 @@
* Gets keyring subsystem error domain.
- * Returns: keyring subsystem error domain.
+ * @return keyring subsystem error domain. purple_keyring_error_domain(void);
@@ -543,7 +543,7 @@
* Returns the keyring subsystem handle.
- * Returns: The keyring subsystem handle.
+ * @return The keyring subsystem handle. purple_keyring_get_handle(void);
--- a/libpurple/log.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/log.h Wed Jan 29 10:49:02 2014 +0530
@@ -139,7 +139,7 @@
started, saved with original
timezone data, if available and
- timezone fields, else %NULL.
+ timezone fields, else @c NULL. Do NOT modify anything in this struct.*/
/* IMPORTANT: Some code in log.c allocates these without zeroing them.
@@ -167,7 +167,7 @@
char *name; /**< The name of the logs available */
PurpleAccount *account; /**< The account the available logs
took place on. This will be
- %NULL if the account no longer
+ @c NULL if the account no longer logger's implementation of
list, it may not be possible
@@ -200,15 +200,15 @@
- * @type: The type of log this is.
- * @name: The name of this conversation (buddy name, chat name,
+ * @param type The type of log this is. + * @param name The name of this conversation (buddy name, chat name, - * @account: The account the conversation is occurring on
- * @conv: The conversation being logged
- * @time: The time this conversation started
- * @tm: The time this conversation started, with timezone data,
+ * @param account The account the conversation is occurring on + * @param conv The conversation being logged + * @param time The time this conversation started + * @param tm The time this conversation started, with timezone data, * if available and if struct tm has the BSD timezone fields.
PurpleLog *purple_log_new(PurpleLogType type, const char *name, PurpleAccount *account,
PurpleConversation *conv, time_t time, const struct tm *tm);
@@ -216,19 +216,19 @@
- * @log: The log to destroy
+ * @param log The log to destroy void purple_log_free(PurpleLog *log);
* Writes to a log file. Assumes you have checked preferences already.
- * @log: The log to write to
- * @type: The type of message being logged
- * @from: Whom this message is coming from, or %NULL for
+ * @param log The log to write to + * @param type The type of message being logged + * @param from Whom this message is coming from, or @c NULL for - * @time: A timestamp in UNIX time
- * @message: The message to log
+ * @param time A timestamp in UNIX time + * @param message The message to log void purple_log_write(PurpleLog *log,
@@ -239,20 +239,20 @@
- * @log: The log to read from
- * @flags: The returned logging flags.
+ * @param log The log to read from + * @param flags The returned logging flags. - * Returns: The contents of this log in Purple Markup.
+ * @return The contents of this log in Purple Markup. char *purple_log_read(PurpleLog *log, PurpleLogReadFlags *flags);
* Returns a list of all available logs
- * @type: The type of the log
- * @name: The name of the log
- * @account: The account
- * Returns: A sorted list of PurpleLogs
+ * @param type The type of the log + * @param name The name of the log + * @param account The account + * @return A sorted list of PurpleLogs GList *purple_log_get_logs(PurpleLogType type, const char *name, PurpleAccount *account);
@@ -270,33 +270,33 @@
* 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
+ * @return A GHashTable of all available unique PurpleLogSets GHashTable *purple_log_get_log_sets(void);
* Returns a list of all available system logs
- * @account: The account
- * Returns: A sorted list of PurpleLogs
+ * @param account The account + * @return A sorted list of PurpleLogs GList *purple_log_get_system_logs(PurpleAccount *account);
* Returns the size of a log
- * Returns: The size of the log, in bytes
+ * @return The size of the log, in bytes int purple_log_get_size(PurpleLog *log);
* Returns the size, in bytes, of all available logs in this conversation
- * @type: The type of the log
- * @name: The name of the log
- * @account: The account
- * Returns: The size in bytes
+ * @param type The type of the log + * @param name The name of the log + * @param account The account + * @return The size in bytes int purple_log_get_total_size(PurpleLogType type, const char *name, PurpleAccount *account);
@@ -304,30 +304,30 @@
* Returns the activity score of a log, based on total size in bytes,
* which is then decayed based on age
- * @type: The type of the log
- * @name: The name of the log
- * @account: The account
- * Returns: The activity score
+ * @param type The type of the log + * @param name The name of the log + * @param account The account + * @return The activity score int purple_log_get_activity_score(PurpleLogType type, const char *name, PurpleAccount *account);
* Tests whether a log is deletable
- * A return value of %FALSE indicates that purple_log_delete() will fail on this
- * log, unless something changes between the two calls. A return value of %TRUE,
+ * A return value of @c FALSE indicates that purple_log_delete() will fail on this + * log, unless something changes between the two calls. A return value of @c TRUE, * however, does not guarantee the log can be deleted.
- * Returns: A boolean indicating if the log is deletable
+ * @return A boolean indicating if the log is deletable gboolean purple_log_is_deletable(PurpleLog *log);
- * Returns: A boolean indicating success or failure
+ * @return A boolean indicating success or failure gboolean purple_log_delete(PurpleLog *log);
@@ -336,10 +336,10 @@
* and username. This would be where Purple stores logs created by
* the built-in text or HTML loggers.
- * @type: The type of the log.
- * @name: The name of the log.
- * @account: The account.
- * Returns: The default logger directory for Purple.
+ * @param type The type of the log. + * @param name The name of the log. + * @param account The account. + * @return The default logger directory for Purple. char *purple_log_get_log_dir(PurpleLogType type, const char *name, PurpleAccount *account);
@@ -348,7 +348,7 @@
* @param z Another PurpleLog
- * Returns: A value as specified by GCompareFunc
+ * @return A value as specified by GCompareFunc gint purple_log_compare(gconstpointer y, gconstpointer z);
@@ -357,14 +357,14 @@
* @param y A PurpleLogSet
* @param z Another PurpleLogSet
- * Returns: A value as specified by GCompareFunc
+ * @return A value as specified by GCompareFunc gint purple_log_set_compare(gconstpointer y, gconstpointer z);
- * @set: The log set to destroy
+ * @param set The log set to destroy void purple_log_set_free(PurpleLogSet *set);
@@ -388,8 +388,8 @@
* It should only be passed to purple_log_logger_new() and never
- * @log: The log to write to.
- * @ext: The file extension to give to this log file.
+ * @param log The log to write to. + * @param ext The file extension to give to this log file. void purple_log_common_writer(PurpleLog *log, const char *ext);
@@ -402,13 +402,13 @@
* It should only be passed to purple_log_logger_new() and never
- * @type: The type of the logs being listed.
- * @name: The name of the log.
- * @account: The account of the log.
- * @ext: The file extension this log format uses.
- * @logger: A reference to the logger struct for this log.
+ * @param type The type of the logs being listed. + * @param name The name of the log. + * @param account The account of the log. + * @param ext The file extension this log format uses. + * @param logger A reference to the logger struct for this log. - * Returns: A sorted GList of PurpleLogs matching the parameters.
+ * @return A sorted GList of PurpleLogs matching the parameters. GList *purple_log_common_lister(PurpleLogType type, const char *name,
PurpleAccount *account, const char *ext,
@@ -424,13 +424,13 @@
* It should only be passed to purple_log_logger_new() and never
- * @type: The type of the logs being sized.
- * @name: The name of the logs to size
+ * @param type The type of the logs being sized. + * @param name The name of the logs to size * (e.g. the username or chat name).
- * @account: The account of the log.
- * @ext: The file extension this log format uses.
+ * @param account The account of the log. + * @param ext The file extension this log format uses. - * Returns: The size of all the logs with the specified extension
+ * @return The size of all the logs with the specified extension * for the specified user.
int purple_log_common_total_sizer(PurpleLogType type, const char *name,
@@ -445,9 +445,9 @@
* It should only be passed to purple_log_logger_new() and never
- * @log: The PurpleLog to size.
+ * @param log The PurpleLog to size. - * Returns: An integer indicating the size of the log in bytes.
+ * @return An integer indicating the size of the log in bytes. int purple_log_common_sizer(PurpleLog *log);
@@ -460,9 +460,9 @@
* It should only be passed to purple_log_logger_new() and never
- * @log: The PurpleLog to delete.
+ * @param log The PurpleLog to delete. - * Returns: A boolean indicating success or failure.
+ * @return A boolean indicating success or failure. gboolean purple_log_common_deleter(PurpleLog *log);
@@ -475,9 +475,9 @@
* It should only be passed to purple_log_logger_new() and never
- * @log: The PurpleLog to check.
+ * @param log The PurpleLog to check. - * Returns: A boolean indicating if the log is deletable.
+ * @return A boolean indicating if the log is deletable. gboolean purple_log_common_is_deletable(PurpleLog *log);
@@ -491,9 +491,9 @@
- * @id: The logger's id.
- * @name: The logger's name.
- * @functions: The number of functions being passed. The following
+ * @param id The logger's id. + * @param name The logger's name. + * @param functions The number of functions being passed. The following * functions are currently available (in order): @c create,
* @c write, @c finalize, @c list, @c read, @c size,
* @c total_size, @c list_syslog, @c get_log_sets,
@@ -503,24 +503,24 @@
* @c create and @c write is acceptable (for a total of
* two functions). Passing @c create and @c finalize,
* however, is not. To accomplish that, the caller must
- * pass @c create, %NULL (a placeholder for @c write),
+ * pass @c create, @c NULL (a placeholder for @c write), * and @c finalize (for a total of 3 functions).
- * Returns: The new logger
+ * @return The new logger PurpleLogLogger *purple_log_logger_new(const char *id, const char *name, int functions, ...);
- * @logger: The logger to free
+ * @param logger The logger to free void purple_log_logger_free(PurpleLogLogger *logger);
- * @logger: The new logger to add
+ * @param logger The new logger to add void purple_log_logger_add (PurpleLogLogger *logger);
@@ -528,7 +528,7 @@
- * @logger: The logger to remove
+ * @param logger The logger to remove void purple_log_logger_remove (PurpleLogLogger *logger);
@@ -536,7 +536,7 @@
* Sets the current logger
- * @logger: The logger to set
+ * @param logger The logger to set void purple_log_logger_set (PurpleLogLogger *logger);
@@ -544,7 +544,7 @@
* Returns the current logger
- * Returns: logger The current logger
+ * @return logger The current logger PurpleLogLogger *purple_log_logger_get (void);
@@ -552,7 +552,7 @@
* Returns a GList containing the IDs and names of the registered
- * Returns: The list of IDs and names.
+ * @return The list of IDs and names. GList *purple_log_logger_get_options(void);
@@ -569,7 +569,7 @@
* Returns the log subsystem handle.
- * Returns: The log subsystem handle.
+ * @return The log subsystem handle. void *purple_log_get_handle(void);
--- a/libpurple/media.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/media.h Wed Jan 29 10:49:02 2014 +0530
@@ -81,60 +81,60 @@
* Gets the media class's GType
- * Returns: The media class's GType.
+ * @return The media class's GType. GType purple_media_get_type(void);
* Gets a list of session IDs.
- * @media: The media session from which to retrieve session IDs.
+ * @param media The media session from which to retrieve session IDs. - * Returns: GList of session IDs. The caller must free the list.
+ * @return GList of session IDs. The caller must free the list. GList *purple_media_get_session_ids(PurpleMedia *media);
* Gets the PurpleAccount this media session is on.
- * @media: The media session to retrieve the account from.
+ * @param media The media session to retrieve the account from. - * Returns: The account retrieved.
+ * @return The account retrieved. PurpleAccount *purple_media_get_account(PurpleMedia *media);
* Gets the protocol data from the media session.
- * @media: The media session to retrieve the protocol data from.
+ * @param media The media session to retrieve the protocol data from. - * Returns: The protocol data retrieved.
+ * @return The protocol data retrieved. gpointer purple_media_get_protocol_data(PurpleMedia *media);
* Sets the protocol data on the media session.
- * @media: The media session to set the protocol data on.
- * @protocol_data: The data to set on the media session.
+ * @param media The media session to set the protocol data on. + * @param protocol_data The data to set on the media session. void purple_media_set_protocol_data(PurpleMedia *media, gpointer protocol_data);
* Signals an error in the media session.
- * @media: The media object to set the state on.
- * @error: The format of the error message to send in the signal.
- * @...: The arguments to plug into the format.
+ * @param media The media object to set the state on. + * @param error The format of the error message to send in the signal. + * @param ... The arguments to plug into the format. void purple_media_error(PurpleMedia *media, const gchar *error, ...);
* Ends all streams that match the given parameters
- * @media: The media object with which to end streams.
- * @session_id: The session to end streams on.
- * @participant: The participant to end streams with.
+ * @param media The media object with which to end streams. + * @param session_id The session to end streams on. + * @param participant The participant to end streams with. void purple_media_end(PurpleMedia *media, const gchar *session_id,
const gchar *participant);
@@ -142,11 +142,11 @@
* Signals different information about the given stream.
- * @media: The media instance to containing the stream to signal.
- * @type: The type of info being signaled.
- * @session_id: The id of the session of the stream being signaled.
- * @participant: The participant of the stream being signaled.
- * @local: TRUE if the info originated locally, FALSE if on the remote end.
+ * @param media The media instance to containing the stream to signal. + * @param type The type of info being signaled. + * @param session_id The id of the session of the stream being signaled. + * @param participant The participant of the stream being signaled. + * @param local TRUE if the info originated locally, FALSE if on the remote end. void purple_media_stream_info(PurpleMedia *media, PurpleMediaInfoType type,
const gchar *session_id, const gchar *participant,
@@ -164,9 +164,9 @@
* - "sdes-note" : The NOTE to put in SDES messages
* - "sdes-phone" : The PHONE to put in SDES messages
- * @media: The media object to set the parameters on.
- * @num_params: The number of parameters to pass
- * @params: Array of @c GParameter to pass
+ * @param media The media object to set the parameters on. + * @param num_params The number of parameters to pass + * @param params Array of @c GParameter to pass void purple_media_set_params(PurpleMedia *media,
guint num_params, GParameter *params);
@@ -176,19 +176,19 @@
* The list is owned by the @c PurpleMedia internals and should NOT be freed.
- * @media: The media object
+ * @param media The media object - * Returns: NULL-terminated array of names of supported parameters.
+ * @return NULL-terminated array of names of supported parameters. const gchar **purple_media_get_available_params(PurpleMedia *media);
* Checks if given optional parameter is supported by the media backend.
- * @media: The media object
- * @param: name of parameter
+ * @param media The media object + * @param param name of parameter - * Returns: %TRUE if backend recognizes the parameter, %FALSE otherwise.
+ * @return @c TRUE if backend recognizes the parameter, @c FALSE otherwise. gboolean purple_media_param_is_supported(PurpleMedia *media, const gchar *param);
@@ -198,16 +198,16 @@
* It only adds a stream to one audio session or video session as
* the @c sess_id must be unique between sessions.
- * @media: The media object to find the session in.
- * @sess_id: The session id of the session to add the stream to.
- * @who: The name of the remote user to add the stream for.
- * @type: The type of stream to create.
- * @initiator: Whether or not the local user initiated the stream.
- * @transmitter: The transmitter to use for the stream.
- * @num_params: The number of parameters to pass to Farsight.
- * @params: The parameters to pass to Farsight.
+ * @param media The media object to find the session in. + * @param sess_id The session id of the session to add the stream to. + * @param who The name of the remote user to add the stream for. + * @param type The type of stream to create. + * @param initiator Whether or not the local user initiated the stream. + * @param transmitter The transmitter to use for the stream. + * @param num_params The number of parameters to pass to Farsight. + * @param params The parameters to pass to Farsight. - * Returns: %TRUE The stream was added successfully, %FALSE otherwise.
+ * @return @c TRUE The stream was added successfully, @c FALSE otherwise. gboolean purple_media_add_stream(PurpleMedia *media, const gchar *sess_id,
const gchar *who, PurpleMediaSessionType type,
@@ -217,39 +217,39 @@
* Gets the session type from a session
- * @media: The media object to find the session in.
- * @sess_id: The session id of the session to get the type from.
+ * @param media The media object to find the session in. + * @param sess_id The session id of the session to get the type from. - * Returns: The retreived session type.
+ * @return The retreived session type. PurpleMediaSessionType purple_media_get_session_type(PurpleMedia *media, const gchar *sess_id);
* Gets the PurpleMediaManager this media session is a part of.
- * @media: The media object to get the manager instance from.
+ * @param media The media object to get the manager instance from. - * Returns: The PurpleMediaManager instance retrieved.
+ * @return The PurpleMediaManager instance retrieved. struct _PurpleMediaManager *purple_media_get_manager(PurpleMedia *media);
* Gets the codecs from a session.
- * @media: The media object to find the session in.
- * @sess_id: The session id of the session to get the codecs from.
+ * @param media The media object to find the session in. + * @param sess_id The session id of the session to get the codecs from. - * Returns: The retreieved codecs.
+ * @return The retreieved codecs. GList *purple_media_get_codecs(PurpleMedia *media, const gchar *sess_id);
* Adds remote candidates to the stream.
- * @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.
+ * @param media The media object to find the session in. + * @param sess_id The session id of the session find the stream in. + * @param participant The name of the remote user to add the candidates for. + * @param remote_candidates The remote candidates to add. void purple_media_add_remote_candidates(PurpleMedia *media,
@@ -259,9 +259,9 @@
* Gets the local candidates from a stream.
- * @media: The media object to find the session in.
- * @sess_id: The session id of the session to find the stream in.
- * @participant: The name of the remote user to get the candidates from.
+ * @param media The media object to find the session in. + * @param sess_id The session id of the session to find the stream in. + * @param participant The name of the remote user to get the candidates from. GList *purple_media_get_local_candidates(PurpleMedia *media,
@@ -270,12 +270,12 @@
* Gets the active local candidates for the stream.
- * @media: The media object to find the session in.
- * @sess_id: The session id of the session to find the stream in.
- * @participant: The name of the remote user to get the active candidate
+ * @param media The media object to find the session in. + * @param sess_id The session id of the session to find the stream in. + * @param participant The name of the remote user to get the active candidate - * Returns: The active candidates retrieved.
+ * @return The active candidates retrieved. GList *purple_media_get_active_local_candidates(PurpleMedia *media,
const gchar *sess_id, const gchar *participant);
@@ -283,12 +283,12 @@
* Gets the active remote candidates for the stream.
- * @media: The media object to find the session in.
- * @sess_id: The session id of the session to find the stream in.
- * @participant: The name of the remote user to get the remote candidate
+ * @param media The media object to find the session in. + * @param sess_id The session id of the session to find the stream in. + * @param participant The name of the remote user to get the remote candidate - * Returns: The remote candidates retrieved.
+ * @return The remote candidates retrieved. GList *purple_media_get_active_remote_candidates(PurpleMedia *media,
const gchar *sess_id, const gchar *participant);
@@ -296,12 +296,12 @@
* Sets remote candidates from the stream.
- * @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 candidates from.
- * @codecs: The list of remote codecs to set.
+ * @param media The media object to find the session in. + * @param sess_id The session id of the session find the stream in. + * @param participant The name of the remote user to set the candidates from. + * @param codecs The list of remote codecs to set. - * Returns: %TRUE The codecs were set successfully, or %FALSE otherwise.
+ * @return @c TRUE The codecs were set successfully, or @c FALSE otherwise. gboolean purple_media_set_remote_codecs(PurpleMedia *media, const gchar *sess_id,
const gchar *participant, GList *codecs);
@@ -309,11 +309,11 @@
* Returns whether or not the candidates for set of streams are prepared
- * @media: The media object to find the remote user in.
- * @session_id: The session id of the session to check.
- * @participant: The remote user to check for.
+ * @param media The media object to find the remote user in. + * @param session_id The session id of the session to check. + * @param participant The remote user to check for. - * Returns: %TRUE All streams for the given session_id/participant combination have candidates prepared, %FALSE otherwise.
+ * @return @c TRUE All streams for the given session_id/participant combination have candidates prepared, @c FALSE otherwise. gboolean purple_media_candidates_prepared(PurpleMedia *media,
const gchar *session_id, const gchar *participant);
@@ -321,32 +321,32 @@
* Sets the send codec for the a session.
- * @media: The media object to find the session in.
- * @sess_id: The session id of the session to set the codec for.
- * @codec: The codec to set the session to stream.
+ * @param media The media object to find the session in. + * @param sess_id The session id of the session to set the codec for. + * @param codec The codec to set the session to stream. - * Returns: %TRUE The codec was successfully changed, or %FALSE otherwise.
+ * @return @c TRUE The codec was successfully changed, or @c FALSE otherwise. gboolean purple_media_set_send_codec(PurpleMedia *media, const gchar *sess_id, PurpleMediaCodec *codec);
* Gets whether a session's codecs are ready to be used.
- * @media: The media object to find the session in.
- * @sess_id: The session id of the session to check.
+ * @param media The media object to find the session in. + * @param sess_id The session id of the session to check. - * Returns: %TRUE The codecs are ready, or %FALSE otherwise.
+ * @return @c TRUE The codecs are ready, or @c FALSE otherwise. gboolean purple_media_codecs_ready(PurpleMedia *media, const gchar *sess_id);
* Gets whether the local user is the conference/session/stream's initiator.
- * @media: The media instance to find the session in.
- * @sess_id: The session id of the session to check.
- * @participant: The participant of the stream to check.
+ * @param media The media instance to find the session in. + * @param sess_id The session id of the session to check. + * @param participant The participant of the stream to check. - * Returns: TRUE if the local user is the stream's initator, else FALSE.
+ * @return TRUE if the local user is the stream's initator, else FALSE. gboolean purple_media_is_initiator(PurpleMedia *media,
const gchar *sess_id, const gchar *participant);
@@ -354,11 +354,11 @@
* Gets whether a streams selected have been accepted.
- * @media: The media object to find the session in.
- * @sess_id: The session id of the session to check.
- * @participant: The participant to check.
+ * @param media The media object to find the session in. + * @param sess_id The session id of the session to check. + * @param participant The participant to check. - * Returns: %TRUE The selected streams have been accepted, or %FALSE otherwise.
+ * @return @c TRUE The selected streams have been accepted, or @c FALSE otherwise. gboolean purple_media_accepted(PurpleMedia *media, const gchar *sess_id,
const gchar *participant);
@@ -366,19 +366,19 @@
* Sets the input volume of all the selected sessions.
- * @media: The media object the sessions are in.
- * @session_id: The session to select (if any).
- * @level: The level to set the volume to.
+ * @param media The media object the sessions are in. + * @param session_id The session to select (if any). + * @param level The level to set the volume to. void purple_media_set_input_volume(PurpleMedia *media, const gchar *session_id, double level);
* Sets the output volume of all the selected streams.
- * @media: The media object the streams are in.
- * @session_id: The session to limit the streams to (if any).
- * @participant: The participant to limit the streams to (if any).
- * @level: The level to set the volume to.
+ * @param media The media object the streams are in. + * @param session_id The session to limit the streams to (if any). + * @param participant The participant to limit the streams to (if any). + * @param level The level to set the volume to. void purple_media_set_output_volume(PurpleMedia *media, const gchar *session_id,
const gchar *participant, double level);
@@ -386,12 +386,12 @@
* Sets a video output window for the given session/stream.
- * @media: The media instance to set the output window on.
- * @session_id: The session to set the output window on.
- * @participant: Optionally, the participant to set the output window on.
- * @window_id: The window id use for embedding the video in.
+ * @param media The media instance to set the output window on. + * @param session_id The session to set the output window on. + * @param participant Optionally, the participant to set the output window on. + * @param window_id The window id use for embedding the video in. - * Returns: An id to reference the output window.
+ * @return An id to reference the output window. gulong purple_media_set_output_window(PurpleMedia *media,
const gchar *session_id, const gchar *participant,
@@ -400,7 +400,7 @@
* Removes all output windows from a given media session.
- * @media: The instance to remove all output windows from.
+ * @param media The instance to remove all output windows from. void purple_media_remove_output_windows(PurpleMedia *media);
--- a/libpurple/notify.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/notify.h Wed Jan 29 10:49:02 2014 +0530
@@ -119,8 +119,8 @@
* Callback for a button in a search result.
* @param c the PurpleConnection passed to purple_notify_searchresults
- * @row: the contents of the selected row
- * @user_data: User defined data.
+ * @param row the contents of the selected row + * @param user_data User defined data. typedef void (*PurpleNotifySearchResultsCallback)(PurpleConnection *c, GList *row,
@@ -194,18 +194,18 @@
* a window with a list of all found buddies, where you are given the
* option of adding buddies to your buddy list.
- * @gc: The PurpleConnection handle associated with the information.
- * @title: The title of the message. If this is NULL, the title
+ * @param gc The PurpleConnection handle associated with the information. + * @param title The title of the message. If this is NULL, the title * will be "Search Results."
- * @primary: The main point of the message.
- * @secondary: The secondary information.
- * @results: The PurpleNotifySearchResults instance.
- * @cb: The callback to call when the user closes
+ * @param primary The main point of the message. + * @param secondary The secondary information. + * @param results The PurpleNotifySearchResults instance. + * @param cb The callback to call when the user closes - * @user_data: The data to pass to the close callback and any other
+ * @param user_data The data to pass to the close callback and any other * callback associated with a button.
- * Returns: A UI-specific handle.
+ * @return A UI-specific handle. void *purple_notify_searchresults(PurpleConnection *gc, const char *title,
const char *primary, const char *secondary,
@@ -215,16 +215,16 @@
* Frees a PurpleNotifySearchResults object.
- * @results: The PurpleNotifySearchResults to free.
+ * @param results The PurpleNotifySearchResults to free. void purple_notify_searchresults_free(PurpleNotifySearchResults *results);
* Replace old rows with the new. Reuse an existing window.
- * @gc: The PurpleConnection structure.
- * @results: The PurpleNotifySearchResults structure.
- * @data: Data returned by the purple_notify_searchresults().
+ * @param gc The PurpleConnection structure. + * @param results The PurpleNotifySearchResults structure. + * @param data Data returned by the purple_notify_searchresults(). void purple_notify_searchresults_new_rows(PurpleConnection *gc,
PurpleNotifySearchResults *results,
@@ -234,10 +234,10 @@
* Adds a stock button that will be displayed in the search results dialog.
- * @results: The search results object.
- * @type: Type of the button. (TODO: Only one button of a given type
+ * @param results The search results object. + * @param type Type of the button. (TODO: Only one button of a given type - * @cb: Function that will be called on the click event.
+ * @param cb Function that will be called on the click event. void purple_notify_searchresults_button_add(PurpleNotifySearchResults *results,
PurpleNotifySearchButtonType type,
@@ -248,9 +248,9 @@
* Adds a plain labelled button that will be displayed in the search results
- * @results: The search results object
- * @label: The label to display
- * @cb: Function that will be called on the click event
+ * @param results The search results object + * @param label The label to display + * @param cb Function that will be called on the click event void purple_notify_searchresults_button_add_labeled(PurpleNotifySearchResults *results,
@@ -260,7 +260,7 @@
* Returns a newly created search results object.
- * Returns: The new search results object.
+ * @return The new search results object. PurpleNotifySearchResults *purple_notify_searchresults_new(void);
@@ -268,43 +268,43 @@
* Returns a newly created search result column object. The column defaults
- * @title: Title of the column. NOTE: Title will get g_strdup()ed.
+ * @param title Title of the column. NOTE: Title will get g_strdup()ed. - * Returns: The new search column object.
+ * @return The new search column object. PurpleNotifySearchColumn *purple_notify_searchresults_column_new(const char *title);
* Returns the title of the column
- * @column: The search column object.
+ * @param column The search column object. - * Returns: The title of the column
+ * @return The title of the column const char *purple_notify_searchresult_column_get_title(const PurpleNotifySearchColumn *column);
* Sets whether or not a search result column is visible.
- * @column: The search column object.
- * @visible: TRUE if visible, or FALSE if not.
+ * @param column The search column object. + * @param visible TRUE if visible, or FALSE if not. void purple_notify_searchresult_column_set_visible(PurpleNotifySearchColumn *column, gboolean visible);
* Returns whether or not a search result column is visible.
- * @column: The search column object.
+ * @param column The search column object. - * Returns: TRUE if the search result column is visible. FALSE otherwise.
+ * @return TRUE if the search result column is visible. FALSE otherwise. gboolean purple_notify_searchresult_column_is_visible(const PurpleNotifySearchColumn *column);
* Adds a new column to the search result object.
- * @results: The result object to which the column will be added.
- * @column: The column that will be added to the result object.
+ * @param results The result object to which the column will be added. + * @param column The column that will be added to the result object. void purple_notify_searchresults_column_add(PurpleNotifySearchResults *results,
PurpleNotifySearchColumn *column);
@@ -312,8 +312,8 @@
* Adds a new row of the results to the search results object.
- * @results: The search results object.
- * @row: The row of the results.
+ * @param results The search results object. + * @param row The row of the results. void purple_notify_searchresults_row_add(PurpleNotifySearchResults *results,
@@ -328,18 +328,18 @@
* Displays a notification message to the user.
- * @handle: The plugin or connection handle.
- * @type: The notification type.
- * @title: The title of the message.
- * @primary: The main point of the message.
- * @secondary: The secondary information.
- * @cpar: The #PurpleRequestCommonParameters associated with this
- * request, or %NULL if none is.
- * @cb: The callback to call when the user closes
+ * @param handle The plugin or connection handle. + * @param type The notification type. + * @param title The title of the message. + * @param primary The main point of the message. + * @param secondary The secondary information. + * @param cpar The #PurpleRequestCommonParameters associated with this + * request, or @c NULL if none is. + * @param cb The callback to call when the user closes - * @user_data: The data to pass to the callback.
+ * @param user_data The data to pass to the callback. - * Returns: A UI-specific handle.
+ * @return A UI-specific handle. void *purple_notify_message(void *handle, PurpleNotifyMsgType type,
const char *title, const char *primary, const char *secondary,
@@ -349,16 +349,16 @@
* Displays a single email notification to the user.
- * @handle: The plugin or connection handle.
- * @subject: The subject of the email.
- * @from: The from address.
- * @to: The destination address.
- * @url: The URL where the message can be read.
- * @cb: The callback to call when the user closes
+ * @param handle The plugin or connection handle. + * @param subject The subject of the email. + * @param from The from address. + * @param to The destination address. + * @param url The URL where the message can be read. + * @param cb The callback to call when the user closes - * @user_data: The data to pass to the callback.
+ * @param user_data The data to pass to the callback. - * Returns: A UI-specific handle.
+ * @return A UI-specific handle. void *purple_notify_email(void *handle, const char *subject,
const char *from, const char *to,
@@ -368,21 +368,21 @@
* Displays a notification for multiple emails to the user.
- * @handle: The plugin or connection handle.
- * @count: The number of emails. '0' can be used to signify that
+ * @param handle The plugin or connection handle. + * @param count The number of emails. '0' can be used to signify that * the user has no unread emails and the UI should remove
- * @detailed: %TRUE if there is information for each email in the
+ * @param detailed @c TRUE if there is information for each email in the - * @subjects: The array of subjects.
- * @froms: The array of from addresses.
- * @tos: The array of destination addresses.
- * @urls: The URLs where the messages can be read.
- * @cb: The callback to call when the user closes
+ * @param subjects The array of subjects. + * @param froms The array of from addresses. + * @param tos The array of destination addresses. + * @param urls The URLs where the messages can be read. + * @param cb The callback to call when the user closes - * @user_data: The data to pass to the callback.
+ * @param user_data The data to pass to the callback. - * Returns: A UI-specific handle.
+ * @return A UI-specific handle. void *purple_notify_emails(void *handle, size_t count, gboolean detailed,
const char **subjects, const char **froms,
@@ -395,16 +395,16 @@
* The text is essentially a stripped-down format of HTML, the same that
- * @handle: The plugin or connection handle.
- * @title: The title of the message.
- * @primary: The main point of the message.
- * @secondary: The secondary information.
- * @text: The formatted text.
- * @cb: The callback to call when the user closes
+ * @param handle The plugin or connection handle. + * @param title The title of the message. + * @param primary The main point of the message. + * @param secondary The secondary information. + * @param text The formatted text. + * @param cb The callback to call when the user closes - * @user_data: The data to pass to the callback.
+ * @param user_data The data to pass to the callback. - * Returns: A UI-specific handle.
+ * @return A UI-specific handle. void *purple_notify_formatted(void *handle, const char *title,
const char *primary, const char *secondary,
@@ -417,13 +417,13 @@
* The text is essentially a stripped-down format of HTML, the same that
- * @gc: The PurpleConnection handle associated with the information.
- * @who: The username associated with the information.
- * @user_info: The PurpleNotifyUserInfo which contains the information
- * @cb: The callback to call when the user closes the notification.
- * @user_data: The data to pass to the callback.
+ * @param gc The PurpleConnection handle associated with the information. + * @param who The username associated with the information. + * @param user_info The PurpleNotifyUserInfo which contains the information + * @param cb The callback to call when the user closes the notification. + * @param user_data The data to pass to the callback. - * Returns: A UI-specific handle.
+ * @return A UI-specific handle. void *purple_notify_userinfo(PurpleConnection *gc, const char *who,
PurpleNotifyUserInfo *user_info, PurpleNotifyCloseCallback cb,
@@ -438,14 +438,14 @@
* Create a new PurpleNotifyUserInfo which is suitable for passing to
* purple_notify_userinfo()
- * Returns: A new PurpleNotifyUserInfo, which the caller must destroy when done
+ * @return A new PurpleNotifyUserInfo, which the caller must destroy when done PurpleNotifyUserInfo *purple_notify_user_info_new(void);
* Destroy a PurpleNotifyUserInfo
- * @user_info: The PurpleNotifyUserInfo
+ * @param user_info The PurpleNotifyUserInfo void purple_notify_user_info_destroy(PurpleNotifyUserInfo *user_info);
@@ -462,9 +462,9 @@
* To remove a PurpleNotifyUserInfoEntry, use
* purple_notify_user_info_remove_entry(). Do not use the GQueue directly.
- * @user_info: The PurpleNotifyUserInfo
+ * @param user_info The PurpleNotifyUserInfo - * Returns: (transfer none): A GQueue of PurpleNotifyUserInfoEntry objects.
+ * @constreturn A GQueue of PurpleNotifyUserInfoEntry objects. GQueue *purple_notify_user_info_get_entries(PurpleNotifyUserInfo *user_info);
@@ -472,8 +472,8 @@
* Create a textual representation of a PurpleNotifyUserInfo, separating
- * @user_info: The PurpleNotifyUserInfo
- * @newline: The separation character
+ * @param user_info The PurpleNotifyUserInfo + * @param newline The separation character char *purple_notify_user_info_get_text_with_newline(PurpleNotifyUserInfo *user_info, const char *newline);
@@ -481,12 +481,12 @@
* Add a label/value pair to a PurpleNotifyUserInfo object.
* PurpleNotifyUserInfo keeps track of the order in which pairs are added.
- * @user_info: The PurpleNotifyUserInfo
- * @label: A label, which for example might be displayed by a
+ * @param user_info The PurpleNotifyUserInfo + * @param label A label, which for example might be displayed by a * UI with a colon after it ("Status:"). Do not include
* a colon. If NULL, value will be displayed without a
- * @value: The value, which might be displayed by a UI after
+ * @param value The value, which might be displayed by a UI after * the label. This should be valid HTML. If you want
* to insert plaintext then use
* purple_notify_user_info_add_pair_plaintext(), instead.
@@ -518,8 +518,8 @@
* Remove a PurpleNotifyUserInfoEntry from a PurpleNotifyUserInfo object
* without freeing the entry.
- * @user_info: The PurpleNotifyUserInfo
- * @user_info_entry: The PurpleNotifyUserInfoEntry
+ * @param user_info The PurpleNotifyUserInfo + * @param user_info_entry The PurpleNotifyUserInfoEntry void purple_notify_user_info_remove_entry(PurpleNotifyUserInfo *user_info, PurpleNotifyUserInfoEntry *user_info_entry);
@@ -534,10 +534,10 @@
* purple_notify_user_info_prepend_pair_plaintext() are convenience
* methods for creating entries and adding them to a PurpleNotifyUserInfo.
- * @label: A label, which for example might be displayed by a UI
+ * @param label A label, which for example might be displayed by a UI * with a colon after it ("Status:"). Do not include a
* colon. If NULL, value will be displayed without a label.
- * @value: The value, which might be displayed by a UI after the
+ * @param value The value, which might be displayed by a UI after the * label. If NULL, label will still be displayed; the UI
* should then treat label as independent and not include a
* colon if it would otherwise.
@@ -549,21 +549,21 @@
* Destroy a PurpleNotifyUserInfoEntry
- * @user_info_entry: The PurpleNotifyUserInfoEntry
+ * @param user_info_entry The PurpleNotifyUserInfoEntry void purple_notify_user_info_entry_destroy(PurpleNotifyUserInfoEntry *user_info_entry);
* Add a section break. A UI might display this as a horizontal line.
- * @user_info: The PurpleNotifyUserInfo
+ * @param user_info The PurpleNotifyUserInfo void purple_notify_user_info_add_section_break(PurpleNotifyUserInfo *user_info);
* Prepend a section break. A UI might display this as a horizontal line.
- * @user_info: The PurpleNotifyUserInfo
+ * @param user_info The PurpleNotifyUserInfo void purple_notify_user_info_prepend_section_break(PurpleNotifyUserInfo *user_info);
@@ -571,8 +571,8 @@
* Add a section header. A UI might display this in a different font
- * @user_info: The PurpleNotifyUserInfo
- * @label: The name of the section
+ * @param user_info The PurpleNotifyUserInfo + * @param label The name of the section void purple_notify_user_info_add_section_header(PurpleNotifyUserInfo *user_info, const char *label);
@@ -580,8 +580,8 @@
* Prepend a section header. A UI might display this in a different font
- * @user_info: The PurpleNotifyUserInfo
- * @label: The name of the section
+ * @param user_info The PurpleNotifyUserInfo + * @param label The name of the section void purple_notify_user_info_prepend_section_header(PurpleNotifyUserInfo *user_info, const char *label);
@@ -594,24 +594,24 @@
* Get the label for a PurpleNotifyUserInfoEntry
- * @user_info_entry: The PurpleNotifyUserInfoEntry
+ * @param user_info_entry The PurpleNotifyUserInfoEntry
const gchar *purple_notify_user_info_entry_get_label(PurpleNotifyUserInfoEntry *user_info_entry);
* Set the label for a PurpleNotifyUserInfoEntry
- * @user_info_entry: The PurpleNotifyUserInfoEntry
+ * @param user_info_entry The PurpleNotifyUserInfoEntry + * @param label The label void purple_notify_user_info_entry_set_label(PurpleNotifyUserInfoEntry *user_info_entry, const char *label);
* Get the value for a PurpleNotifyUserInfoEntry
- * @user_info_entry: The PurpleNotifyUserInfoEntry
+ * @param user_info_entry The PurpleNotifyUserInfoEntry @@ -620,8 +620,8 @@
* Set the value for a PurpleNotifyUserInfoEntry
- * @user_info_entry: The PurpleNotifyUserInfoEntry
+ * @param user_info_entry The PurpleNotifyUserInfoEntry + * @param value The value void purple_notify_user_info_entry_set_value(PurpleNotifyUserInfoEntry *user_info_entry, const char *value);
@@ -629,17 +629,17 @@
* Get the type of a PurpleNotifyUserInfoEntry
- * @user_info_entry: The PurpleNotifyUserInfoEntry
+ * @param user_info_entry The PurpleNotifyUserInfoEntry - * Returns: The PurpleNotifyUserInfoEntryType
+ * @return The PurpleNotifyUserInfoEntryType PurpleNotifyUserInfoEntryType purple_notify_user_info_entry_get_type(PurpleNotifyUserInfoEntry *user_info_entry);
* Set the type of a PurpleNotifyUserInfoEntry
- * @user_info_entry: The PurpleNotifyUserInfoEntry
- * @type: The PurpleNotifyUserInfoEntryType
+ * @param user_info_entry The PurpleNotifyUserInfoEntry + * @param type The PurpleNotifyUserInfoEntryType void purple_notify_user_info_entry_set_type(PurpleNotifyUserInfoEntry *user_info_entry,
PurpleNotifyUserInfoEntryType type);
@@ -647,10 +647,10 @@
* Opens a URI or somehow presents it to the user.
- * @handle: The plugin or connection handle.
- * @uri: The URI to display or go to.
+ * @param handle The plugin or connection handle. + * @param uri The URI to display or go to. - * Returns: A UI-specific handle, if any. This may only be presented if
+ * @return A UI-specific handle, if any. This may only be presented if * the UI code displays a dialog instead of a webpage, or something
@@ -659,11 +659,11 @@
* Checks, if passed UI handle is valid.
- * @ui_handle: The UI handle.
- * @type: The pointer to variable, where request type may be stored
+ * @param ui_handle The UI handle. + * @param type The pointer to variable, where request type may be stored - * Returns: TRUE, if handle is valid, FALSE otherwise.
+ * @return TRUE, if handle is valid, FALSE otherwise. purple_notify_is_valid_ui_handle(void *ui_handle, PurpleNotifyType *type);
@@ -674,15 +674,15 @@
* This should be used only by the UI operation functions and part of the
- * @type: The notification type.
- * @ui_handle: The notification UI handle.
+ * @param type The notification type. + * @param ui_handle The notification UI handle. void purple_notify_close(PurpleNotifyType type, void *ui_handle);
* Closes all notifications registered with the specified handle.
+ * @param handle The handle. void purple_notify_close_with_handle(void *handle);
@@ -718,7 +718,7 @@
* Sets the UI operations structure to be used when displaying a
- * @ops: The UI operations structure.
+ * @param ops The UI operations structure. void purple_notify_set_ui_ops(PurpleNotifyUiOps *ops);
@@ -726,7 +726,7 @@
* Returns the UI operations structure to be used when displaying a
- * Returns: The UI operations structure.
+ * @return The UI operations structure. PurpleNotifyUiOps *purple_notify_get_ui_ops(void);
@@ -740,7 +740,7 @@
* Returns the notify subsystem handle.
- * Returns: The notify subsystem handle.
+ * @return The notify subsystem handle. void *purple_notify_get_handle(void);
--- a/libpurple/plugins.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/plugins.h Wed Jan 29 10:49:02 2014 +0530
@@ -159,7 +159,7 @@
* Returns an ABI version to set in plugins using major and minor versions.
- * Note: The lower six nibbles represent the ABI version for libpurple, the
+ * @note The lower six nibbles represent the ABI version for libpurple, the * rest are required by GPlugin.
#define PURPLE_PLUGIN_ABI_VERSION(major,minor) \
@@ -231,9 +231,9 @@
* The type will be registered statically if used in a static protocol or if
* plugins support is disabled.
- * @TN: The name of the new type, in Camel case.
- * @t_n: The name of the new type, in lowercase, words separated by '_'.
- * @T_P: The #GType of the parent type.
+ * @param TN The name of the new type, in Camel case. + * @param t_n The name of the new type, in lowercase, words separated by '_'. + * @param T_P The #GType of the parent type. #if !defined(PURPLE_PLUGINS) || defined(PURPLE_STATIC_PRPL)
#define PURPLE_DEFINE_TYPE(TN, t_n, T_P) \
@@ -249,11 +249,11 @@
* A more general version of PURPLE_DEFINE_TYPE() which allows you to
* specify #GTypeFlags and custom code.
- * @TN: The name of the new type, in Camel case.
- * @t_n: The name of the new type, in lowercase, words separated by '_'.
- * @T_P: The #GType of the parent type.
- * @flags: #GTypeFlags to register the type with.
- * @CODE: Custom code that gets inserted in *_get_type().
+ * @param TN The name of the new type, in Camel case. + * @param t_n The name of the new type, in lowercase, words separated by '_'. + * @param T_P The #GType of the parent type. + * @param flags #GTypeFlags to register the type with. + * @param CODE Custom code that gets inserted in *_get_type(). #if !defined(PURPLE_PLUGINS) || defined(PURPLE_STATIC_PRPL)
#define PURPLE_DEFINE_TYPE_EXTENDED \
@@ -270,8 +270,8 @@
* of PURPLE_DEFINE_TYPE_EXTENDED(). You should use this macro if the
* interface is a part of the libpurple core.
- * @TYPE_IFACE: The #GType of the interface to add.
- * @iface_init: The interface init function.
+ * @param TYPE_IFACE The #GType of the interface to add. + * @param iface_init The interface init function. #define PURPLE_IMPLEMENT_INTERFACE_STATIC(TYPE_IFACE, iface_init) { \
const GInterfaceInfo interface_info = { \
@@ -287,8 +287,8 @@
* of PURPLE_DEFINE_TYPE_EXTENDED(). You should use this macro if the
* interface lives in the plugin.
- * @TYPE_IFACE: The #GType of the interface to add.
- * @iface_init: The interface init function.
+ * @param TYPE_IFACE The #GType of the interface to add. + * @param iface_init The interface init function. #if !defined(PURPLE_PLUGINS) || defined(PURPLE_STATIC_PRPL)
#define PURPLE_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init) \
@@ -379,11 +379,11 @@
* Attempts to load a plugin.
- * @plugin: The plugin to load.
- * @error: Return location for a #GError or %NULL. If provided, this
+ * @param plugin The plugin to load. + * @param error Return location for a #GError or @c NULL. If provided, this * will be set to the reason if the load fails.
- * Returns: %TRUE if successful or already loaded, %FALSE otherwise.
+ * @return @c TRUE if successful or already loaded, @c FALSE otherwise. * @see purple_plugin_unload()
@@ -392,11 +392,11 @@
* Unloads the specified plugin.
- * @plugin: The plugin handle.
- * @error: Return location for a #GError or %NULL. If provided, this
+ * @param plugin The plugin handle. + * @param error Return location for a #GError or @c NULL. If provided, this * will be set to the reason if the unload fails.
- * Returns: %TRUE if successful or not loaded, %FALSE otherwise.
+ * @return @c TRUE if successful or not loaded, @c FALSE otherwise. * @see purple_plugin_load()
@@ -405,27 +405,27 @@
* Returns whether or not a plugin is currently loaded.
+ * @param plugin The plugin. - * Returns: %TRUE if loaded, or %FALSE otherwise.
+ * @return @c TRUE if loaded, or @c FALSE otherwise. gboolean purple_plugin_is_loaded(const PurplePlugin *plugin);
* Returns a plugin's filename, along with the path.
+ * @param info The plugin. - * Returns: The plugin's filename.
+ * @return The plugin's filename. const gchar *purple_plugin_get_filename(const PurplePlugin *plugin);
* Returns a plugin's #PurplePluginInfo instance.
+ * @param info The plugin. - * Returns: The plugin's #PurplePluginInfo instance.
+ * @return The plugin's #PurplePluginInfo instance. PurplePluginInfo *purple_plugin_get_info(const PurplePlugin *plugin);
@@ -442,15 +442,15 @@
* Registers a new dynamic type.
- * @plugin: The plugin that is registering the type.
- * @parent: Type from which this type will be derived.
- * @name: Name of the new type.
- * @info: Information to initialize and destroy a type's classes and
+ * @param plugin The plugin that is registering the type. + * @param parent Type from which this type will be derived. + * @param name Name of the new type. + * @param info Information to initialize and destroy a type's classes and - * @flags: Bitwise combination of values that determines the nature
+ * @param flags Bitwise combination of values that determines the nature * (e.g. abstract or not) of the type.
- * Returns: The new GType, or @c G_TYPE_INVALID if registration failed.
+ * @return The new GType, or @c G_TYPE_INVALID if registration failed. GType purple_plugin_register_type(PurplePlugin *plugin, GType parent,
const gchar *name, const GTypeInfo *info,
@@ -459,10 +459,10 @@
* Adds a dynamic interface type to an instantiable type.
- * @plugin: The plugin that is adding the interface type.
- * @instance_type: The GType of the instantiable type.
- * @interface_type: The GType of the interface type.
- * @interface_info: Information used to manage the interface type.
+ * @param plugin The plugin that is adding the interface type. + * @param instance_type The GType of the instantiable type. + * @param interface_type The GType of the interface type. + * @param interface_info Information used to manage the interface type. void purple_plugin_add_interface(PurplePlugin *plugin, GType instance_type,
@@ -474,18 +474,18 @@
* not be shown in plugin lists. Examples of such plugins are in-tree protocol
+ * @param plugin The plugin. - * Returns: %TRUE if the plugin is an internal plugin, %FALSE otherwise.
+ * @return @c TRUE if the plugin is an internal plugin, @c FALSE otherwise. gboolean purple_plugin_is_internal(const PurplePlugin *plugin);
* Returns a list of plugins that depend on a particular plugin.
- * @plugin: The plugin whose dependent plugins are returned.
+ * @param plugin The plugin whose dependent plugins are returned. - * Returns: (transfer none): The list of a plugins that depend on the specified plugin.
+ * @constreturn The list of a plugins that depend on the specified plugin. GSList *purple_plugin_get_dependent_plugins(const PurplePlugin *plugin);
@@ -539,11 +539,11 @@
* preferences request handle for the plugin. \n
* "flags" (PurplePluginInfoFlags) The flags for a plugin. \n
- * @first_property: The first property name
- * @...: The value of the first property, followed optionally by more
- * name/value pairs, followed by %NULL
+ * @param first_property The first property name + * @param ... The value of the first property, followed optionally by more + * name/value pairs, followed by @c NULL - * Returns: A new #PurplePluginInfo instance.
+ * @return A new #PurplePluginInfo instance. * @see PURPLE_PLUGIN_ABI_VERSION
@@ -554,63 +554,63 @@
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The plugin's ID.
+ * @return The plugin's ID. const gchar *purple_plugin_info_get_id(const PurplePluginInfo *info);
* Returns a plugin's translated name.
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The name of the plugin, or %NULL.
+ * @return The name of the plugin, or @c NULL. const gchar *purple_plugin_info_get_name(const PurplePluginInfo *info);
* Returns a plugin's version.
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The version of the plugin, or %NULL.
+ * @return The version of the plugin, or @c NULL. const gchar *purple_plugin_info_get_version(const PurplePluginInfo *info);
* Returns a plugin's primary category.
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The primary category of the plugin, or %NULL.
+ * @return The primary category of the plugin, or @c NULL. const gchar *purple_plugin_info_get_category(const PurplePluginInfo *info);
* Returns a plugin's summary.
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The summary of the plugin, or %NULL.
+ * @return The summary of the plugin, or @c NULL. const gchar *purple_plugin_info_get_summary(const PurplePluginInfo *info);
* Returns a plugin's description.
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The description of the plugin, or %NULL.
+ * @return The description of the plugin, or @c NULL. const gchar *purple_plugin_info_get_description(const PurplePluginInfo *info);
* Returns a NULL-terminated list of the plugin's authors.
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The authors of the plugin, or %NULL.
+ * @return The authors of the plugin, or @c NULL. purple_plugin_info_get_authors(const PurplePluginInfo *info);
@@ -618,54 +618,54 @@
* Returns a plugin's website.
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The website of the plugin, or %NULL.
+ * @return The website of the plugin, or @c NULL. const gchar *purple_plugin_info_get_website(const PurplePluginInfo *info);
* Returns the path to a plugin's icon.
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The path to the plugin's icon, or %NULL.
+ * @return The path to the plugin's icon, or @c NULL. const gchar *purple_plugin_info_get_icon(const PurplePluginInfo *info);
* Returns a short name of the plugin's license.
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The license name of the plugin, or %NULL.
+ * @return The license name of the plugin, or @c NULL. const gchar *purple_plugin_info_get_license_id(const PurplePluginInfo *info);
* Returns the text of a plugin's license.
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The license text of the plugin, or %NULL.
+ * @return The license text of the plugin, or @c NULL. const gchar *purple_plugin_info_get_license_text(const PurplePluginInfo *info);
* Returns the URL of a plugin's license.
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The license URL of the plugin, or %NULL.
+ * @return The license URL of the plugin, or @c NULL. const gchar *purple_plugin_info_get_license_url(const PurplePluginInfo *info);
* Returns a NULL-terminated list of IDs of plugins required by a plugin.
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The dependencies of the plugin, or %NULL.
+ * @return The dependencies of the plugin, or @c NULL. purple_plugin_info_get_dependencies(const PurplePluginInfo *info);
@@ -673,9 +673,9 @@
* Returns the required purple ABI version for a plugin.
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The required purple ABI version for the plugin.
+ * @return The required purple ABI version for the plugin. guint32 purple_plugin_info_get_abi_version(const PurplePluginInfo *info);
@@ -683,9 +683,9 @@
* Returns the callback that retrieves the list of actions a plugin can perform
- * @info: The plugin info to get the callback from.
+ * @param info The plugin info to get the callback from. - * Returns: The callback that returns a list of #PurplePluginAction
+ * @return The callback that returns a list of #PurplePluginAction * instances corresponding to the actions a plugin can perform.
@@ -695,9 +695,9 @@
* Returns a callback that gives extra information about a plugin. You must
* free the string returned by this callback.
- * @info: The plugin info to get extra information from.
+ * @param info The plugin info to get extra information from. - * Returns: The callback that returns extra information about a plugin.
+ * @return The callback that returns extra information about a plugin. purple_plugin_info_get_extra_cb(const PurplePluginInfo *info);
@@ -706,9 +706,9 @@
* Returns the callback that retrieves the preferences frame for a plugin, set
* via the "pref-frame-cb" property of the plugin info.
- * @info: The plugin info to get the callback from.
+ * @param info The plugin info to get the callback from. - * Returns: The callback that returns the preferences frame.
+ * @return The callback that returns the preferences frame. purple_plugin_info_get_pref_frame_cb(const PurplePluginInfo *info);
@@ -717,9 +717,9 @@
* Returns the callback that retrieves the preferences request handle for a
* plugin, set via the "pref-request-cb" property of the plugin info.
- * @info: The plugin info to get the callback from.
+ * @param info The plugin info to get the callback from. - * Returns: The callback that returns the preferences request handle.
+ * @return The callback that returns the preferences request handle. PurplePluginPrefRequestCb
purple_plugin_info_get_pref_request_cb(const PurplePluginInfo *info);
@@ -727,9 +727,9 @@
* Returns the plugin's flags.
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The flags of the plugin.
+ * @return The flags of the plugin. purple_plugin_info_get_flags(const PurplePluginInfo *info);
@@ -738,26 +738,26 @@
* Returns an error in the plugin info that would prevent the plugin from being
- * @info: The plugin info.
+ * @param info The plugin info. - * Returns: The plugin info error, or %NULL.
+ * @return The plugin info error, or @c NULL. const gchar *purple_plugin_info_get_error(const PurplePluginInfo *info);
* Set the UI data associated with a plugin.
- * @info: The plugin's info instance.
- * @ui_data: A pointer to associate with this object.
+ * @param info The plugin's info instance. + * @param ui_data A pointer to associate with this object. void purple_plugin_info_set_ui_data(PurplePluginInfo *info, gpointer ui_data);
* Returns the UI data associated with a plugin.
- * @info: The plugin's info instance.
+ * @param info The plugin's info instance. - * Returns: The UI data associated with this plugin. This is a
+ * @return The UI data associated with this plugin. This is a * convenience field provided to the UIs--it is not
* used by the libpurple core.
@@ -779,8 +779,8 @@
* Allocates and returns a new PurplePluginAction. Use this to add actions in a
* list in the "actions-cb" callback for your plugin.
- * @label: The description of the action to show to the user.
- * @callback: The callback to call when the user selects this action.
+ * @param label The description of the action to show to the user. + * @param callback The callback to call when the user selects this action. PurplePluginAction *purple_plugin_action_new(const char* label,
PurplePluginActionCb callback);
@@ -788,7 +788,7 @@
* Frees a PurplePluginAction
- * @action: The PurplePluginAction to free.
+ * @param action The PurplePluginAction to free. void purple_plugin_action_free(PurplePluginAction *action);
@@ -802,7 +802,7 @@
* Returns a list of all plugins, whether loaded or not.
- * Returns: A list of all plugins. The list is owned by the caller, and must be
+ * @return A list of all plugins. The list is owned by the caller, and must be * g_list_free()d to avoid leaking the nodes.
GList *purple_plugins_find_all(void);
@@ -810,14 +810,14 @@
* Returns a list of all loaded plugins.
- * Returns: (transfer none): A list of all loaded plugins.
+ * @constreturn A list of all loaded plugins. GList *purple_plugins_get_loaded(void);
* Add a new directory to search for plugins
- * @path: The new search path.
+ * @param path The new search path. void purple_plugins_add_search_path(const gchar *path);
@@ -832,18 +832,18 @@
* Finds a plugin with the specified plugin ID.
+ * @param id The plugin ID. - * Returns: The plugin if found, or %NULL if not found.
+ * @return The plugin if found, or @c NULL if not found. PurplePlugin *purple_plugins_find_plugin(const gchar *id);
* Finds a plugin with the specified filename (filename with a path).
- * @filename: The plugin filename.
+ * @param filename The plugin filename. - * Returns: The plugin if found, or %NULL if not found.
+ * @return The plugin if found, or @c NULL if not found. PurplePlugin *purple_plugins_find_by_filename(const char *filename);
@@ -851,7 +851,7 @@
* Saves the list of loaded plugins to the specified preference key.
* Plugins that are set to auto-load are not saved.
- * @key: The preference key to save the list of plugins to.
+ * @param key The preference key to save the list of plugins to. void purple_plugins_save_loaded(const char *key);
@@ -859,7 +859,7 @@
* Attempts to load all the plugins in the specified preference key
* that were loaded when purple last quit.
- * @key: The preference key containing the list of plugins.
+ * @param key The preference key containing the list of plugins. void purple_plugins_load_saved(const char *key);
@@ -873,7 +873,7 @@
* Returns the plugin subsystem handle.
- * Returns: The plugin sybsystem handle.
+ * @return The plugin sybsystem handle. void *purple_plugins_get_handle(void);
--- a/libpurple/protocol.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/protocol.h Wed Jan 29 10:49:02 2014 +0530
@@ -197,18 +197,18 @@
* On the other hand, both of these are invalid for protocols with
* number-based usernames, so function should return NULL in such case.
- * @account: The account the username is related to. Can
+ * @param account The account the username is related to. Can - * @who: The username to convert.
- * Returns: Normalized username, or NULL, if it's invalid.
+ * @param who The username to convert. + * @return Normalized username, or NULL, if it's invalid. const char *(*normalize)(const PurpleAccount *account, const char *who);
PurpleChat *(*find_blist_chat)(PurpleAccount *account, const char *name);
/** Checks whether offline messages to @a buddy are supported.
- * Returns: %TRUE if @a buddy can be sent messages while they are
- * offline, or %FALSE if not.
+ * @return @c TRUE if @a buddy can be sent messages while they are + * offline, or @c FALSE if not. gboolean (*offline_message)(const PurpleBuddy *buddy);
@@ -217,15 +217,15 @@
* table instead of expanding the struct for every addition. This hash
* table is allocated every call and MUST be unrefed by the caller.
- * @account: The account to specify. This can be NULL.
- * Returns: The protocol's string hash table. The hash table should be
+ * @param account The account to specify. This can be NULL. + * @return The protocol's string hash table. The hash table should be * destroyed by the caller when it's no longer needed.
GHashTable *(*get_account_text_table)(PurpleAccount *account);
* Returns an array of "PurpleMood"s, with the last one having
+ * "mood" set to @c NULL. PurpleMood *(*get_moods)(PurpleAccount *account);
@@ -241,10 +241,10 @@
* - used special characters.
- * @conv: The conversation to query, or NULL to get safe minimum
+ * @param conv The conversation to query, or NULL to get safe minimum - * Returns: Maximum message size, 0 if unspecified, -1 for infinite.
+ * @return Maximum message size, 0 if unspecified, -1 for infinite. gssize (*get_max_message_size)(PurpleConversation *conv);
@@ -348,12 +348,12 @@
* call one of the callbacks from an idle/0-second timeout) depending
* on if the nickname is set successfully.
- * @gc: The connection for which to set an alias
- * @alias: The new server-side alias/nickname for this account,
+ * @param gc The connection for which to set an alias + * @param alias The new server-side alias/nickname for this account, * or NULL to unset the alias/nickname (or return it to
* a protocol-specific "default").
- * @success_cb: Callback to be called if the public alias is set
- * @failure_cb: Callback to be called if setting the public alias
+ * @param success_cb Callback to be called if the public alias is set + * @param failure_cb Callback to be called if setting the public alias * @see purple_account_set_public_alias
@@ -368,9 +368,9 @@
* call one of the callbacks from an idle/0-second timeout) depending
* on if the nickname is retrieved.
- * @gc: The connection for which to retireve the alias
- * @success_cb: Callback to be called with the retrieved alias
- * @failure_cb: Callback to be called if the protocol is unable to
+ * @param gc The connection for which to retireve the alias + * @param success_cb Callback to be called with the retrieved alias + * @param failure_cb Callback to be called if the protocol is unable to * @see purple_account_get_public_alias
@@ -411,7 +411,7 @@
PurpleMessageFlags flags);
- * Returns: If this protocol requires the PURPLE_IM_TYPING message to
+ * @return If this protocol requires the PURPLE_IM_TYPING message to * be sent repeatedly to signify that the user is still
* typing, then the protocol should return the number of
* seconds to wait before sending a subsequent notification.
@@ -444,7 +444,7 @@
* information required by the protocol to join a chat. libpurple will
* call join_chat along with the information filled by the user.
- * Returns: A list of #PurpleProtocolChatEntry structs
+ * @return A list of #PurpleProtocolChatEntry structs GList *(*info)(PurpleConnection *);
@@ -456,8 +456,8 @@
* #get_chat_name if you instead need to extract a chat name from a
- * @chat_name: The chat name to be turned into components
- * Returns: Hashtable containing the information extracted from chat_name
+ * @param chat_name The chat name to be turned into components + * @return Hashtable containing the information extracted from chat_name GHashTable *(*info_defaults)(PurpleConnection *,
@@ -466,7 +466,7 @@
* Called when the user requests joining a chat. Should arrange for
* #serv_got_joined_chat to be called.
- * @components: A hashtable containing information required to
+ * @param components A hashtable containing information required to * join the chat as described by the entries returned
* by #chat_info. It may also be called when accepting
* an invitation, in which case this matches the
@@ -477,7 +477,7 @@
* Called when the user refuses a chat invitation.
- * @components: A hashtable containing information required to
+ * @param components A hashtable containing information required to * join the chat as passed to #serv_got_chat_invite.
void (*reject)(PurpleConnection *, GHashTable *components);
@@ -487,33 +487,33 @@
* #chat_info_defaults if you instead need to generate a hashtable
- * @components: A hashtable containing information about the chat.
+ * @param components A hashtable containing information about the chat. char *(*get_name)(GHashTable *components);
* Invite a user to join a chat.
- * @id: The id of the chat to invite the user to.
- * @message: A message displayed to the user when the invitation
+ * @param id The id of the chat to invite the user to. + * @param message A message displayed to the user when the invitation - * @who: The name of the user to send the invation to.
+ * @param who The name of the user to send the invation to. void (*invite)(PurpleConnection *, int id,
const char *message, const char *who);
* Called when the user requests leaving a chat.
- * @id: The id of the chat to leave
+ * @param id The id of the chat to leave void (*leave)(PurpleConnection *, int id);
* Send a whisper to a user in a chat.
- * @id: The id of the chat.
- * @who: The name of the user to send the whisper to.
- * @message: The message of the whisper.
+ * @param id The id of the chat. + * @param who The name of the user to send the whisper to. + * @param message The message of the whisper. void (*whisper)(PurpleConnection *, int id,
const char *who, const char *message);
@@ -527,11 +527,11 @@
* some other negative value. You can use one of the valid
* errno values, or just big something.
- * @id: The id of the chat to send the message to.
- * @message: The message to send to the chat.
- * @flags: A bitwise OR of #PurpleMessageFlags representing
+ * @param id The id of the chat to send the message to. + * @param message The message to send to the chat. + * @param flags A bitwise OR of #PurpleMessageFlags representing - * Returns: A positive number or 0 in case of success,
+ * @return A positive number or 0 in case of success, * a negative error number in case of failure.
int (*send)(PurpleConnection *, int id, const char *message,
@@ -540,10 +540,10 @@
/** Gets the real name of a participant in a chat. For example, on
* XMPP this turns a chat room nick <tt>foo</tt> into
* <tt>room\@server/foo</tt>
- * @gc: the connection on which the room is.
- * @id: the ID of the chat room.
- * @who: the nickname of the chat participant.
- * Returns: the real name of the participant. This string must be
+ * @param gc the connection on which the room is. + * @param id the ID of the chat room. + * @param who the nickname of the chat participant. + * @return the real name of the participant. This string must be char *(*get_user_real_name)(PurpleConnection *gc, int id, const char *who);
@@ -671,10 +671,10 @@
* Initiate a media session with the given contact.
- * @account: The account to initiate the media session on.
- * @who: The remote user to initiate the session with.
- * @type: The type of media session to initiate.
- * Returns: TRUE if the call succeeded else FALSE. (Doesn't imply the media
+ * @param account The account to initiate the media session on. + * @param who The remote user to initiate the session with. + * @param type The type of media session to initiate. + * @return TRUE if the call succeeded else FALSE. (Doesn't imply the media * session or stream will be successfully created)
gboolean (*initiate_session)(PurpleAccount *account, const char *who,
@@ -684,9 +684,9 @@
* Checks to see if the given contact supports the given type of media
- * @account: The account the contact is on.
- * @who: The remote user to check for media capability with.
- * Returns: The media caps the contact supports.
+ * @param account The account the contact is on. + * @param who The remote user to check for media capability with. + * @return The media caps the contact supports. PurpleMediaCaps (*get_caps)(PurpleAccount *account,
@@ -763,63 +763,63 @@
* Returns the ID of a protocol.
- * @protocol: The protocol.
+ * @param protocol The protocol. - * Returns: The ID of the protocol.
+ * @return The ID of the protocol. const char *purple_protocol_get_id(const PurpleProtocol *protocol);
* Returns the translated name of a protocol.
- * @protocol: The protocol.
+ * @param protocol The protocol. - * Returns: The translated name of the protocol.
+ * @return The translated name of the protocol. const char *purple_protocol_get_name(const PurpleProtocol *protocol);
* Returns the options of a protocol.
- * @protocol: The protocol.
+ * @param protocol The protocol. - * Returns: The options of the protocol.
+ * @return The options of the protocol. PurpleProtocolOptions purple_protocol_get_options(const PurpleProtocol *protocol);
* Returns the user splits of a protocol.
- * @protocol: The protocol.
+ * @param protocol The protocol. - * Returns: The user splits of the protocol.
+ * @return The user splits of the protocol. GList *purple_protocol_get_user_splits(const PurpleProtocol *protocol);
* Returns the protocol options of a protocol.
- * @protocol: The protocol.
+ * @param protocol The protocol. - * Returns: The protocol options of the protocol.
+ * @return The protocol options of the protocol. GList *purple_protocol_get_protocol_options(const PurpleProtocol *protocol);
* Returns the icon spec of a protocol.
- * @protocol: The protocol.
+ * @param protocol The protocol. - * Returns: The icon spec of the protocol.
+ * @return The icon spec of the protocol. PurpleBuddyIconSpec *purple_protocol_get_icon_spec(const PurpleProtocol *protocol);
* Returns the whiteboard ops of a protocol.
- * @protocol: The protocol.
+ * @param protocol The protocol. - * Returns: The whiteboard ops of the protocol.
+ * @return The whiteboard ops of the protocol. PurpleWhiteboardOps *purple_protocol_get_whiteboard_ops(const PurpleProtocol *protocol);
@@ -829,8 +829,8 @@
* This function is called in the *_init() function of your derived protocol,
* to delete the parent type's data so you can define your own.
- * @protocol: The protocol instance.
- * @flags: What instance data to delete.
+ * @param protocol The protocol instance. + * @param flags What instance data to delete. void purple_protocol_override(PurpleProtocol *protocol,
PurpleProtocolOverrideFlags flags);
--- a/libpurple/protocols.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/protocols.h Wed Jan 29 10:49:02 2014 +0530
@@ -196,15 +196,15 @@
* Creates a new #PurpleAttentionType object and sets its mandatory parameters.
- * @ulname: A non-localized string that can be used by UIs in need of such
+ * @param ulname A non-localized string that can be used by UIs in need of such * non-localized strings. This should be the same as @a name,
- * @name: A localized string that the UI may display for the event. This
+ * @param name A localized string that the UI may display for the event. This * should be the same string as @a ulname, with localization.
- * @inc_desc: A localized description shown when the event is received.
- * @out_desc: A localized description shown when the event is sent.
+ * @param inc_desc A localized description shown when the event is received. + * @param out_desc A localized description shown when the event is sent. - * Returns: A pointer to the new object.
+ * @return A pointer to the new object. PurpleAttentionType *purple_attention_type_new(const char *ulname, const char *name,
const char *inc_desc, const char *out_desc);
@@ -212,8 +212,8 @@
* Sets the displayed name of the attention-demanding event.
- * @type: The attention type.
- * @name: The localized name that will be displayed by UIs. This should be
+ * @param type The attention type. + * @param name The localized name that will be displayed by UIs. This should be * the same string given as the unlocalized name, but with
@@ -223,8 +223,8 @@
* Sets the description of the attention-demanding event shown in conversations
* when the event is received.
- * @type: The attention type.
- * @desc: The localized description for incoming events.
+ * @param type The attention type. + * @param desc The localized description for incoming events. void purple_attention_type_set_incoming_desc(PurpleAttentionType *type, const char *desc);
@@ -232,17 +232,17 @@
* Sets the description of the attention-demanding event shown in conversations
* when the event is sent.
- * @type: The attention type.
- * @desc: The localized description for outgoing events.
+ * @param type The attention type. + * @param desc The localized description for outgoing events. void purple_attention_type_set_outgoing_desc(PurpleAttentionType *type, const char *desc);
* Sets the name of the icon to display for the attention event; this is optional.
- * @type: The attention type.
- * @name: The icon's name.
- * Note: Icons are optional for attention events.
+ * @param type The attention type. + * @param name The icon's name. + * @note Icons are optional for attention events. void purple_attention_type_set_icon_name(PurpleAttentionType *type, const char *name);
@@ -250,8 +250,8 @@
* Sets the unlocalized name of the attention event; some UIs may need this,
- * @type: The attention type.
- * @ulname: The unlocalized name. This should be the same string given as
+ * @param type The attention type. + * @param ulname The unlocalized name. This should be the same string given as * the localized name, but without localization.
void purple_attention_type_set_unlocalized_name(PurpleAttentionType *type, const char *ulname);
@@ -259,42 +259,42 @@
* Get the attention type's name as displayed by the UI.
- * @type: The attention type.
+ * @param type The attention type.
const char *purple_attention_type_get_name(const PurpleAttentionType *type);
* Get the attention type's description shown when the event is received.
- * @type: The attention type.
- * Returns: The description.
+ * @param type The attention type. + * @return The description. const char *purple_attention_type_get_incoming_desc(const PurpleAttentionType *type);
* Get the attention type's description shown when the event is sent.
- * @type: The attention type.
- * Returns: The description.
+ * @param type The attention type. + * @return The description. const char *purple_attention_type_get_outgoing_desc(const PurpleAttentionType *type);
* Get the attention type's icon name.
- * @type: The attention type.
- * Returns: The icon name or %NULL if unset/empty.
- * Note: Icons are optional for attention events.
+ * @param type The attention type. + * @return The icon name or @c NULL if unset/empty. + * @note Icons are optional for attention events. const char *purple_attention_type_get_icon_name(const PurpleAttentionType *type);
* Get the attention type's unlocalized name; this is useful for some UIs.
- * @type: The attention type
- * Returns: The unlocalized name.
+ * @param type The attention type + * @return The unlocalized name. const char *purple_attention_type_get_unlocalized_name(const PurpleAttentionType *type);
@@ -314,8 +314,8 @@
* Allocates and returns a new PurpleProtocolAction. Use this to add actions in
* a list in the get_actions function of the protocol.
- * @label: The description of the action to show to the user.
- * @callback: The callback to call when the user selects this action.
+ * @param label The description of the action to show to the user. + * @param callback The callback to call when the user selects this action. PurpleProtocolAction *purple_protocol_action_new(const char* label,
PurpleProtocolActionCallback callback);
@@ -323,7 +323,7 @@
* Frees a PurpleProtocolAction
- * @action: The PurpleProtocolAction to free.
+ * @param action The PurpleProtocolAction to free. void purple_protocol_action_free(PurpleProtocolAction *action);
@@ -351,9 +351,9 @@
* This is meant to be called from protocols.
- * @account: The account.
- * @idle: The user's idle state.
- * @idle_time: The user's idle time.
+ * @param account The account. + * @param idle The user's idle state. + * @param idle_time The user's idle time. void purple_protocol_got_account_idle(PurpleAccount *account, gboolean idle,
@@ -363,8 +363,8 @@
* This is meant to be called from protocols.
- * @account: The account the user is on.
- * @login_time: The user's log-in time.
+ * @param account The account the user is on. + * @param login_time The user's log-in time. void purple_protocol_got_account_login_time(PurpleAccount *account,
@@ -374,9 +374,9 @@
* This is meant to be called from protocols.
- * @account: The account the user is on.
- * @status_id: The status ID.
- * @...: A NULL-terminated list of attribute IDs and values,
+ * @param account The account the user is on. + * @param status_id The status ID. + * @param ... A NULL-terminated list of attribute IDs and values, * beginning with the value for @a attr_id.
void purple_protocol_got_account_status(PurpleAccount *account,
@@ -390,7 +390,7 @@
* This is meant to be called from protocols.
- * @account: The account.
+ * @param account The account. * @see account-actions-changed
@@ -401,10 +401,10 @@
* This is meant to be called from protocols.
- * @account: The account the user is on.
- * @name: The name of the buddy.
- * @idle: The user's idle state.
- * @idle_time: The user's idle time. This is the time at
+ * @param account The account the user is on. + * @param name The name of the buddy. + * @param idle The user's idle state. + * @param idle_time The user's idle time. This is the time at * which the user became idle, in seconds since
* the epoch. If the protocol does not know this value
@@ -417,9 +417,9 @@
* This is meant to be called from protocols.
- * @account: The account the user is on.
- * @name: The name of the buddy.
- * @login_time: The user's log-in time.
+ * @param account The account the user is on. + * @param name The name of the buddy. + * @param login_time The user's log-in time. void purple_protocol_got_user_login_time(PurpleAccount *account,
const char *name, time_t login_time);
@@ -429,10 +429,10 @@
* This is meant to be called from protocols.
- * @account: The account the user is on.
- * @name: The name of the buddy.
- * @status_id: The status ID.
- * @...: A NULL-terminated list of attribute IDs and values,
+ * @param account The account the user is on. + * @param name The name of the buddy. + * @param status_id The status ID. + * @param ... A NULL-terminated list of attribute IDs and values, * beginning with the value for @a attr_id.
void purple_protocol_got_user_status(PurpleAccount *account, const char *name,
@@ -444,9 +444,9 @@
* This is meant to be called from protocols.
- * @account: The account the user is on.
- * @name: The name of the buddy.
- * @status_id: The status ID.
+ * @param account The account the user is on. + * @param name The name of the buddy. + * @param status_id The status ID. void purple_protocol_got_user_status_deactive(PurpleAccount *account,
@@ -455,9 +455,9 @@
* Informs the server that our account's status changed.
- * @account: The account the user is on.
- * @old_status: The previous status.
- * @new_status: The status that was activated, or deactivated
+ * @param account The account the user is on. + * @param old_status The previous status. + * @param new_status The status that was activated, or deactivated * (in the case of independent statuses).
void purple_protocol_change_account_status(PurpleAccount *account,
@@ -467,10 +467,10 @@
* Retrieves the list of stock status types from a protocol.
- * @account: The account the user is on.
- * @presence: The presence for which we're going to get statuses
+ * @param account The account the user is on. + * @param presence The presence for which we're going to get statuses - * Returns: List of statuses
+ * @return List of statuses GList *purple_protocol_get_statuses(PurpleAccount *account,
PurplePresence *presence);
@@ -478,9 +478,9 @@
* Send an attention request message.
- * @gc: The connection to send the message on.
- * @who: Whose attention to request.
- * @type_code: An index into the protocol's attention_types list
+ * @param gc The connection to send the message on. + * @param who Whose attention to request. + * @param type_code An index into the protocol's attention_types list * determining the type of the attention request command to
* send. 0 if protocol only defines one (for example, Yahoo and
* MSN), but some protocols define more (MySpaceIM).
@@ -494,9 +494,9 @@
* Process an incoming attention message.
- * @gc: The connection that received the attention message.
- * @who: Who requested your attention.
- * @type_code: An index into the protocol's attention_types list
+ * @param gc The connection that received the attention message. + * @param who Who requested your attention. + * @param type_code An index into the protocol's attention_types list * determining the type of the attention request command to
@@ -506,10 +506,10 @@
* Process an incoming attention message in a chat.
- * @gc: The connection that received the attention message.
- * @who: Who requested your attention.
- * @type_code: An index into the protocol's attention_types list
+ * @param gc The connection that received the attention message. + * @param id The chat id. + * @param who Who requested your attention. + * @param type_code An index into the protocol's attention_types list * determining the type of the attention request command to
@@ -519,10 +519,10 @@
* Determines if the contact supports the given media session type.
- * @account: The account the user is on.
- * @who: The name of the contact to check capabilities for.
+ * @param account The account the user is on. + * @param who The name of the contact to check capabilities for. - * Returns: The media caps the contact supports.
+ * @return The media caps the contact supports. PurpleMediaCaps purple_protocol_get_media_caps(PurpleAccount *account,
@@ -530,11 +530,11 @@
* Initiates a media session with the given contact.
- * @account: The account the user is on.
- * @who: The name of the contact to start a session with.
- * @type: The type of media session to start.
+ * @param account The account the user is on. + * @param who The name of the contact to start a session with. + * @param type The type of media session to start. - * Returns: TRUE if the call succeeded else FALSE. (Doesn't imply the media
+ * @return TRUE if the call succeeded else FALSE. (Doesn't imply the media * session or stream will be successfully created)
gboolean purple_protocol_initiate_media(PurpleAccount *account,
@@ -546,8 +546,8 @@
* This function is intended to be used only by protocols.
- * @account: The account the user is on.
- * @who: The name of the contact for which capabilities have been received.
+ * @param account The account the user is on. + * @param who The name of the contact for which capabilities have been received. void purple_protocol_got_media_caps(PurpleAccount *account, const char *who);
@@ -556,9 +556,9 @@
* @see PurpleProtocol#get_max_message_size
- * @protocol: The protocol to query.
+ * @param protocol The protocol to query. - * Returns: Maximum message size, 0 if unspecified, -1 for infinite.
+ * @return Maximum message size, 0 if unspecified, -1 for infinite. purple_protocol_get_max_message_size(PurpleProtocol *protocol);
@@ -573,18 +573,18 @@
* Finds a protocol by ID.
- * @id: The protocol's ID.
+ * @param id The protocol's ID. PurpleProtocol *purple_protocols_find(const char *id);
* Adds a protocol to the list of protocols.
- * @protocol_type: The type of the protocol to add.
- * @error: Return location for a #GError or %NULL. If provided, this
+ * @param protocol_type The type of the protocol to add. + * @param error Return location for a #GError or @c NULL. If provided, this * will be set to the reason if adding fails.
- * Returns: The protocol instance if the protocol was added, else %NULL.
+ * @return The protocol instance if the protocol was added, else @c NULL. PurpleProtocol *purple_protocols_add(GType protocol_type, GError **error);
@@ -593,18 +593,18 @@
* connected accounts using this protocol, and free the protocol's user splits
- * @protocol: The protocol to remove.
- * @error: Return location for a #GError or %NULL. If provided, this
+ * @param protocol The protocol to remove. + * @param error Return location for a #GError or @c NULL. If provided, this * will be set to the reason if removing fails.
- * Returns: TRUE if the protocol was removed, else FALSE.
+ * @return TRUE if the protocol was removed, else FALSE. gboolean purple_protocols_remove(PurpleProtocol *protocol, GError **error);
* Returns a list of all loaded protocols.
- * Returns: A list of all loaded protocols. The list is owned by the caller, and
+ * @return 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.
GList *purple_protocols_get_all(void);
@@ -624,7 +624,7 @@
* Returns the protocols subsystem handle.
- * Returns: The protocols subsystem handle.
+ * @return The protocols subsystem handle. void *purple_protocols_get_handle(void);
--- a/libpurple/request.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/request.h Wed Jan 29 10:49:02 2014 +0530
@@ -205,7 +205,7 @@
* Creates new parameters set for the request, which may or may not be used by
* the UI to display the request.
- * Returns: The new parameters set.
+ * @return The new parameters set. PurpleRequestCommonParameters *
purple_request_cpar_new(void);
@@ -213,7 +213,7 @@
* Creates new parameters set initially bound with the #PurpleConnection.
- * Returns: The new parameters set.
+ * @return The new parameters set. PurpleRequestCommonParameters *
purple_request_cpar_from_connection(PurpleConnection *gc);
@@ -221,7 +221,7 @@
* Creates new parameters set initially bound with the #PurpleAccount.
- * Returns: The new parameters set.
+ * @return The new parameters set. PurpleRequestCommonParameters *
purple_request_cpar_from_account(PurpleAccount *account);
@@ -229,7 +229,7 @@
* Creates new parameters set initially bound with the #PurpleConversation.
- * Returns: The new parameters set.
+ * @return The new parameters set. PurpleRequestCommonParameters *
purple_request_cpar_from_conversation(PurpleConversation *conv);
@@ -237,7 +237,7 @@
* Increases the reference count on the parameters set.
- * @cpar: The object to ref.
+ * @param cpar The object to ref. purple_request_cpar_ref(PurpleRequestCommonParameters *cpar);
@@ -247,18 +247,18 @@
* The object will be destroyed when this reaches 0.
- * @cpar: The parameters set object to unref and possibly destroy.
+ * @param cpar The parameters set object to unref and possibly destroy. - * Returns: The NULL, if object was destroyed, cpar otherwise.
+ * @return The NULL, if object was destroyed, cpar otherwise. PurpleRequestCommonParameters *
purple_request_cpar_unref(PurpleRequestCommonParameters *cpar);
- * Sets the #PurpleAccount associated with the request, or %NULL, if none is.
+ * Sets the #PurpleAccount associated with the request, or @c NULL, if none is. - * @cpar: The parameters set.
- * @account: The #PurpleAccount to associate.
+ * @param cpar The parameters set. + * @param account The #PurpleAccount to associate. purple_request_cpar_set_account(PurpleRequestCommonParameters *cpar,
@@ -267,19 +267,19 @@
* Gets the #PurpleAccount associated with the request.
- * @cpar: The parameters set (may be %NULL).
+ * @param cpar The parameters set (may be @c NULL). - * Returns: The associated #PurpleAccount, or NULL if none is.
+ * @return The associated #PurpleAccount, or NULL if none is. purple_request_cpar_get_account(PurpleRequestCommonParameters *cpar);
- * Sets the #PurpleConversation associated with the request, or %NULL, if
+ * Sets the #PurpleConversation associated with the request, or @c NULL, if - * @cpar: The parameters set.
- * @conv: The #PurpleConversation to associate.
+ * @param cpar The parameters set. + * @param conv The #PurpleConversation to associate. purple_request_cpar_set_conversation(PurpleRequestCommonParameters *cpar,
@@ -288,9 +288,9 @@
* Gets the #PurpleConversation associated with the request.
- * @cpar: The parameters set (may be %NULL).
+ * @param cpar The parameters set (may be @c NULL). - * Returns: The associated #PurpleConversation, or NULL if none is.
+ * @return The associated #PurpleConversation, or NULL if none is. purple_request_cpar_get_conversation(PurpleRequestCommonParameters *cpar);
@@ -298,8 +298,8 @@
* Sets the icon associated with the request.
- * @cpar: The parameters set.
- * @icon_type: The icon type.
+ * @param cpar The parameters set. + * @param icon_type The icon type. purple_request_cpar_set_icon(PurpleRequestCommonParameters *cpar,
@@ -308,9 +308,9 @@
* Gets the icon associated with the request.
- * @cpar: The parameters set.
+ * @param cpar The parameters set. - * Returns:s icon_type The icon type.
+ * @returns icon_type The icon type. purple_request_cpar_get_icon(PurpleRequestCommonParameters *cpar);
@@ -318,9 +318,9 @@
* Sets the custom icon associated with the request.
- * @cpar: The parameters set.
- * @icon_data: The icon image contents (%NULL to reset).
- * @icon_size: The icon image size.
+ * @param cpar The parameters set. + * @param icon_data The icon image contents (@c NULL to reset). + * @param icon_size The icon image size. purple_request_cpar_set_custom_icon(PurpleRequestCommonParameters *cpar,
@@ -329,11 +329,11 @@
* Gets the custom icon associated with the request.
- * @cpar: The parameters set (may be %NULL).
- * @icon_size: The pointer to variable, where icon size should be stored
+ * @param cpar The parameters set (may be @c NULL). + * @param icon_size The pointer to variable, where icon size should be stored - * Returns: The icon image contents.
+ * @return The icon image contents. purple_request_cpar_get_custom_icon(PurpleRequestCommonParameters *cpar,
@@ -342,8 +342,8 @@
* Switches the request text to be HTML or not.
- * @cpar: The parameters set.
- * @enabled: 1, if the text passed with the request contains HTML,
+ * @param cpar The parameters set. + * @param enabled 1, if the text passed with the request contains HTML, * 0 otherwise. Don't use any other values, as they may be
* redefined in the future.
@@ -354,9 +354,9 @@
* Checks, if the text passed to the request is HTML.
- * @cpar: The parameters set (may be %NULL).
+ * @param cpar The parameters set (may be @c NULL). - * Returns: %TRUE, if the text is HTML, %FALSE otherwise.
+ * @return @c TRUE, if the text is HTML, @c FALSE otherwise. purple_request_cpar_is_html(PurpleRequestCommonParameters *cpar);
@@ -364,8 +364,8 @@
* Sets dialog display mode to compact or default.
- * @cpar: The parameters set.
- * @compact: TRUE for compact, FALSE otherwise.
+ * @param cpar The parameters set. + * @param compact TRUE for compact, FALSE otherwise. purple_request_cpar_set_compact(PurpleRequestCommonParameters *cpar,
@@ -374,9 +374,9 @@
* Gets dialog display mode.
- * @cpar: The parameters set (may be %NULL).
+ * @param cpar The parameters set (may be @c NULL). - * Returns: TRUE for compact, FALSE for default.
+ * @return TRUE for compact, FALSE for default. purple_request_cpar_is_compact(PurpleRequestCommonParameters *cpar);
@@ -384,9 +384,9 @@
* Sets the callback for the Help button.
- * @cpar: The parameters set.
- * @user_data: The data to be passed to the callback.
+ * @param cpar The parameters set. + * @param cb The callback. + * @param user_data The data to be passed to the callback. purple_request_cpar_set_help_cb(PurpleRequestCommonParameters *cpar,
@@ -395,11 +395,11 @@
* Gets the callback for the Help button.
- * @cpar: The parameters set (may be %NULL).
- * @user_data: The pointer to the variable, where user data (to be passed
+ * @param cpar The parameters set (may be @c NULL). + * @param user_data The pointer to the variable, where user data (to be passed * to callback function) should be stored.
- * Returns: The callback.
+ * @return The callback. purple_request_cpar_get_help_cb(PurpleRequestCommonParameters *cpar,
@@ -408,8 +408,8 @@
* Sets extra actions for the PurpleRequestFields dialog.
- * @cpar: The parameters set.
- * @...: A list of actions. These are pairs of arguments. The first of
+ * @param cpar The parameters set. + * @param ... A list of actions. These are pairs of arguments. The first of * each pair is the <tt>char *</tt> label that appears on the
* button. It should have an underscore before the letter you want
* to use as the accelerator key for the button. The second of each
@@ -422,9 +422,9 @@
* Gets extra actions for the PurpleRequestFields dialog.
- * @cpar: The parameters set (may be %NULL).
+ * @param cpar The parameters set (may be @c NULL). - * Returns: A list of actions (pairs of arguments, as in setter).
+ * @return A list of actions (pairs of arguments, as in setter). purple_request_cpar_get_extra_actions(PurpleRequestCommonParameters *cpar);
@@ -433,8 +433,8 @@
* Sets the same parent window for this dialog, as the parent of specified
* Notify API or Request API dialog UI handle.
- * @cpar: The parameters set.
- * @ui_handle: The UI handle.
+ * @param cpar The parameters set. + * @param ui_handle The UI handle. purple_request_cpar_set_parent_from(PurpleRequestCommonParameters *cpar,
@@ -443,9 +443,9 @@
* Gets the parent "donor" for this dialog.
- * @cpar: The parameters set (may be %NULL).
+ * @param cpar The parameters set (may be @c NULL). - * Returns: The donors UI handle.
+ * @return The donors UI handle. purple_request_cpar_get_parent_from(PurpleRequestCommonParameters *cpar);
@@ -460,22 +460,22 @@
* Creates a list of fields to pass to purple_request_fields().
- * Returns: A PurpleRequestFields structure.
+ * @return A PurpleRequestFields structure. PurpleRequestFields *purple_request_fields_new(void);
* Destroys a list of fields.
- * @fields: The list of fields to destroy.
+ * @param fields The list of fields to destroy. void purple_request_fields_destroy(PurpleRequestFields *fields);
* Adds a group of fields to the list.
- * @fields: The fields list.
- * @group: The group to add.
+ * @param fields The fields list. + * @param group The group to add. void purple_request_fields_add_group(PurpleRequestFields *fields,
PurpleRequestFieldGroup *group);
@@ -483,18 +483,18 @@
* Returns a list of all groups in a field list.
- * @fields: The fields list.
+ * @param fields The fields list. - * Returns: (transfer none): A list of groups.
+ * @constreturn A list of groups. GList *purple_request_fields_get_groups(const PurpleRequestFields *fields);
* Set tab names for a field list.
- * @fields: The fields list.
- * @tab_names: NULL-terminated array of localized tab labels,
+ * @param fields The fields list. + * @param tab_names NULL-terminated array of localized tab labels, void purple_request_fields_set_tab_names(PurpleRequestFields *fields,
const gchar **tab_names);
@@ -502,9 +502,9 @@
* Returns tab names of a field list.
- * @fields: The fields list.
+ * @param fields The fields list. - * Returns: NULL-terminated array of localized tab labels, or NULL if tabs
+ * @return NULL-terminated array of localized tab labels, or NULL if tabs @@ -513,10 +513,10 @@
* Returns whether or not the field with the specified ID exists.
- * @fields: The fields list.
- * @id: The ID of the field.
+ * @param fields The fields list. + * @param id The ID of the field. - * Returns: TRUE if the field exists, or FALSE.
+ * @return TRUE if the field exists, or FALSE. gboolean purple_request_fields_exists(const PurpleRequestFields *fields,
@@ -524,9 +524,9 @@
* Returns a list of all required fields.
- * @fields: The fields list.
+ * @param fields The fields list. - * Returns: (transfer none): The list of required fields.
+ * @constreturn The list of required fields. const GList *purple_request_fields_get_required(
const PurpleRequestFields *fields);
@@ -534,9 +534,9 @@
* Returns a list of all validated fields.
- * @fields: The fields list.
+ * @param fields The fields list. - * Returns: (transfer none): The list of validated fields.
+ * @constreturn The list of validated fields. const GList *purple_request_fields_get_validatable(
const PurpleRequestFields *fields);
@@ -544,9 +544,9 @@
* Returns a list of all fields with sensitivity callback added.
- * @fields: The fields list.
+ * @param fields The fields list. - * Returns: (transfer none): The list of fields with automatic sensitivity callback.
+ * @constreturn The list of fields with automatic sensitivity callback. purple_request_fields_get_autosensitive(const PurpleRequestFields *fields);
@@ -554,10 +554,10 @@
* Returns whether or not a field with the specified ID is required.
- * @fields: The fields list.
+ * @param fields The fields list. + * @param id The field ID. - * Returns: TRUE if the specified field is required, or FALSE.
+ * @return TRUE if the specified field is required, or FALSE. gboolean purple_request_fields_is_field_required(const PurpleRequestFields *fields,
@@ -565,9 +565,9 @@
* Returns whether or not all required fields have values.
- * @fields: The fields list.
+ * @param fields The fields list. - * Returns: TRUE if all required fields have values, or FALSE.
+ * @return TRUE if all required fields have values, or FALSE. gboolean purple_request_fields_all_required_filled(
const PurpleRequestFields *fields);
@@ -575,19 +575,19 @@
* Returns whether or not all fields are valid.
- * @fields: The fields list.
+ * @param fields The fields list. - * Returns: TRUE if all fields are valid, or FALSE.
+ * @return TRUE if all fields are valid, or FALSE. gboolean purple_request_fields_all_valid(const PurpleRequestFields *fields);
* Return the field with the specified ID.
- * @fields: The fields list.
- * @id: The ID of the field.
+ * @param fields The fields list. + * @param id The ID of the field. - * Returns: The field, if found.
+ * @return The field, if found. PurpleRequestField *purple_request_fields_get_field(
const PurpleRequestFields *fields, const char *id);
@@ -595,10 +595,10 @@
* Returns the string value of a field with the specified ID.
- * @fields: The fields list.
- * @id: The ID of the field.
+ * @param fields The fields list. + * @param id The ID of the field. - * Returns: The string value, if found, or %NULL otherwise.
+ * @return The string value, if found, or @c NULL otherwise. const char *purple_request_fields_get_string(const PurpleRequestFields *fields,
@@ -606,10 +606,10 @@
* Returns the integer value of a field with the specified ID.
- * @fields: The fields list.
- * @id: The ID of the field.
+ * @param fields The fields list. + * @param id The ID of the field. - * Returns: The integer value, if found, or 0 otherwise.
+ * @return The integer value, if found, or 0 otherwise. int purple_request_fields_get_integer(const PurpleRequestFields *fields,
@@ -617,10 +617,10 @@
* Returns the boolean value of a field with the specified ID.
- * @fields: The fields list.
- * @id: The ID of the field.
+ * @param fields The fields list. + * @param id The ID of the field. - * Returns: The boolean value, if found, or %FALSE otherwise.
+ * @return The boolean value, if found, or @c FALSE otherwise. gboolean purple_request_fields_get_bool(const PurpleRequestFields *fields,
@@ -628,10 +628,10 @@
* Returns the choice index of a field with the specified ID.
- * @fields: The fields list.
- * @id: The ID of the field.
+ * @param fields The fields list. + * @param id The ID of the field. - * Returns: The choice value, if found, or NULL otherwise.
+ * @return The choice value, if found, or NULL otherwise. purple_request_fields_get_choice(const PurpleRequestFields *fields,
@@ -640,10 +640,10 @@
* Returns the account of a field with the specified ID.
- * @fields: The fields list.
- * @id: The ID of the field.
+ * @param fields The fields list. + * @param id The ID of the field. - * Returns: The account value, if found, or NULL otherwise.
+ * @return The account value, if found, or NULL otherwise. PurpleAccount *purple_request_fields_get_account(const PurpleRequestFields *fields,
@@ -651,9 +651,9 @@
* Returns the UI data associated with this object.
- * @fields: The fields list.
+ * @param fields The fields list. - * Returns: The UI data associated with this object. This is a
+ * @return The UI data associated with this object. This is a * convenience field provided to the UIs--it is not
* used by the libpurple core.
@@ -662,8 +662,8 @@
* Set the UI data associated with this object.
- * @fields: The fields list.
- * @ui_data: A pointer to associate with this object.
+ * @param fields The fields list. + * @param ui_data A pointer to associate with this object. void purple_request_fields_set_ui_data(PurpleRequestFields *fields, gpointer ui_data);
@@ -677,17 +677,17 @@
* Creates a fields group with an optional title.
- * @title: The optional title to give the group.
+ * @param title The optional title to give the group. - * Returns: A new fields group
+ * @return A new fields group PurpleRequestFieldGroup *purple_request_field_group_new(const char *title);
* Sets tab number for a group.
- * @tab_no: The tab number.
+ * @param group The group. + * @param tab_no The tab number. * @see purple_request_fields_set_tab_names
@@ -697,9 +697,9 @@
* Returns tab number of a group.
+ * @param group The group.
* @see purple_request_fields_get_tab_names
@@ -708,15 +708,15 @@
* Destroys a fields group.
- * @group: The group to destroy.
+ * @param group The group to destroy. void purple_request_field_group_destroy(PurpleRequestFieldGroup *group);
* Adds a field to the group.
- * @group: The group to add the field to.
- * @field: The field to add to the group.
+ * @param group The group to add the field to. + * @param field The field to add to the group. void purple_request_field_group_add_field(PurpleRequestFieldGroup *group,
PurpleRequestField *field);
@@ -724,9 +724,9 @@
* Returns the title of a fields group.
+ * @param group The group. - * Returns: The title, if set.
+ * @return The title, if set. const char *purple_request_field_group_get_title(
const PurpleRequestFieldGroup *group);
@@ -734,9 +734,9 @@
* Returns a list of all fields in a group.
+ * @param group The group. - * Returns: (transfer none): The list of fields in the group.
+ * @constreturn The list of fields in the group. GList *purple_request_field_group_get_fields(
const PurpleRequestFieldGroup *group);
@@ -744,9 +744,9 @@
* Returns a list of all fields in a group.
+ * @param group The group. - * Returns: (transfer none): The list of fields in the group.
+ * @constreturn The list of fields in the group. PurpleRequestFields *purple_request_field_group_get_fields_list(
const PurpleRequestFieldGroup *group);
@@ -761,11 +761,11 @@
* Creates a field of the specified type.
- * @text: The text label of the field.
- * @type: The type of field.
+ * @param id The field ID. + * @param text The text label of the field. + * @param type The type of field. - * Returns: The new field.
+ * @return The new field. PurpleRequestField *purple_request_field_new(const char *id, const char *text,
PurpleRequestFieldType type);
@@ -773,23 +773,23 @@
- * @field: The field to destroy.
+ * @param field The field to destroy. void purple_request_field_destroy(PurpleRequestField *field);
* Sets the label text of a field.
- * @label: The text label.
+ * @param field The field. + * @param label The text label. void purple_request_field_set_label(PurpleRequestField *field, const char *label);
* Sets whether or not a field is visible.
- * @visible: TRUE if visible, or FALSE if not.
+ * @param field The field. + * @param visible TRUE if visible, or FALSE if not. void purple_request_field_set_visible(PurpleRequestField *field, gboolean visible);
@@ -799,8 +799,8 @@
* This is optionally used by the UIs to provide such features as
* auto-completion for type hints like "account" and "screenname".
- * @type_hint: The type hint.
+ * @param field The field. + * @param type_hint The type hint. void purple_request_field_set_type_hint(PurpleRequestField *field,
@@ -811,8 +811,8 @@
* This is optionally used by the UIs to provide a tooltip for
- * @tooltip: The tooltip text.
+ * @param field The field. + * @param tooltip The tooltip text. void purple_request_field_set_tooltip(PurpleRequestField *field,
@@ -820,8 +820,8 @@
* Sets whether or not a field is required.
- * @required: TRUE if required, or FALSE.
+ * @param field The field. + * @param required TRUE if required, or FALSE. void purple_request_field_set_required(PurpleRequestField *field,
@@ -829,90 +829,90 @@
* Returns the type of a field.
+ * @param field The field. - * Returns: The field's type.
+ * @return The field's type. PurpleRequestFieldType purple_request_field_get_type(const PurpleRequestField *field);
* Returns the group for the field.
+ * @param field The field. - * Returns: The UI data.
PurpleRequestFieldGroup *purple_request_field_get_group(const PurpleRequestField *field);
* Returns the ID of a field.
+ * @param field The field.
const char *purple_request_field_get_id(const PurpleRequestField *field);
* Returns the label text of a field.
+ * @param field The field. - * Returns: The label text.
+ * @return The label text. const char *purple_request_field_get_label(const PurpleRequestField *field);
* Returns whether or not a field is visible.
+ * @param field The field. - * Returns: TRUE if the field is visible. FALSE otherwise.
+ * @return TRUE if the field is visible. FALSE otherwise. gboolean purple_request_field_is_visible(const PurpleRequestField *field);
* Returns the field's type hint.
+ * @param field The field. - * Returns: The field's type hint.
+ * @return The field's type hint. const char *purple_request_field_get_type_hint(const PurpleRequestField *field);
* Returns the field's tooltip.
+ * @param field The field. - * Returns: The field's tooltip.
+ * @return The field's tooltip. const char *purple_request_field_get_tooltip(const PurpleRequestField *field);
* Returns whether or not a field is required.
+ * @param field The field. - * Returns: TRUE if the field is required, or FALSE.
+ * @return TRUE if the field is required, or FALSE. gboolean purple_request_field_is_required(const PurpleRequestField *field);
* Checks, if specified field has value.
+ * @param field The field. - * Returns: TRUE if the field has value, or FALSE.
+ * @return TRUE if the field has value, or FALSE. gboolean purple_request_field_is_filled(const PurpleRequestField *field);
* Sets validator for a single field.
- * @validator: The validator callback, NULL to disable validation.
- * @user_data: The data to pass to the callback.
+ * @param field The field. + * @param validator The validator callback, NULL to disable validation. + * @param user_data The data to pass to the callback. void purple_request_field_set_validator(PurpleRequestField *field,
PurpleRequestFieldValidator validator, void *user_data);
@@ -920,9 +920,9 @@
* Returns whether or not field has validator set.
+ * @param field The field. - * Returns: TRUE if the field has validator, or FALSE.
+ * @return TRUE if the field has validator, or FALSE. gboolean purple_request_field_is_validatable(PurpleRequestField *field);
@@ -935,19 +935,19 @@
* Note: empty, not required fields are valid.
- * @errmsg: If non-NULL, the memory area, where the pointer to validation
+ * @param field The field. + * @param errmsg If non-NULL, the memory area, where the pointer to validation * failure message will be set.
- * Returns: TRUE, if the field is valid, FALSE otherwise.
+ * @return TRUE, if the field is valid, FALSE otherwise. gboolean purple_request_field_is_valid(PurpleRequestField *field, gchar **errmsg);
- * @sensitive: TRUE if the field should be sensitive for user input.
+ * @param field The field. + * @param sensitive TRUE if the field should be sensitive for user input. void purple_request_field_set_sensitive(PurpleRequestField *field,
@@ -955,17 +955,17 @@
* Checks, if field is editable.
+ * @param field The field. - * Returns: TRUE, if the field is sensitive for user input.
+ * @return TRUE, if the field is sensitive for user input. gboolean purple_request_field_is_sensitive(PurpleRequestField *field);
* Sets the callback, used to determine if the field should be editable.
+ * @param field The field. + * @param cb The callback. void purple_request_field_set_sensitivity_cb(PurpleRequestField *field,
PurpleRequestFieldSensitivityCb cb);
@@ -973,19 +973,19 @@
* Returns the ui_data for a field.
+ * @param field The field. - * Returns: The UI data.
gpointer purple_request_field_get_ui_data(const PurpleRequestField *field);
* Sets the ui_data for a field.
- * @ui_data: The UI data.
+ * @param field The field. + * @param ui_data The UI data. - * Returns: The UI data.
void purple_request_field_set_ui_data(PurpleRequestField *field,
@@ -1000,12 +1000,12 @@
* Creates a string request field.
- * @text: The text label of the field.
- * @default_value: The optional default value.
- * @multiline: Whether or not this should be a multiline string.
+ * @param id The field ID. + * @param text The text label of the field. + * @param default_value The optional default value. + * @param multiline Whether or not this should be a multiline string. - * Returns: The new field.
+ * @return The new field. PurpleRequestField *purple_request_field_string_new(const char *id,
@@ -1015,8 +1015,8 @@
* Sets the default value in a string field.
- * @default_value: The default value.
+ * @param field The field. + * @param default_value The default value. void purple_request_field_string_set_default_value(PurpleRequestField *field,
const char *default_value);
@@ -1024,8 +1024,8 @@
* Sets the value in a string field.
+ * @param field The field. + * @param value The value. void purple_request_field_string_set_value(PurpleRequestField *field,
@@ -1034,8 +1034,8 @@
* Sets whether or not a string field is masked
* (commonly used for password fields).
- * @masked: The masked value.
+ * @param field The field. + * @param masked The masked value. void purple_request_field_string_set_masked(PurpleRequestField *field,
@@ -1043,9 +1043,9 @@
* Returns the default value in a string field.
+ * @param field The field. - * Returns: The default value.
+ * @return The default value. const char *purple_request_field_string_get_default_value(
const PurpleRequestField *field);
@@ -1053,27 +1053,27 @@
* Returns the user-entered value in a string field.
+ * @param field The field.
const char *purple_request_field_string_get_value(const PurpleRequestField *field);
* Returns whether or not a string field is multi-line.
+ * @param field The field. - * Returns: %TRUE if the field is mulit-line, or %FALSE otherwise.
+ * @return @c TRUE if the field is mulit-line, or @c FALSE otherwise. gboolean purple_request_field_string_is_multiline(const PurpleRequestField *field);
* Returns whether or not a string field is masked.
+ * @param field The field. - * Returns: %TRUE if the field is masked, or %FALSE otherwise.
+ * @return @c TRUE if the field is masked, or @c FALSE otherwise. gboolean purple_request_field_string_is_masked(const PurpleRequestField *field);
@@ -1087,13 +1087,13 @@
* Creates an integer field.
- * @text: The text label of the field.
- * @default_value: The default value.
- * @lower_bound: The lower bound.
- * @upper_bound: The upper bound.
+ * @param id The field ID. + * @param text The text label of the field. + * @param default_value The default value. + * @param lower_bound The lower bound. + * @param upper_bound The upper bound. - * Returns: The new field.
+ * @return The new field. PurpleRequestField *purple_request_field_int_new(const char *id,
const char *text, int default_value, int lower_bound, int upper_bound);
@@ -1101,8 +1101,8 @@
* Sets the default value in an integer field.
- * @default_value: The default value.
+ * @param field The field. + * @param default_value The default value. void purple_request_field_int_set_default_value(PurpleRequestField *field,
@@ -1110,60 +1110,60 @@
* Sets the lower bound in an integer field.
- * @lower_bound: The lower bound.
+ * @param field The field. + * @param lower_bound The lower bound. void purple_request_field_int_set_lower_bound(PurpleRequestField *field, int lower_bound);
* Sets the upper bound in an integer field.
- * @upper_bound: The upper bound.
+ * @param field The field. + * @param upper_bound The upper bound. void purple_request_field_int_set_upper_bound(PurpleRequestField *field, int lower_bound);
* Sets the value in an integer field.
+ * @param field The field. + * @param value The value. void purple_request_field_int_set_value(PurpleRequestField *field, int value);
* Returns the default value in an integer field.
+ * @param field The field. - * Returns: The default value.
+ * @return The default value. int purple_request_field_int_get_default_value(const PurpleRequestField *field);
* Returns the lower bound in an integer field.
+ * @param field The field. - * Returns: The lower bound.
+ * @return The lower bound. int purple_request_field_int_get_lower_bound(const PurpleRequestField *field);
* Returns the upper bound in an integer field.
+ * @param field The field. - * Returns: The upper bound.
+ * @return The upper bound. int purple_request_field_int_get_upper_bound(const PurpleRequestField *field);
* Returns the user-entered value in an integer field.
+ * @param field The field.
int purple_request_field_int_get_value(const PurpleRequestField *field);
@@ -1179,11 +1179,11 @@
* This is often represented as a checkbox.
- * @text: The text label of the field.
- * @default_value: The default value.
+ * @param id The field ID. + * @param text The text label of the field. + * @param default_value The default value. - * Returns: The new field.
+ * @return The new field. PurpleRequestField *purple_request_field_bool_new(const char *id,
@@ -1192,8 +1192,8 @@
* Sets the default value in an boolean field.
- * @default_value: The default value.
+ * @param field The field. + * @param default_value The default value. void purple_request_field_bool_set_default_value(PurpleRequestField *field,
@@ -1201,8 +1201,8 @@
* Sets the value in an boolean field.
+ * @param field The field. + * @param value The value. void purple_request_field_bool_set_value(PurpleRequestField *field,
@@ -1210,9 +1210,9 @@
* Returns the default value in an boolean field.
+ * @param field The field. - * Returns: The default value.
+ * @return The default value. gboolean purple_request_field_bool_get_default_value(
const PurpleRequestField *field);
@@ -1220,9 +1220,9 @@
* Returns the user-entered value in an boolean field.
+ * @param field The field.
gboolean purple_request_field_bool_get_value(const PurpleRequestField *field);
@@ -1238,11 +1238,11 @@
* This is often represented as a group of radio buttons.
- * @text: The optional label of the field.
- * @default_value: The default choice.
+ * @param id The field ID. + * @param text The optional label of the field. + * @param default_value The default choice. - * Returns: The new field.
+ * @return The new field. purple_request_field_choice_new(const char *id, const char *text,
@@ -1251,9 +1251,9 @@
* Adds a choice to a multiple choice field.
- * @field: The choice field.
- * @label: The choice label.
- * @data: The choice value.
+ * @param field The choice field. + * @param label The choice label. + * @param data The choice value. purple_request_field_choice_add(PurpleRequestField *field, const char *label,
@@ -1262,8 +1262,8 @@
* Sets the default value in an choice field.
- * @default_value: The default value.
+ * @param field The field. + * @param default_value The default value. purple_request_field_choice_set_default_value(PurpleRequestField *field,
@@ -1272,8 +1272,8 @@
* Sets the value in an choice field.
+ * @param field The field. + * @param value The value. purple_request_field_choice_set_value(PurpleRequestField *field,
@@ -1282,9 +1282,9 @@
* Returns the default value in an choice field.
+ * @param field The field. - * Returns: The default value.
+ * @return The default value. purple_request_field_choice_get_default_value(const PurpleRequestField *field);
@@ -1292,9 +1292,9 @@
* Returns the user-entered value in an choice field.
+ * @param field The field.
purple_request_field_choice_get_value(const PurpleRequestField *field);
@@ -1302,9 +1302,9 @@
* Returns a list of elements in a choice field.
+ * @param field The field. - * Returns: (transfer none): The list of pairs <label, value>.
+ * @constreturn The list of pairs <label, value>. purple_request_field_choice_get_elements(const PurpleRequestField *field);
@@ -1312,8 +1312,8 @@
* Sets the destructor for field values.
- * @destroy: The destroy function.
+ * @param field The field. + * @param destroy The destroy function. purple_request_field_choice_set_data_destructor(PurpleRequestField *field,
@@ -1329,18 +1329,18 @@
* Creates a multiple list item field.
- * @text: The optional label of the field.
+ * @param id The field ID. + * @param text The optional label of the field. - * Returns: The new field.
+ * @return The new field. PurpleRequestField *purple_request_field_list_new(const char *id, const char *text);
* Sets whether or not a list field allows multiple selection.
- * @field: The list field.
- * @multi_select: TRUE if multiple selection is enabled,
+ * @param field The list field. + * @param multi_select TRUE if multiple selection is enabled, void purple_request_field_list_set_multi_select(PurpleRequestField *field,
@@ -1349,9 +1349,9 @@
* Returns whether or not a list field allows multiple selection.
- * @field: The list field.
+ * @param field The list field. - * Returns: TRUE if multiple selection is enabled, or FALSE otherwise.
+ * @return TRUE if multiple selection is enabled, or FALSE otherwise. gboolean purple_request_field_list_get_multi_select(
const PurpleRequestField *field);
@@ -1359,10 +1359,10 @@
* Returns the data for a particular item.
- * @field: The list field.
- * @text: The item text.
+ * @param field The list field. + * @param text The item text. - * Returns: The data associated with the item.
+ * @return The data associated with the item. void *purple_request_field_list_get_data(const PurpleRequestField *field,
@@ -1370,10 +1370,10 @@
* Adds an item to a list field.
- * @field: The list field.
- * @item: The list item.
- * @icon_path: The path to icon file, or %NULL for no icon.
- * @data: The associated data.
+ * @param field The list field. + * @param item The list item. + * @param icon_path The path to icon file, or @c NULL for no icon. + * @param data The associated data. void purple_request_field_list_add_icon(PurpleRequestField *field,
const char *item, const char* icon_path, void* data);
@@ -1381,8 +1381,8 @@
* Adds a selected item to the list field.
- * @item: The item to add.
+ * @param field The field. + * @param item The item to add. void purple_request_field_list_add_selected(PurpleRequestField *field,
@@ -1390,15 +1390,15 @@
* Clears the list of selected items in a list field.
+ * @param field The field. void purple_request_field_list_clear_selected(PurpleRequestField *field);
* Sets a list of selected items in a list field.
- * @items: The list of selected items, which is not modified or freed.
+ * @param field The field. + * @param items The list of selected items, which is not modified or freed. void purple_request_field_list_set_selected(PurpleRequestField *field,
@@ -1406,10 +1406,10 @@
* Returns whether or not a particular item is selected in a list field.
+ * @param field The field. + * @param item The item. - * Returns: TRUE if the item is selected. FALSE otherwise.
+ * @return TRUE if the item is selected. FALSE otherwise. gboolean purple_request_field_list_is_selected(const PurpleRequestField *field,
@@ -1420,9 +1420,9 @@
* To retrieve the data for each item, use
* purple_request_field_list_get_data().
+ * @param field The field. - * Returns: (transfer none): The list of selected items.
+ * @constreturn The list of selected items. GList *purple_request_field_list_get_selected(
const PurpleRequestField *field);
@@ -1430,9 +1430,9 @@
* Returns a list of items in a list field.
+ * @param field The field. - * Returns: (transfer none): The list of items.
+ * @constreturn The list of items. GList *purple_request_field_list_get_items(const PurpleRequestField *field);
@@ -1441,9 +1441,9 @@
* The icons will correspond with the items, in order.
+ * @param field The field. - * Returns: (transfer none): The list of icons or %NULL (i.e. the empty GList) if no
+ * @constreturn The list of icons or @c NULL (i.e. the empty GList) if no GList *purple_request_field_list_get_icons(const PurpleRequestField *field);
@@ -1458,10 +1458,10 @@
- * @text: The label of the field.
+ * @param id The field ID. + * @param text The label of the field. - * Returns: The new field.
+ * @return The new field. PurpleRequestField *purple_request_field_label_new(const char *id,
@@ -1476,12 +1476,12 @@
* Creates an image field.
- * @text: The label of the field.
- * @buf: The image data.
- * @size: The size of the data in @a buffer.
+ * @param id The field ID. + * @param text The label of the field. + * @param buf The image data. + * @param size The size of the data in @a buffer. - * Returns: The new field.
+ * @return The new field. PurpleRequestField *purple_request_field_image_new(const char *id, const char *text,
const char *buf, gsize size);
@@ -1489,7 +1489,7 @@
* Sets the scale factors of an image field.
- * @field: The image field.
+ * @param field The image field. * @param x The x scale factor.
* @param y The y scale factor.
@@ -1498,36 +1498,36 @@
* Returns pointer to the image.
- * @field: The image field.
+ * @param field The image field. - * Returns: Pointer to the image.
+ * @return Pointer to the image. const char *purple_request_field_image_get_buffer(PurpleRequestField *field);
* Returns size (in bytes) of the image.
- * @field: The image field.
+ * @param field The image field. - * Returns: Size of the image.
+ * @return Size of the image. gsize purple_request_field_image_get_size(PurpleRequestField *field);
* Returns X scale coefficient of the image.
- * @field: The image field.
+ * @param field The image field. - * Returns: X scale coefficient of the image.
+ * @return X scale coefficient of the image. unsigned int purple_request_field_image_get_scale_x(PurpleRequestField *field);
* Returns Y scale coefficient of the image.
- * @field: The image field.
+ * @param field The image field. - * Returns: Y scale coefficient of the image.
+ * @return Y scale coefficient of the image. unsigned int purple_request_field_image_get_scale_y(PurpleRequestField *field);
@@ -1543,11 +1543,11 @@
* By default, this field will not show offline accounts.
- * @text: The text label of the field.
- * @account: The optional default account.
+ * @param id The field ID. + * @param text The text label of the field. + * @param account The optional default account. - * Returns: The new field.
+ * @return The new field. PurpleRequestField *purple_request_field_account_new(const char *id,
@@ -1556,8 +1556,8 @@
* Sets the default account on an account field.
- * @field: The account field.
- * @default_value: The default account.
+ * @param field The account field. + * @param default_value The default account. void purple_request_field_account_set_default_value(PurpleRequestField *field,
PurpleAccount *default_value);
@@ -1565,8 +1565,8 @@
* Sets the account in an account field.
- * @field: The account field.
+ * @param field The account field. + * @param value The account. void purple_request_field_account_set_value(PurpleRequestField *field,
@@ -1577,8 +1577,8 @@
* If TRUE, all accounts, online or offline, will be shown. If FALSE,
* only online accounts will be shown.
- * @field: The account field.
- * @show_all: Whether or not to show all accounts.
+ * @param field The account field. + * @param show_all Whether or not to show all accounts. void purple_request_field_account_set_show_all(PurpleRequestField *field,
@@ -1589,8 +1589,8 @@
* This function will determine which accounts get displayed and which
- * @field: The account field.
- * @filter_func: The account filter function.
+ * @param field The account field. + * @param filter_func The account filter function. void purple_request_field_account_set_filter(PurpleRequestField *field,
PurpleFilterAccountFunc filter_func);
@@ -1598,9 +1598,9 @@
* Returns the default account in an account field.
+ * @param field The field. - * Returns: The default account.
+ * @return The default account. PurpleAccount *purple_request_field_account_get_default_value(
const PurpleRequestField *field);
@@ -1608,9 +1608,9 @@
* Returns the user-entered account in an account field.
+ * @param field The field. - * Returns: The user-entered account.
+ * @return The user-entered account. PurpleAccount *purple_request_field_account_get_value(
const PurpleRequestField *field);
@@ -1621,8 +1621,8 @@
* If TRUE, all accounts, online or offline, will be shown. If FALSE,
* only online accounts will be shown.
- * @field: The account field.
- * Returns: Whether or not to show all accounts.
+ * @param field The account field. + * @return Whether or not to show all accounts. gboolean purple_request_field_account_get_show_all(
const PurpleRequestField *field);
@@ -1633,9 +1633,9 @@
* This function will determine which accounts get displayed and which
- * @field: The account field.
+ * @param field The account field. - * Returns: The account filter function.
+ * @return The account filter function. PurpleFilterAccountFunc purple_request_field_account_get_filter(
const PurpleRequestField *field);
@@ -1650,11 +1650,11 @@
* Creates a certificate field.
- * @text: The label of the field.
- * @cert: The certificate of the field.
+ * @param id The field ID. + * @param text The label of the field. + * @param cert The certificate of the field. - * Returns: The new field.
+ * @return The new field. PurpleRequestField *purple_request_field_certificate_new(const char *id,
@@ -1663,9 +1663,9 @@
* Returns the certificate in a certificate field.
+ * @param field The field. - * Returns: The certificate.
+ * @return The certificate. PurpleCertificate *purple_request_field_certificate_get_value(
const PurpleRequestField *field);
@@ -1680,11 +1680,11 @@
* Creates a datasheet item field.
- * @text: The label of the field, may be %NULL.
- * @sheet: The datasheet.
+ * @param id The field ID. + * @param text The label of the field, may be @c NULL. + * @param sheet The datasheet. - * Returns: The new field.
+ * @return The new field. PurpleRequestField *purple_request_field_datasheet_new(const char *id,
const gchar *text, PurpleRequestDatasheet *sheet);
@@ -1692,9 +1692,9 @@
* Returns a datasheet for a field.
+ * @param field The field. - * Returns: (transfer none): The datasheet object.
+ * @constreturn The datasheet object. PurpleRequestDatasheet *purple_request_field_datasheet_get_sheet(
PurpleRequestField *field);
@@ -1711,11 +1711,11 @@
* @see purple_request_field_set_validator
- * @errmsg: (Optional) destination for error message.
+ * @param field The field. + * @param errmsg (Optional) destination for error message. + * @param user_data Ignored. - * Returns: TRUE, if field contains valid email address.
+ * @return TRUE, if field contains valid email address. gboolean purple_request_field_email_validator(PurpleRequestField *field,
gchar **errmsg, void *user_data);
@@ -1725,11 +1725,11 @@
* @see purple_request_field_set_validator
- * @errmsg: (Optional) destination for error message.
- * @user_data: (Optional) allowed character list (NULL-terminated string).
+ * @param field The field. + * @param errmsg (Optional) destination for error message. + * @param user_data (Optional) allowed character list (NULL-terminated string). - * Returns: TRUE, if field contains only alphanumeric characters.
+ * @return TRUE, if field contains only alphanumeric characters. gboolean purple_request_field_alphanumeric_validator(PurpleRequestField *field,
gchar **errmsg, void *allowed_characters);
@@ -1744,7 +1744,7 @@
* Prompts the user for text input.
- * @handle: The plugin or connection handle. For some
+ * @param handle The plugin or connection handle. For some * things this is <em>extremely</em> important. The
* handle is used to programmatically close the request
* dialog when it is no longer needed. For protocols this
@@ -1757,31 +1757,31 @@
* <em>not</em> closed it is <strong>very</strong>
* likely to cause a crash whenever the callback
* handler functions are triggered.
- * @title: The title of the message, or %NULL if it should have
+ * @param title The title of the message, or @c NULL if it should have - * @primary: The main point of the message, or %NULL if you're
+ * @param primary The main point of the message, or @c NULL if you're - * @secondary: Secondary information, or %NULL if there is none.
- * @default_value: The default value.
- * @multiline: %TRUE if the inputted text can span multiple lines.
- * @masked: %TRUE if the inputted text should be masked in some
+ * @param secondary Secondary information, or @c NULL if there is none. + * @param default_value The default value. + * @param multiline @c TRUE if the inputted text can span multiple lines. + * @param masked @c TRUE if the inputted text should be masked in some * way (such as by displaying characters as stars). This
* might be because the input is some kind of password.
- * @hint: Optionally suggest how the input box should appear.
+ * @param hint Optionally suggest how the input box should appear. * Use "html", for example, to allow the user to enter
- * @ok_text: The text for the @c OK button, which may not be %NULL.
- * @ok_cb: The callback for the @c OK button, which may not be @c
+ * @param ok_text The text for the @c OK button, which may not be @c NULL. + * @param ok_cb The callback for the @c OK button, which may not be @c - * @cancel_text: The text for the @c Cancel button, which may not be @c
+ * @param cancel_text The text for the @c Cancel button, which may not be @c - * @cancel_cb: The callback for the @c Cancel button, which may be
- * @cpar: The #PurpleRequestCommonParameters object, which gets
+ * @param cancel_cb The callback for the @c Cancel button, which may be + * @param cpar The #PurpleRequestCommonParameters object, which gets * unref'ed after this call.
- * @user_data: The data to pass to the callback.
+ * @param user_data The data to pass to the callback. - * Returns: A UI-specific handle.
+ * @return A UI-specific handle. void *purple_request_input(void *handle, const char *title, const char *primary,
const char *secondary, const char *default_value, gboolean multiline,
@@ -1794,31 +1794,31 @@
* Prompts the user for multiple-choice input.
- * @handle: The plugin or connection handle. For some things this
+ * @param handle The plugin or connection handle. For some things this * is <em>extremely</em> important. See the comments on
* purple_request_input().
- * @title: The title of the message, or %NULL if it should have
+ * @param title The title of the message, or @c NULL if it should have - * @primary: The main point of the message, or %NULL if you're
+ * @param primary The main point of the message, or @c NULL if you're - * @secondary: Secondary information, or %NULL if there is none.
- * @default_value: The default choice; this should be one of the values
+ * @param secondary Secondary information, or @c NULL if there is none. + * @param default_value The default choice; this should be one of the values - * @ok_text: The text for the @c OK button, which may not be %NULL.
- * @ok_cb: The callback for the @c OK button, which may not be @c
+ * @param ok_text The text for the @c OK button, which may not be @c NULL. + * @param ok_cb The callback for the @c OK button, which may not be @c - * @cancel_text: The text for the @c Cancel button, which may not be @c
+ * @param cancel_text The text for the @c Cancel button, which may not be @c - * @cancel_cb: The callback for the @c Cancel button, or %NULL to
+ * @param cancel_cb The callback for the @c Cancel button, or @c NULL to - * @cpar: The #PurpleRequestCommonParameters object, which gets
+ * @param cpar The #PurpleRequestCommonParameters object, which gets * unref'ed after this call.
- * @user_data: The data to pass to the callback.
- * @...: The choices, which should be pairs of <tt>char *</tt>
+ * @param user_data The data to pass to the callback. + * @param ... The choices, which should be pairs of <tt>char *</tt> * descriptions and <tt>int</tt> values, terminated with a
- * Returns: A UI-specific handle.
+ * @return A UI-specific handle. void *purple_request_choice(void *handle, const char *title, const char *primary,
const char *secondary, gpointer default_value,
@@ -1842,23 +1842,23 @@
* This is often represented as a dialog with a button for each action.
- * @handle: The plugin or connection handle. For some things this
+ * @param handle The plugin or connection handle. For some things this * is <em>extremely</em> important. See the comments on
* purple_request_input().
- * @title: The title of the message, or %NULL if it should have
+ * @param title The title of the message, or @c NULL if it should have - * @primary: The main point of the message, or %NULL if you're
+ * @param primary The main point of the message, or @c NULL if you're - * @secondary: Secondary information, or %NULL if there is none.
- * @default_action: The default action, zero-indexed; if the third action
+ * @param secondary Secondary information, or @c NULL if there is none. + * @param default_action The default action, zero-indexed; if the third action * supplied should be the default, supply <tt>2</tt>.
* The should be the action that users are most likely
- * @cpar: The #PurpleRequestCommonParameters object, which gets
+ * @param cpar The #PurpleRequestCommonParameters object, which gets * unref'ed after this call.
- * @user_data: The data to pass to the callback.
- * @action_count: The number of actions.
- * @...: A list of actions. These are pairs of
+ * @param user_data The data to pass to the callback. + * @param action_count The number of actions. + * @param ... A list of actions. These are pairs of * arguments. The first of each pair is the
* <tt>char *</tt> label that appears on the button. It
* should have an underscore before the letter you want
@@ -1866,7 +1866,7 @@
* second of each pair is the #PurpleRequestActionCb
* function to use when the button is clicked.
- * Returns: A UI-specific handle.
+ * @return A UI-specific handle. purple_request_action(void *handle, const char *title, const char *primary,
@@ -1886,23 +1886,23 @@
* Displays a "please wait" dialog.
- * @handle: The plugin or connection handle. For some things this
+ * @param handle The plugin or connection handle. For some things this * is <em>extremely</em> important. See the comments on
* purple_request_input().
- * @title: The title of the message, or %NULL if it should have
+ * @param title The title of the message, or @c NULL if it should have - * @primary: The main point of the message, or %NULL if you're
+ * @param primary The main point of the message, or @c NULL if you're - * @secondary: Secondary information, or %NULL if there is none.
- * @with_progress: %TRUE, if we want to display progress bar, %FALSE
+ * @param secondary Secondary information, or @c NULL if there is none. + * @param with_progress @c TRUE, if we want to display progress bar, @c FALSE - * @cancel_cb: The callback for the @c Cancel button, which may be
- * @cpar: The #PurpleRequestCommonParameters object, which gets
+ * @param cancel_cb The callback for the @c Cancel button, which may be + * @param cpar The #PurpleRequestCommonParameters object, which gets * unref'ed after this call.
- * @user_data: The data to pass to the callback.
+ * @param user_data The data to pass to the callback. - * Returns: A UI-specific handle.
+ * @return A UI-specific handle. purple_request_wait(void *handle, const char *title, const char *primary,
@@ -1914,7 +1914,7 @@
* Notifies the "please wait" dialog that some progress has been made, but you
- * @ui_handle: The request UI handle.
+ * @param ui_handle The request UI handle. purple_request_wait_pulse(void *ui_handle);
@@ -1922,8 +1922,8 @@
* Notifies the "please wait" dialog about progress has been made.
- * @ui_handle: The request UI handle.
- * @fraction: The part of task that is done (between 0.0 and 1.0,
+ * @param ui_handle The request UI handle. + * @param fraction The part of task that is done (between 0.0 and 1.0, @@ -1932,27 +1932,27 @@
* Displays groups of fields for the user to fill in.
- * @handle: The plugin or connection handle. For some things this
+ * @param handle The plugin or connection handle. For some things this * is <em>extremely</em> important. See the comments on
* purple_request_input().
- * @title: The title of the message, or %NULL if it should have
+ * @param title The title of the message, or @c NULL if it should have - * @primary: The main point of the message, or %NULL if you're
+ * @param primary The main point of the message, or @c NULL if you're - * @secondary: Secondary information, or %NULL if there is none.
- * @fields: The list of fields.
- * @ok_text: The text for the @c OK button, which may not be %NULL.
- * @ok_cb: The callback for the @c OK button, which may not be @c
+ * @param secondary Secondary information, or @c NULL if there is none. + * @param fields The list of fields. + * @param ok_text The text for the @c OK button, which may not be @c NULL. + * @param ok_cb The callback for the @c OK button, which may not be @c - * @cancel_text: The text for the @c Cancel button, which may not be @c
+ * @param cancel_text The text for the @c Cancel button, which may not be @c - * @cancel_cb: The callback for the @c Cancel button, which may be
- * @cpar: The #PurpleRequestCommonParameters object, which gets
+ * @param cancel_cb The callback for the @c Cancel button, which may be + * @param cpar The #PurpleRequestCommonParameters object, which gets * unref'ed after this call.
- * @user_data: The data to pass to the callback.
+ * @param user_data The data to pass to the callback. - * Returns: A UI-specific handle.
+ * @return A UI-specific handle. purple_request_fields(void *handle, const char *title, const char *primary,
@@ -1965,11 +1965,11 @@
* Checks, if passed UI handle is valid.
- * @ui_handle: The UI handle.
- * @type: The pointer to variable, where request type may be stored
+ * @param ui_handle The UI handle. + * @param type The pointer to variable, where request type may be stored - * Returns: TRUE, if handle is valid, FALSE otherwise.
+ * @return TRUE, if handle is valid, FALSE otherwise. purple_request_is_valid_ui_handle(void *ui_handle, PurpleRequestType *type);
@@ -1977,9 +1977,9 @@
* Adds a function called when notification dialog is closed.
- * @ui_handle: The UI handle.
- * @notify: The function to be called.
- * @notify_data: The data to be passed to the callback function.
+ * @param ui_handle The UI handle. + * @param notify The function to be called. + * @param notify_data The data to be passed to the callback function. purple_request_add_close_notify(void *ui_handle, GDestroyNotify notify,
@@ -1988,15 +1988,15 @@
- * @type: The request type.
- * @uihandle: The request UI handle.
+ * @param type The request type. + * @param uihandle The request UI handle. void purple_request_close(PurpleRequestType type, void *uihandle);
* Closes all requests registered with the specified handle.
- * @handle: The handle, as supplied as the @a handle parameter to one of the
+ * @param handle The handle, as supplied as the @a handle parameter to one of the * <tt>purple_request_*</tt> functions.
* @see purple_request_input().
@@ -2034,21 +2034,21 @@
* Displays a file selector request dialog. Returns the selected filename to
* the callback. Can be used for either opening a file or saving a file.
- * @handle: The plugin or connection handle. For some things this
+ * @param handle The plugin or connection handle. For some things this * is <em>extremely</em> important. See the comments on
* purple_request_input().
- * @title: The title of the message, or %NULL if it should have
+ * @param title The title of the message, or @c NULL if it should have - * @filename: The default filename (may be %NULL)
- * @savedialog: True if this dialog is being used to save a file.
+ * @param filename The default filename (may be @c NULL) + * @param savedialog True if this dialog is being used to save a file. * False if it is being used to open a file.
- * @ok_cb: The callback for the @c OK button.
- * @cancel_cb: The callback for the @c Cancel button, which may be %NULL.
- * @cpar: The #PurpleRequestCommonParameters object, which gets
+ * @param ok_cb The callback for the @c OK button. + * @param cancel_cb The callback for the @c Cancel button, which may be @c NULL. + * @param cpar The #PurpleRequestCommonParameters object, which gets * unref'ed after this call.
- * @user_data: The data to pass to the callback.
+ * @param user_data The data to pass to the callback. - * Returns: A UI-specific handle.
+ * @return A UI-specific handle. purple_request_file(void *handle, const char *title, const char *filename,
@@ -2059,19 +2059,19 @@
* Displays a folder select dialog. Returns the selected filename to
- * @handle: The plugin or connection handle. For some things this
+ * @param handle The plugin or connection handle. For some things this * is <em>extremely</em> important. See the comments on
* purple_request_input().
- * @title: The title of the message, or %NULL if it should have
+ * @param title The title of the message, or @c NULL if it should have - * @dirname: The default directory name (may be %NULL)
- * @ok_cb: The callback for the @c OK button.
- * @cancel_cb: The callback for the @c Cancel button, which may be %NULL.
- * @cpar: The #PurpleRequestCommonParameters object, which gets
+ * @param dirname The default directory name (may be @c NULL) + * @param ok_cb The callback for the @c OK button. + * @param cancel_cb The callback for the @c Cancel button, which may be @c NULL. + * @param cpar The #PurpleRequestCommonParameters object, which gets * unref'ed after this call.
- * @user_data: The data to pass to the callback.
+ * @param user_data The data to pass to the callback. - * Returns: A UI-specific handle.
+ * @return A UI-specific handle. purple_request_folder(void *handle, const char *title, const char *dirname,
@@ -2083,25 +2083,25 @@
* This is often represented as a dialog with a button for each action.
- * @handle: The plugin or connection handle. For some things this
+ * @param handle The plugin or connection handle. For some things this * is <em>extremely</em> important. See the comments on
* purple_request_input().
- * @title: The title of the message, or %NULL if it should have
+ * @param title The title of the message, or @c NULL if it should have - * @primary: The main point of the message, or %NULL if you're
+ * @param primary The main point of the message, or @c NULL if you're - * @secondary: Secondary information, or %NULL if there is none.
- * @cert: The #PurpleCertificate associated with this request.
- * @ok_text: The text for the @c OK button, which may not be %NULL.
- * @ok_cb: The callback for the @c OK button, which may not be
- * @cancel_text: The text for the @c Cancel button, which may not be
- * @cancel_cb: The callback for the @c Cancel button, which may be
- * @user_data: The data to pass to the callback.
+ * @param secondary Secondary information, or @c NULL if there is none. + * @param cert The #PurpleCertificate associated with this request. + * @param ok_text The text for the @c OK button, which may not be @c NULL. + * @param ok_cb The callback for the @c OK button, which may not be + * @param cancel_text The text for the @c Cancel button, which may not be + * @param cancel_cb The callback for the @c Cancel button, which may be + * @param user_data The data to pass to the callback. - * Returns: A UI-specific handle.
+ * @return A UI-specific handle. void *purple_request_certificate(void *handle, const char *title,
const char *primary, const char *secondary, PurpleCertificate *cert,
@@ -2120,7 +2120,7 @@
* Sets the UI operations structure to be used when displaying a
- * @ops: The UI operations structure.
+ * @param ops The UI operations structure. void purple_request_set_ui_ops(PurpleRequestUiOps *ops);
@@ -2128,7 +2128,7 @@
* Returns the UI operations structure to be used when displaying a
- * Returns: The UI operations structure.
+ * @return The UI operations structure. PurpleRequestUiOps *purple_request_get_ui_ops(void);
--- a/libpurple/savedstatuses.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/savedstatuses.h Wed Jan 29 10:49:02 2014 +0530
@@ -79,12 +79,12 @@
* Create a new saved status. This will add the saved status to the
* list of saved statuses and writes the revised list to status.xml.
- * @title: The title of the saved status. This must be
+ * @param title The title of the saved status. This must be * unique. Or, if you want to create a transient
* saved status, then pass in NULL.
- * @type: The type of saved status.
+ * @param type The type of saved status. - * Returns: The newly created saved status, or NULL if the title you
+ * @return The newly created saved status, or NULL if the title you * used was already taken.
PurpleSavedStatus *purple_savedstatus_new(const char *title,
@@ -93,8 +93,8 @@
* Set the title for the given saved status.
- * @status: The saved status.
- * @title: The title of the saved status.
+ * @param status The saved status. + * @param title The title of the saved status. void purple_savedstatus_set_title(PurpleSavedStatus *status,
@@ -102,8 +102,8 @@
* Set the type for the given saved status.
- * @status: The saved status.
- * @type: The type of saved status.
+ * @param status The saved status. + * @param type The type of saved status. void purple_savedstatus_set_type(PurpleSavedStatus *status,
PurpleStatusPrimitive type);
@@ -111,8 +111,8 @@
* Set the message for the given saved status.
- * @status: The saved status.
- * @message: The message, or NULL if you want to unset the
+ * @param status The saved status. + * @param message The message, or NULL if you want to unset the * message for this status.
void purple_savedstatus_set_message(PurpleSavedStatus *status,
@@ -121,11 +121,11 @@
* Set a substatus for an account in a saved status.
- * @status: The saved status.
- * @account: The account.
- * @type: The status type for the account in the staved
+ * @param status The saved status. + * @param account The account. + * @param type The status type for the account in the staved - * @message: The message for the account in the substatus.
+ * @param message The message for the account in the substatus. void purple_savedstatus_set_substatus(PurpleSavedStatus *status,
const PurpleAccount *account,
@@ -138,8 +138,8 @@
* saved status is activated then this account will use the default
* status type and message.
- * @saved_status: The saved status.
- * @account: The account.
+ * @param saved_status The saved status. + * @param account The account. void purple_savedstatus_unset_substatus(PurpleSavedStatus *saved_status,
const PurpleAccount *account);
@@ -148,9 +148,9 @@
* Delete a saved status. This removes the saved status from the list
* of saved statuses, and writes the revised list to status.xml.
- * @title: The title of the saved status.
+ * @param title The title of the saved status. - * Returns: TRUE if the status was successfully deleted. FALSE if the
+ * @return TRUE if the status was successfully deleted. FALSE if the * status could not be deleted because no saved status exists
@@ -160,7 +160,7 @@
* Delete a saved status. This removes the saved status from the list
* of saved statuses, and writes the revised list to status.xml.
- * @saved_status: the status to delete, the pointer is invalid after
+ * @param saved_status the status to delete, the pointer is invalid after @@ -169,7 +169,7 @@
* Returns all saved statuses.
- * Returns: (transfer none): A list of saved statuses.
+ * @constreturn A list of saved statuses. GList *purple_savedstatuses_get_all(void);
@@ -179,10 +179,10 @@
* how many times it has been used. Transient statuses without
* messages are not included in the list.
- * @how_many: The maximum number of saved statuses
+ * @param how_many The maximum number of saved statuses * to return, or '0' to get all saved
* statuses sorted by popularity.
- * Returns: A linked list containing at most how_many
+ * @return 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).
@@ -194,7 +194,7 @@
* then this returns purple_savedstatus_get_idleaway(). Otherwise
* it returns purple_savedstatus_get_default().
- * Returns: A pointer to the in-use PurpleSavedStatus.
+ * @return A pointer to the in-use PurpleSavedStatus. * This function never returns NULL.
PurpleSavedStatus *purple_savedstatus_get_current(void);
@@ -203,7 +203,7 @@
* Returns the default saved status that is used when our
* accounts are not idle-away.
- * Returns: A pointer to the in-use PurpleSavedStatus.
+ * @return A pointer to the in-use PurpleSavedStatus. * This function never returns NULL.
PurpleSavedStatus *purple_savedstatus_get_default(void);
@@ -212,7 +212,7 @@
* Returns the saved status that is used when your
* accounts become idle-away.
- * Returns: A pointer to the idle-away PurpleSavedStatus.
+ * @return A pointer to the idle-away PurpleSavedStatus. * This function never returns NULL.
PurpleSavedStatus *purple_savedstatus_get_idleaway(void);
@@ -221,14 +221,14 @@
* Return TRUE if we are currently idle-away. Otherwise
- * Returns: TRUE if our accounts have been set to idle-away.
+ * @return TRUE if our accounts have been set to idle-away. gboolean purple_savedstatus_is_idleaway(void);
* Set whether accounts in Purple are idle-away or not.
- * @idleaway: TRUE if accounts should be switched to use the
+ * @param idleaway TRUE if accounts should be switched to use the * idle-away saved status. FALSE if they should
* be switched to use the default status.
@@ -237,7 +237,7 @@
* Returns the status to be used when purple is starting up
- * Returns: A pointer to the startup PurpleSavedStatus.
+ * @return A pointer to the startup PurpleSavedStatus. * This function never returns NULL.
PurpleSavedStatus *purple_savedstatus_get_startup(void);
@@ -245,31 +245,31 @@
* Finds a saved status with the specified title.
- * @title: The name of the saved status.
+ * @param title The name of the saved status. - * Returns: The saved status if found, or NULL.
+ * @return The saved status if found, or NULL. PurpleSavedStatus *purple_savedstatus_find(const char *title);
* Finds a saved status with the specified creation time.
- * @creation_time: The timestamp when the saved
+ * @param creation_time The timestamp when the saved - * Returns: The saved status if found, or NULL.
+ * @return The saved status if found, or NULL. PurpleSavedStatus *purple_savedstatus_find_by_creation_time(time_t creation_time);
* Finds a saved status with the specified primitive and message.
- * @type: The PurpleStatusPrimitive for the status you're trying
+ * @param type The PurpleStatusPrimitive for the status you're trying - * @message: The message for the status you're trying
+ * @param message The message for the status you're trying - * Returns: The saved status if found, or NULL.
+ * @return The saved status if found, or NULL. PurpleSavedStatus *purple_savedstatus_find_transient_by_type_and_message(PurpleStatusPrimitive type, const char *message);
@@ -286,18 +286,18 @@
* we need to save this status information is so we can
* restore it when Purple restarts.
- * @saved_status: The saved status.
+ * @param saved_status The saved status. - * Returns: TRUE if the saved status is transient.
+ * @return TRUE if the saved status is transient. gboolean purple_savedstatus_is_transient(const PurpleSavedStatus *saved_status);
* Return the name of a given saved status.
- * @saved_status: The saved status.
+ * @param saved_status The saved status. - * Returns: The title. This value may be a static buffer which may
+ * @return The title. This value may be a static buffer which may * be overwritten on subsequent calls to this function. If
* you need a reference to the title for prolonged use then
* you should make a copy of it.
@@ -307,18 +307,18 @@
* Return the type of a given saved status.
- * @saved_status: The saved status.
+ * @param saved_status The saved status.
PurpleStatusPrimitive purple_savedstatus_get_type(const PurpleSavedStatus *saved_status);
* Return the default message of a given saved status.
- * @saved_status: The saved status.
+ * @param saved_status The saved status. - * Returns: The message. This will return NULL if the saved
+ * @return The message. This will return NULL if the saved * status does not have a message. This will
* contain the normal markup that is created by
* Purple's IMHTML (basically HTML markup).
@@ -336,9 +336,9 @@
* However, this value is guaranteed to be a unique
* identifier for the given saved status.
- * @saved_status: The saved status.
+ * @param saved_status The saved status. - * Returns: The timestamp when this saved status was created.
+ * @return The timestamp when this saved status was created. time_t purple_savedstatus_get_creation_time(const PurpleSavedStatus *saved_status);
@@ -347,9 +347,9 @@
* or if it is a simple status (the same for all
- * @saved_status: The saved status.
+ * @param saved_status The saved status. - * Returns: TRUE if the saved_status has substatuses.
+ * @return TRUE if the saved_status has substatuses. gboolean purple_savedstatus_has_substatuses(const PurpleSavedStatus *saved_status);
@@ -357,10 +357,10 @@
* Get the substatus for an account in a saved status.
- * @saved_status: The saved status.
- * @account: The account.
+ * @param saved_status The saved status. + * @param account The account. - * Returns: The PurpleSavedStatusSub for the account, or NULL if
+ * @return The PurpleSavedStatusSub for the account, or NULL if * the given account does not have a substatus that
* differs from the default status of this PurpleSavedStatus.
@@ -371,18 +371,18 @@
* Get the status type of a given substatus.
- * @substatus: The substatus.
+ * @param substatus The substatus. - * Returns: The status type.
+ * @return The status type. const PurpleStatusType *purple_savedstatus_substatus_get_type(const PurpleSavedStatusSub *substatus);
* Get the message of a given substatus.
- * @substatus: The substatus.
+ * @param substatus The substatus. - * Returns: The message of the substatus, or NULL if this substatus does
+ * @return The message of the substatus, or NULL if this substatus does const char *purple_savedstatus_substatus_get_message(const PurpleSavedStatusSub *substatus);
@@ -392,7 +392,7 @@
* by the given saved_status. This function calls
* purple_savedstatus_activate_for_account() for all your accounts.
- * @saved_status: The status you want to set your accounts to.
+ * @param saved_status The status you want to set your accounts to. void purple_savedstatus_activate(PurpleSavedStatus *saved_status);
@@ -400,15 +400,15 @@
* Sets the statuses for a given account to those specified
* by the given saved_status.
- * @saved_status: The status you want to set your accounts to.
- * @account: The account whose statuses you want to change.
+ * @param saved_status The status you want to set your accounts to. + * @param account The account whose statuses you want to change. void purple_savedstatus_activate_for_account(const PurpleSavedStatus *saved_status, PurpleAccount *account);
* Get the handle for the status subsystem.
- * Returns: the handle to the status subsystem
+ * @return the handle to the status subsystem void *purple_savedstatuses_get_handle(void);
--- a/libpurple/status.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/status.h Wed Jan 29 10:49:02 2014 +0530
@@ -158,9 +158,9 @@
* Lookup the id of a primitive status type based on the type. This
* ID is a unique plain-text name of the status, without spaces.
- * @type: A primitive status type.
+ * @param type A primitive status type. - * Returns: The unique ID for this type.
+ * @return The unique ID for this type. const char *purple_primitive_get_id_from_type(PurpleStatusPrimitive type);
@@ -169,9 +169,9 @@
* name is the plain-English name of the status type. It is usually one
- * @type: A primitive status type.
+ * @param type A primitive status type. - * Returns: The name of this type, suitable for users to see.
+ * @return The name of this type, suitable for users to see. const char *purple_primitive_get_name_from_type(PurpleStatusPrimitive type);
@@ -179,9 +179,9 @@
* Lookup the value of a primitive status type based on the id. The
* ID is a unique plain-text name of the status, without spaces.
- * @id: The unique ID of a primitive status type.
+ * @param id The unique ID of a primitive status type. - * Returns: The PurpleStatusPrimitive value.
+ * @return The PurpleStatusPrimitive value. PurpleStatusPrimitive purple_primitive_get_type_from_id(const char *id);
@@ -200,18 +200,18 @@
* Creates a new status type.
- * @primitive: The primitive status type.
- * @id: The ID of the status type, or %NULL to use the id of
+ * @param primitive The primitive status type. + * @param id The ID of the status type, or @c NULL to use the id of * the primitive status type.
- * @name: The name presented to the user, or %NULL to use the
+ * @param name The name presented to the user, or @c NULL to use the * name of the primitive status type.
- * @saveable: TRUE if the information set for this status by the
+ * @param saveable TRUE if the information set for this status by the * user can be saved for future sessions.
- * @user_settable: TRUE if this is a status the user can manually set.
- * @independent: TRUE if this is an independent (non-exclusive)
+ * @param user_settable TRUE if this is a status the user can manually set. + * @param independent TRUE if this is an independent (non-exclusive) - * Returns: A new status type.
+ * @return A new status type. PurpleStatusType *purple_status_type_new_full(PurpleStatusPrimitive primitive,
const char *id, const char *name,
@@ -223,14 +223,14 @@
* Creates a new status type with some default values (
* saveable and not independent).
- * @primitive: The primitive status type.
- * @id: The ID of the status type, or %NULL to use the id of
+ * @param primitive The primitive status type. + * @param id The ID of the status type, or @c NULL to use the id of * the primitive status type.
- * @name: The name presented to the user, or %NULL to use the
+ * @param name The name presented to the user, or @c NULL to use the * name of the primitive status type.
- * @user_settable: TRUE if this is a status the user can manually set.
+ * @param user_settable TRUE if this is a status the user can manually set. - * Returns: A new status type.
+ * @return A new status type. PurpleStatusType *purple_status_type_new(PurpleStatusPrimitive primitive,
const char *id, const char *name,
@@ -239,22 +239,22 @@
* Creates a new status type with attributes.
- * @primitive: The primitive status type.
- * @id: The ID of the status type, or %NULL to use the id of
+ * @param primitive The primitive status type. + * @param id The ID of the status type, or @c NULL to use the id of * the primitive status type.
- * @name: The name presented to the user, or %NULL to use the
+ * @param name The name presented to the user, or @c NULL to use the * name of the primitive status type.
- * @saveable: TRUE if the information set for this status by the
+ * @param saveable TRUE if the information set for this status by the * user can be saved for future sessions.
- * @user_settable: TRUE if this is a status the user can manually set.
- * @independent: TRUE if this is an independent (non-exclusive)
+ * @param user_settable TRUE if this is a status the user can manually set. + * @param independent TRUE if this is an independent (non-exclusive) - * @attr_id: The ID of the first attribute.
- * @attr_name: The name of the first attribute.
- * @attr_value: The value type of the first attribute.
- * @...: Additional attribute information.
+ * @param attr_id The ID of the first attribute. + * @param attr_name The name of the first attribute. + * @param attr_value The value type of the first attribute. + * @param ... Additional attribute information. - * Returns: A new status type.
+ * @return A new status type. PurpleStatusType *purple_status_type_new_with_attrs(PurpleStatusPrimitive primitive,
@@ -269,16 +269,16 @@
* Destroys a status type.
- * @status_type: The status type to destroy.
+ * @param status_type The status type to destroy. void purple_status_type_destroy(PurpleStatusType *status_type);
* Returns the primitive type of a status type.
- * @status_type: The status type.
+ * @param status_type The status type. - * Returns: The primitive type of the status type.
+ * @return The primitive type of the status type. PurpleStatusPrimitive purple_status_type_get_primitive(
const PurpleStatusType *status_type);
@@ -286,27 +286,27 @@
* Returns the ID of a status type.
- * @status_type: The status type.
+ * @param status_type The status type. - * Returns: The ID of the status type.
+ * @return The ID of the status type. const char *purple_status_type_get_id(const PurpleStatusType *status_type);
* Returns the name of a status type.
- * @status_type: The status type.
+ * @param status_type The status type. - * Returns: The name of the status type.
+ * @return The name of the status type. const char *purple_status_type_get_name(const PurpleStatusType *status_type);
* Returns whether or not the status type is saveable.
- * @status_type: The status type.
+ * @param status_type The status type. - * Returns: TRUE if user-defined statuses based off this type are saveable.
+ * @return TRUE if user-defined statuses based off this type are saveable. gboolean purple_status_type_is_saveable(const PurpleStatusType *status_type);
@@ -315,9 +315,9 @@
* Returns whether or not the status type can be set or modified by the
- * @status_type: The status type.
+ * @param status_type The status type. - * Returns: TRUE if the status type can be set or modified by the user.
+ * @return TRUE if the status type can be set or modified by the user. * FALSE if it's a protocol-set setting.
gboolean purple_status_type_is_user_settable(const PurpleStatusType *status_type);
@@ -328,18 +328,18 @@
* Independent status types are non-exclusive. If other status types on
* the same hierarchy level are set, this one will not be affected.
- * @status_type: The status type.
+ * @param status_type The status type. - * Returns: TRUE if the status type is independent, or FALSE otherwise.
+ * @return TRUE if the status type is independent, or FALSE otherwise. gboolean purple_status_type_is_independent(const PurpleStatusType *status_type);
* Returns whether the status type is exclusive.
- * @status_type: The status type.
+ * @param status_type The status type. - * Returns: TRUE if the status type is exclusive, FALSE otherwise.
+ * @return TRUE if the status type is exclusive, FALSE otherwise. gboolean purple_status_type_is_exclusive(const PurpleStatusType *status_type);
@@ -348,19 +348,19 @@
* Available status types are online and possibly invisible, but not away.
- * @status_type: The status type.
+ * @param status_type The status type. - * Returns: TRUE if the status is available, or FALSE otherwise.
+ * @return TRUE if the status is available, or FALSE otherwise. gboolean purple_status_type_is_available(const PurpleStatusType *status_type);
* Returns the attribute with the specified ID.
- * @status_type: The status type containing the attribute.
- * @id: The ID of the desired attribute.
+ * @param status_type The status type containing the attribute. + * @param id The ID of the desired attribute. - * Returns: The attribute, if found. NULL otherwise.
+ * @return The attribute, if found. NULL otherwise. PurpleStatusAttribute *purple_status_type_get_attr(const PurpleStatusType *status_type,
@@ -368,19 +368,19 @@
* Returns a list of all attributes in a status type.
- * @status_type: The status type.
+ * @param status_type The status type. - * Returns: (transfer none): The list of attributes.
+ * @constreturn The list of attributes. GList *purple_status_type_get_attrs(const PurpleStatusType *status_type);
* Find the PurpleStatusType with the given id.
- * @status_types: A list of status types. Often account->status_types.
- * @id: The unique ID of the status type you wish to find.
+ * @param status_types A list of status types. Often account->status_types. + * @param id The unique ID of the status type you wish to find. - * Returns: The status type with the given ID, or NULL if one could
+ * @return The status type with the given ID, or NULL if one could const PurpleStatusType *purple_status_type_find_with_id(GList *status_types,
@@ -401,11 +401,11 @@
* Creates a new status attribute.
- * @id: The ID of the attribute.
- * @name: The name presented to the user.
- * @value_type: The type of data contained in the attribute.
+ * @param id The ID of the attribute. + * @param name The name presented to the user. + * @param value_type The type of data contained in the attribute. - * Returns: A new status attribute.
+ * @return A new status attribute. PurpleStatusAttribute *purple_status_attribute_new(const char *id, const char *name,
@@ -413,34 +413,34 @@
* Destroys a status attribute.
- * @attr: The status attribute to destroy.
+ * @param attr The status attribute to destroy. void purple_status_attribute_destroy(PurpleStatusAttribute *attr);
* Returns the ID of a status attribute.
- * @attr: The status attribute.
+ * @param attr The status attribute. - * Returns: The status attribute's ID.
+ * @return The status attribute's ID. const char *purple_status_attribute_get_id(const PurpleStatusAttribute *attr);
* Returns the name of a status attribute.
- * @attr: The status attribute.
+ * @param attr The status attribute. - * Returns: The status attribute's name.
+ * @return The status attribute's name. const char *purple_status_attribute_get_name(const PurpleStatusAttribute *attr);
* Returns the value of a status attribute.
- * @attr: The status attribute.
+ * @param attr The status attribute. - * Returns: The status attribute's value.
+ * @return The status attribute's value. GValue *purple_status_attribute_get_value(const PurpleStatusAttribute *attr);
@@ -471,10 +471,10 @@
- * @status_type: The type of status.
- * @presence: The parent presence.
+ * @param status_type The type of status. + * @param presence The parent presence. - * Returns: The new status.
+ * @return The new status. PurpleStatus *purple_status_new(PurpleStatusType *status_type,
PurplePresence *presence);
@@ -484,8 +484,8 @@
* This should only be called by the account, conversation, and buddy APIs.
- * @active: The active state.
+ * @param status The status. + * @param active The active state. void purple_status_set_active(PurpleStatus *status, gboolean active);
@@ -494,9 +494,9 @@
* This should only be called by the account, conversation, and buddy APIs.
- * @active: The active state.
- * @args: A list of attributes to set on the status. This list is
+ * @param status The status. + * @param active The active state. + * @param args A list of attributes to set on the status. This list is * composed of key/value pairs, where each key is a valid
* attribute name for this PurpleStatusType. The list should
@@ -509,9 +509,9 @@
* This should only be called by the account, conversation, and buddy APIs.
- * @active: The active state.
- * @attrs: A list of attributes to set on the status. This list is
+ * @param status The status. + * @param active The active state. + * @param attrs A list of attributes to set on the status. This list is * composed of key/value pairs, where each key is a valid
* attribute name for this PurpleStatusType. The list is
* not modified or freed by this function.
@@ -522,18 +522,18 @@
* Returns the status's type.
+ * @param status The status. - * Returns: The status's type.
+ * @return The status's type. PurpleStatusType *purple_status_get_status_type(const PurpleStatus *status);
* Returns the status's presence.
+ * @param status The status. - * Returns: The status's presence.
+ * @return The status's presence. PurplePresence *purple_status_get_presence(const PurpleStatus *status);
@@ -543,9 +543,9 @@
* This is a convenience method for
* purple_status_type_get_id(purple_status_get_type(status)).
+ * @param status The status. - * Returns: The status's ID.
+ * @return The status's ID. const char *purple_status_get_id(const PurpleStatus *status);
@@ -555,9 +555,9 @@
* This is a convenience method for
* purple_status_type_get_name(purple_status_get_type(status)).
+ * @param status The status. - * Returns: The status's name.
+ * @return The status's name. const char *purple_status_get_name(const PurpleStatus *status);
@@ -567,9 +567,9 @@
* This is a convenience method for
* purple_status_type_is_independent(purple_status_get_type(status)).
+ * @param status The status. - * Returns: TRUE if the status is independent, or FALSE otherwise.
+ * @return TRUE if the status is independent, or FALSE otherwise. gboolean purple_status_is_independent(const PurpleStatus *status);
@@ -579,9 +579,9 @@
* This is a convenience method for
* purple_status_type_is_exclusive(purple_status_get_type(status)).
+ * @param status The status. - * Returns: TRUE if the status is exclusive, FALSE otherwise.
+ * @return TRUE if the status is exclusive, FALSE otherwise. gboolean purple_status_is_exclusive(const PurpleStatus *status);
@@ -593,37 +593,37 @@
* This is a convenience method for
* purple_status_type_is_available(purple_status_get_type(status)).
+ * @param status The status. - * Returns: TRUE if the status is available, or FALSE otherwise.
+ * @return TRUE if the status is available, or FALSE otherwise. gboolean purple_status_is_available(const PurpleStatus *status);
* Returns the active state of a status.
+ * @param status The status. - * Returns: The active state of the status.
+ * @return The active state of the status. gboolean purple_status_is_active(const PurpleStatus *status);
* Returns whether or not a status is considered 'online'
+ * @param status The status. - * Returns: TRUE if the status is considered online, FALSE otherwise
+ * @return TRUE if the status is considered online, FALSE otherwise gboolean purple_status_is_online(const PurpleStatus *status);
* Returns the value of an attribute in a status with the specified ID.
- * @id: The attribute ID.
+ * @param status The status. + * @param id The attribute ID. - * Returns: The value of the attribute.
+ * @return The value of the attribute. GValue *purple_status_get_attr_value(const PurpleStatus *status,
@@ -631,10 +631,10 @@
* Returns the boolean value of an attribute in a status with the specified ID.
- * @id: The attribute ID.
+ * @param status The status. + * @param id The attribute ID. - * Returns: The boolean value of the attribute.
+ * @return The boolean value of the attribute. gboolean purple_status_get_attr_boolean(const PurpleStatus *status,
@@ -642,20 +642,20 @@
* Returns the integer value of an attribute in a status with the specified ID.
- * @id: The attribute ID.
+ * @param status The status. + * @param id The attribute ID. - * Returns: The integer value of the attribute.
+ * @return The integer value of the attribute. int purple_status_get_attr_int(const PurpleStatus *status, const char *id);
* Returns the string value of an attribute in a status with the specified ID.
- * @id: The attribute ID.
+ * @param status The status. + * @param id The attribute ID. - * Returns: The string value of the attribute.
+ * @return The string value of the attribute. const char *purple_status_get_attr_string(const PurpleStatus *status,
@@ -663,10 +663,10 @@
* Compares two statuses for availability.
- * @status1: The first status.
- * @status2: The second status.
+ * @param status1 The first status. + * @param status2 The second status. - * Returns: -1 if @a status1 is more available than @a status2.
+ * @return -1 if @a status1 is more available than @a status2. * 0 if @a status1 is equal to @a status2.
* 1 if @a status2 is more available than @a status1.
@@ -682,7 +682,7 @@
* Get the handle for the status subsystem.
- * Returns: the handle to the status subsystem
+ * @return the handle to the status subsystem void *purple_statuses_get_handle(void);
--- a/libpurple/util.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/util.h Wed Jan 29 10:49:02 2014 +0530
@@ -67,13 +67,13 @@
* Creates a new PurpleMenuAction.
- * @label: The text label to display for this action.
- * @callback: The function to be called when the action is used on
+ * @param label The text label to display for this action. + * @param callback The function to be called when the action is used on - * @data: Additional data to be passed to the callback.
- * @children: A GList of PurpleMenuActions to be added as a submenu
+ * @param data Additional data to be passed to the callback. + * @param children A GList of PurpleMenuActions to be added as a submenu - * Returns: The PurpleMenuAction.
+ * @return The PurpleMenuAction. PurpleMenuAction *purple_menu_action_new(const char *label, PurpleCallback callback,
gpointer data, GList *children);
@@ -81,83 +81,83 @@
* Frees a PurpleMenuAction
- * @act: The PurpleMenuAction to free.
+ * @param act The PurpleMenuAction to free. void purple_menu_action_free(PurpleMenuAction *act);
* Returns the label of the PurpleMenuAction.
- * @act: The PurpleMenuAction.
+ * @param act The PurpleMenuAction. - * Returns: The label string.
+ * @return The label string. char * purple_menu_action_get_label(const PurpleMenuAction *act);
* Returns the callback of the PurpleMenuAction.
- * @act: The PurpleMenuAction.
+ * @param act The PurpleMenuAction. - * Returns: The callback function.
+ * @return The callback function. PurpleCallback purple_menu_action_get_callback(const PurpleMenuAction *act);
* Returns the data stored in the PurpleMenuAction.
- * @act: The PurpleMenuAction.
+ * @param act The PurpleMenuAction.
gpointer purple_menu_action_get_data(const PurpleMenuAction *act);
* Returns the children of the PurpleMenuAction.
- * @act: The PurpleMenuAction.
+ * @param act The PurpleMenuAction. - * Returns: The GList of children.
+ * @return The GList of children. GList* purple_menu_action_get_children(const PurpleMenuAction *act);
* Set the label to the PurpleMenuAction.
- * @act: The menu action.
- * @label: The label for the menu action.
+ * @param act The menu action. + * @param label The label for the menu action. void purple_menu_action_set_label(PurpleMenuAction *act, char *label);
* Set the callback that will be used by the PurpleMenuAction.
- * @act: The menu action.
- * @callback: The callback.
+ * @param act The menu action. + * @param callback The callback. void purple_menu_action_set_callback(PurpleMenuAction *act, PurpleCallback callback);
* Set the label to the PurpleMenuAction.
- * @act: The menu action.
- * @data: The data used by this PurpleMenuAction
+ * @param act The menu action. + * @param data The data used by this PurpleMenuAction void purple_menu_action_set_data(PurpleMenuAction *act, gpointer data);
* Set the children of the PurpleMenuAction.
- * @act: The menu action.
- * @children: The PurpleMenuAtion children
+ * @param act The menu action. + * @param children The PurpleMenuAtion children void purple_menu_action_set_children(PurpleMenuAction *act, GList *children);
* Sets the icon for the PurpleMenuAction.
- * @act: The menu action.
- * @strock: The stock icon identifier.
+ * @param act The menu action. + * @param strock The stock icon identifier. void purple_menu_action_set_stock_icon(PurpleMenuAction *act,
@@ -165,9 +165,9 @@
* Gets the stock icon of the PurpleMenuAction.
- * @act: The menu action.
+ * @param act The menu action. - * Returns: The stock icon identifier.
+ * @return The stock icon identifier. purple_menu_action_get_stock_icon(PurpleMenuAction *act);
@@ -175,9 +175,9 @@
* Set the appropriate presence values for the currently playing song.
- * @title: The title of the song, %NULL to unset the value.
- * @artist: The artist of the song, can be %NULL.
- * @album: The album of the song, can be %NULL.
+ * @param title The title of the song, @c NULL to unset the value. + * @param artist The artist of the song, can be @c NULL. + * @param album The album of the song, can be @c NULL. void purple_util_set_current_song(const char *title, const char *artist,
@@ -185,12 +185,12 @@
* Format song information.
- * @title: The title of the song, %NULL to unset the value.
- * @artist: The artist of the song, can be %NULL.
- * @album: The album of the song, can be %NULL.
- * @unused: Currently unused, must be %NULL.
+ * @param title The title of the song, @c NULL to unset the value. + * @param artist The artist of the song, can be @c NULL. + * @param album The album of the song, can be @c NULL. + * @param unused Currently unused, must be @c NULL. - * Returns: The formatted string. The caller must g_free the returned string.
+ * @return The formatted string. The caller must g_free the returned string. char * purple_util_format_song_info(const char *title, const char *artist,
const char *album, gpointer unused);
@@ -220,10 +220,10 @@
* Converts a chunk of binary data to its base-16 equivalent.
- * @data: The data to convert.
- * @len: The length of the data.
+ * @param data The data to convert. + * @param len The length of the data. - * Returns: The base-16 string in the ASCII encoding. Must be
+ * @return The base-16 string in the ASCII encoding. Must be * g_free'd when no longer needed.
* @see purple_base16_decode()
@@ -234,14 +234,14 @@
* Converts an ASCII string of base-16 encoded data to
- * @str: The base-16 string to convert to raw data.
- * @ret_len: The length of the returned data. You can
+ * @param str The base-16 string to convert to raw data. + * @param ret_len The length of the returned data. You can * pass in NULL if you're sure that you know
* the length of the decoded data, or if you
* know you'll be able to use strlen to
* determine the length, etc.
- * Returns: The raw data. Must be g_free'd when no longer needed.
+ * @return The raw data. Must be g_free'd when no longer needed. * @see purple_base16_encode()
@@ -253,10 +253,10 @@
* Example output: 01:23:45:67:89:AB:CD:EF
- * @data: The data to convert.
- * @len: The length of the data.
+ * @param data The data to convert. + * @param len The length of the data. - * Returns: The base-16 string in the ASCII chunked encoding. Must be
+ * @return The base-16 string in the ASCII chunked encoding. Must be * g_free'd when no longer needed.
gchar *purple_base16_encode_chunked(const guchar *data, gsize len);
@@ -272,10 +272,10 @@
* Converts a chunk of binary data to its base-64 equivalent.
- * @data: The data to convert.
- * @len: The length of the data.
+ * @param data The data to convert. + * @param len The length of the data. - * Returns: The base-64 string in the ASCII encoding. Must be
+ * @return The base-64 string in the ASCII encoding. Must be * g_free'd when no longer needed.
* @see purple_base64_decode()
@@ -286,14 +286,14 @@
* Converts an ASCII string of base-64 encoded data to
- * @str: The base-64 string to convert to raw data.
- * @ret_len: The length of the returned data. You can
+ * @param str The base-64 string to convert to raw data. + * @param ret_len The length of the returned data. You can * pass in NULL if you're sure that you know
* the length of the decoded data, or if you
* know you'll be able to use strlen to
* determine the length, etc.
- * Returns: The raw data. Must be g_free'd when no longer needed.
+ * @return The raw data. Must be g_free'd when no longer needed. * @see purple_base64_encode()
@@ -313,10 +313,10 @@
* emails containing non-ASCII characters. Wikipedia has a pretty good
* explanation. Also see RFC 2045.
- * @str: The quoted printable ASCII string to convert to raw data.
- * @ret_len: The length of the returned data.
+ * @param str The quoted printable ASCII string to convert to raw data. + * @param ret_len The length of the returned data. - * Returns: The readable string. Must be g_free'd when no longer needed.
+ * @return The readable string. Must be g_free'd when no longer needed. guchar *purple_quotedp_decode(const char *str, gsize *ret_len);
@@ -339,10 +339,10 @@
* question mark. The first piece is the character set, the second
* piece is the encoding, and the third piece is the encoded text.
- * @str: The ASCII string, possibly containing any number of
+ * @param str The ASCII string, possibly containing any number of - * Returns: The string, with any encoded-word sections decoded and
+ * @return The string, with any encoded-word sections decoded and * converted to UTF-8. Must be g_free'd when no longer
@@ -374,12 +374,12 @@
* abbreviation (as is the case on Unix). As with %z, conversion specifiers
- * @format: The format string, in UTF-8
- * @tm: The time to format, or %NULL to use the current local time
+ * @param format The format string, in UTF-8 + * @param tm The time to format, or @c NULL to use the current local time - * Returns: The formatted time, in UTF-8.
+ * @return The formatted time, in UTF-8. - * Note: @a format is required to be in UTF-8. This differs from strftime(),
+ * @note @a format is required to be in UTF-8. This differs from strftime(), * where the format is provided in the locale charset.
const char *purple_utf8_strftime(const char *format, const struct tm *tm);
@@ -387,8 +387,8 @@
* Gets a string representation of the local timezone offset
- * @tm: The time to get the timezone for
- * @iso: TRUE to format the offset according to ISO-8601, FALSE to
+ * @param tm The time to get the timezone for + * @param iso TRUE to format the offset according to ISO-8601, FALSE to * not substitute 'Z' for 0 offset, and to not separate
* hours and minutes with a colon.
@@ -400,9 +400,9 @@
* The returned string is stored in a static buffer, so the result
* should be g_strdup()'d if it's going to be kept.
- * @tm: The time to format, or %NULL to use the current local time
+ * @param tm The time to format, or @c NULL to use the current local time - * Returns: The date, formatted as per the user's settings. In the USA this
+ * @return The date, formatted as per the user's settings. In the USA this * is something like "02/18/13"
const char *purple_date_format_short(const struct tm *tm);
@@ -413,9 +413,9 @@
* The returned string is stored in a static buffer, so the result
* should be g_strdup()'d if it's going to be kept.
- * @tm: The time to format, or %NULL to use the current local time
+ * @param tm The time to format, or @c NULL to use the current local time - * Returns: The timestamp, formatted as per the user's settings. In the USA
+ * @return The timestamp, formatted as per the user's settings. In the USA * this is something like "02/18/13 15:26:44"
const char *purple_date_format_long(const struct tm *tm);
@@ -426,9 +426,9 @@
* The returned string is stored in a static buffer, so the result
* should be g_strdup()'d if it's going to be kept.
- * @tm: The time to format, or %NULL to use the current local time
+ * @param tm The time to format, or @c NULL to use the current local time - * Returns: The date and time, formatted as per the user's settings. In the
+ * @return The date and time, formatted as per the user's settings. In the * USA this is something like "Mon Feb 18 15:26:44 2013"
const char *purple_date_format_full(const struct tm *tm);
@@ -439,9 +439,9 @@
* The returned string is stored in a static buffer, so the result
* should be g_strdup()'d if it's going to be kept.
- * @tm: The time to format, or %NULL to use the current local time
+ * @param tm The time to format, or @c NULL to use the current local time - * Returns: The time, formatted as per the user's settings. In the USA this
+ * @return The time, formatted as per the user's settings. In the USA this * is something like "15:26:44"
const char *purple_time_format(const struct tm *tm);
@@ -449,14 +449,14 @@
* Builds a time_t from the supplied information.
+ * @param year The year. + * @param month The month. + * @param hour The hour. + * @param min The minute. + * @param sec The second.
time_t purple_time_build(int year, int month, int day, int hour,
@@ -469,21 +469,21 @@
* Parses a timestamp in jabber, ISO8601, or MM/DD/YYYY format and returns
- * @timestamp: The timestamp
- * @utc: Assume UTC if no timezone specified
- * @tm: If not %NULL, the caller can get a copy of the
+ * @param timestamp The timestamp + * @param utc Assume UTC if no timezone specified + * @param tm If not @c NULL, the caller can get a copy of the * struct tm used to calculate the time_t return value.
- * @tz_off: If not %NULL, the caller can get a copy of the
+ * @param tz_off If not @c NULL, the caller can get a copy of the * timezone offset (from UTC) used to calculate the time_t
* return value. Note: Zero is a valid offset. As such,
* the value of the macro @c PURPLE_NO_TZ_OFF indicates no
* offset was specified (which means that the local
* timezone was used in the calculation).
- * @rest: If not %NULL, the caller can get a pointer to the
+ * @param rest If not @c NULL, the caller can get a pointer to the * part of @a timestamp left over after parsing is
* completed, if it's not the end of @a timestamp.
time_t purple_str_to_time(const char *timestamp, gboolean utc,
struct tm *tm, long *tz_off, const char **rest);
@@ -491,13 +491,13 @@
* Formats a datetime according to a UTS-35 Date Format Pattern.
- * @format: The formatting string, according to UTS #35
+ * @param format The formatting string, according to UTS #35 * See http://unicode.org/reports/tr35/
* (NOTE: not all formats are supported)
- * @len: The length of the formatting string
- * @tm: The time to format, or %NULL to use the current local time
+ * @param len The length of the formatting string + * @param tm The time to format, or @c NULL to use the current local time - * Returns: The time, formatted as per the user's settings.
+ * @return The time, formatted as per the user's settings. char *purple_uts35_to_str(const char *format, size_t len, struct tm *tm);
@@ -527,13 +527,13 @@
* in a GData hash table. The names of the attributes are lower-cased
* in the hash table, and the name of the tag is case insensitive.
- * @needle: The name of the tag
- * @haystack: The null-delimited string to search in
- * @start: A pointer to the start of the tag if found
- * @end: A pointer to the end of the tag if found
- * @attributes: The attributes, if the tag was found. This should
+ * @param needle The name of the tag + * @param haystack The null-delimited string to search in + * @param start A pointer to the start of the tag if found + * @param end A pointer to the end of the tag if found + * @param attributes The attributes, if the tag was found. This should * be freed with g_datalist_clear().
- * Returns: TRUE if the tag was found
+ * @return TRUE if the tag was found gboolean purple_markup_find_tag(const char *needle, const char *haystack,
const char **start, const char **end,
@@ -545,22 +545,22 @@
* This is a scary function. See protocols/msn/msn.c and
* protocols/yahoo/yahoo_profile.c for example usage.
- * @str: The string to parse.
- * @len: The size of str.
- * @user_info: The destination PurpleNotifyUserInfo to which the new
+ * @param str The string to parse. + * @param len The size of str. + * @param user_info The destination PurpleNotifyUserInfo to which the new * field info should be added.
- * @start_token: The beginning token.
- * @skip: The number of characters to skip after the
+ * @param start_token The beginning token. + * @param skip The number of characters to skip after the - * @end_token: The ending token.
- * @check_value: The value that the last character must meet.
- * @no_value_token: The token indicating no value is given.
- * @display_name: The short descriptive name to display for this token.
- * @is_link: TRUE if this should be a link, or FALSE otherwise.
- * @link_prefix: The prefix for the link.
- * @format_cb: A callback to format the value before adding it.
+ * @param end_token The ending token. + * @param check_value The value that the last character must meet. + * @param no_value_token The token indicating no value is given. + * @param display_name The short descriptive name to display for this token. + * @param is_link TRUE if this should be a link, or FALSE otherwise. + * @param link_prefix The prefix for the link. + * @param format_cb A callback to format the value before adding it. - * Returns: TRUE if successful, or FALSE otherwise.
+ * @return TRUE if successful, or FALSE otherwise. gboolean purple_markup_extract_info_field(const char *str, int len, PurpleNotifyUserInfo *user_info,
const char *start_token, int skip,
@@ -573,9 +573,9 @@
* Converts HTML markup to XHTML.
- * @html: The HTML markup.
- * @dest_xhtml: The destination XHTML output.
- * @dest_plain: The destination plain-text output.
+ * @param html The HTML markup. + * @param dest_xhtml The destination XHTML output. + * @param dest_plain The destination plain-text output. void purple_markup_html_to_xhtml(const char *html, char **dest_xhtml,
@@ -583,9 +583,9 @@
* Strips HTML tags from a string.
- * @str: The string to strip HTML from.
+ * @param str The string to strip HTML from. - * Returns: The new string without HTML. You must g_free this string
+ * @return The new string without HTML. You must g_free this string char *purple_markup_strip_html(const char *str);
@@ -593,9 +593,9 @@
* Adds the necessary HTML code to turn URIs into HTML links in a string.
- * @str: The string to linkify.
+ * @param str The string to linkify. - * Returns: The new string with all URIs surrounded in standard
+ * @return The new string with all URIs surrounded in standard * HTML <a href="whatever"></a> tags. You must g_free this
* string when finished with it.
@@ -611,9 +611,9 @@
* purple_unescape_html() is similar, but also converts "<br>" into "\n".
- * @text: The string in which to unescape any HTML entities
+ * @param text The string in which to unescape any HTML entities - * Returns: The text with HTML entities literalized. You must g_free
+ * @return The text with HTML entities literalized. You must g_free * this string when finished with it.
* @see purple_unescape_html()
@@ -624,9 +624,9 @@
* Unescapes HTML entities to their literal characters and converts
* "<br>" to "\n". See purple_unescape_text() for more details.
- * @html: The string in which to unescape any HTML entities
+ * @param html The string in which to unescape any HTML entities - * Returns: The text with HTML entities literalized. You must g_free
+ * @return The text with HTML entities literalized. You must g_free * this string when finished with it.
* @see purple_unescape_text()
@@ -646,13 +646,13 @@
* when used with other UI's. libpurple users are encouraged to report and
* work out any problems encountered.
- * @str: The input NUL terminated, HTML, UTF-8 (or ASCII) string.
+ * @param str The input NUL terminated, HTML, UTF-8 (or ASCII) string. * @param x The character offset into an unformatted version of str to
* @param y The character offset (into an unformatted vesion of str) of
* one past the last character to include in the slice.
- * Returns: The HTML slice of string, with all formatting retained.
+ * @return The HTML slice of string, with all formatting retained. char *purple_markup_slice(const char *str, guint x, guint y);
@@ -662,8 +662,8 @@
* a '>' sometime after that. If there is no '>' and the string is
* not NUL terminated, this function can be expected to segfault.
- * @tag: The string starting a HTML tag.
- * Returns: A string containing the name of the tag.
+ * @param tag The string starting a HTML tag. + * @return A string containing the name of the tag. char *purple_markup_get_tag_name(const char *tag);
@@ -672,16 +672,16 @@
* entity pointed to by @a text. For example, purple_markup_unescape_entity("&")
* will return "&". The @a text variable is expected to point to an '&',
* the first character of the entity. If given an unrecognized entity, the function
* Note that this function, unlike purple_unescape_html(), does not search
* the string for the entity, does not replace the entity, and does not
* return a newly allocated string.
- * @text: A string containing an HTML entity.
- * @length: If not %NULL, the string length of the entity is stored in this location.
+ * @param text A string containing an HTML entity. + * @param length If not @c NULL, the string length of the entity is stored in this location. - * Returns: A constant string containing the character representation of the given entity.
+ * @return A constant string containing the character representation of the given entity. const char * purple_markup_unescape_entity(const char *text, int *length);
@@ -694,21 +694,21 @@
* "color") would return "#dc4d1b".
* On error or if the requested property was not found, the function returns
- * @style: A string containing the inline CSS text.
- * @opt: The requested CSS property.
+ * @param style A string containing the inline CSS text. + * @param opt The requested CSS property. - * Returns: The value of the requested CSS property.
+ * @return The value of the requested CSS property. char * purple_markup_get_css_property(const gchar *style, const gchar *opt);
* Check if the given HTML contains RTL text.
- * @html: The HTML text.
+ * @param html The HTML text. - * Returns: TRUE if the text contains RTL text, FALSE otherwise.
+ * @return TRUE if the text contains RTL text, FALSE otherwise. gboolean purple_markup_is_rtl(const char *html);
@@ -723,7 +723,7 @@
* Returns the user's home directory.
- * Returns: The user's home directory.
+ * @return The user's home directory. @@ -733,7 +733,7 @@
* Returns the purple settings directory in the user's home directory.
* This is usually ~/.purple
- * Returns: The purple settings directory.
+ * @return The purple settings directory. @@ -741,7 +741,7 @@
* Define a custom purple settings directory, overriding the default (user's home directory/.purple)
- * @dir: The custom settings directory
+ * @param dir The custom settings directory void purple_util_set_user_dir(const char *dir);
@@ -749,11 +749,11 @@
* Builds a complete path from the root, making any directories along
* the path which do not already exist.
- * @path: The path you wish to create. Note that it must start
+ * @param path The path you wish to create. Note that it must start * from the root or this function will fail.
- * @mode: Unix-style permissions for this directory.
+ * @param mode Unix-style permissions for this directory. - * Returns: 0 for success, nonzero on any error.
+ * @return 0 for success, nonzero on any error. int purple_build_dir(const char *path, int mode);
@@ -765,12 +765,12 @@
* obtained using purple_xmlnode_to_formatted_str. However, this function
* should work fine for saving binary files as well.
- * @filename: The basename of the file to write in the purple_user_dir.
- * @data: A null-terminated string of data to write.
- * @size: The size of the data to save. If data is
+ * @param filename The basename of the file to write in the purple_user_dir. + * @param data A null-terminated string of data to write. + * @param size The size of the data to save. If data is * null-terminated you can pass in -1.
- * Returns: TRUE if the file was written successfully. FALSE otherwise.
+ * @return TRUE if the file was written successfully. FALSE otherwise. gboolean purple_util_write_data_to_file(const char *filename, const char *data,
@@ -780,12 +780,12 @@
* This exists for Glib backwards compatibility reasons.
- * @filename_full: Filename to write to
- * @data: A null-terminated string of data to write.
- * @size: The size of the data to save. If data is
+ * @param filename_full Filename to write to + * @param data A null-terminated string of data to write. + * @param size The size of the data to save. If data is * null-terminated you can pass in -1.
- * Returns: TRUE if the file was written successfully. FALSE otherwise.
+ * @return TRUE if the file was written successfully. FALSE otherwise. * @todo Remove this function (use g_file_set_contents instead) when 3.0.0
@@ -800,13 +800,13 @@
* PurpleXmlNode tree structure. This is intended to be used to read
* Purple's configuration xml files (prefs.xml, pounces.xml, etc.)
- * @filename: The basename of the file to open in the purple_user_dir.
- * @description: A very short description of the contents of this
+ * @param filename The basename of the file to open in the purple_user_dir. + * @param description A very short description of the contents of this * file. This is used in error messages shown to the
* user when the file can not be opened. For example,
* "preferences," or "buddy pounces."
- * Returns: An PurpleXmlNode tree of the contents of the given file. Or NULL, if
+ * @return An PurpleXmlNode tree of the contents of the given file. Or NULL, if * the file does not exist or there was an error reading the file.
PurpleXmlNode *purple_util_read_xml_from_file(const char *filename,
@@ -823,26 +823,26 @@
* done, as well as freeing the space pointed to by @a path with
- * @path: The returned path to the temp file.
- * @binary: Text or binary, for platforms where it matters.
+ * @param path The returned path to the temp file. + * @param binary Text or binary, for platforms where it matters. - * Returns: A file pointer to the temporary file, or %NULL on failure.
+ * @return A file pointer to the temporary file, or @c NULL on failure. FILE *purple_mkstemp(char **path, gboolean binary);
* Returns an extension corresponding to the image data's file type.
- * @data: A pointer to the image data
- * @len: The length of the image data
+ * @param data A pointer to the image data + * @param len The length of the image data - * Returns: The appropriate extension, or "icon" if unknown.
+ * @return The appropriate extension, or "icon" if unknown. purple_util_get_image_extension(gconstpointer data, size_t len);
- * Returns: A hex encoded version of the SHA-1 hash of the data passed
+ * @return A hex encoded version of the SHA-1 hash of the data passed * in with the correct file extention appended. The file
* extension is determined by calling
* purple_util_get_image_extension(). This return value must
@@ -861,48 +861,48 @@
* Checks if the given program name is valid and executable.
- * @program: The file name of the application.
+ * @param program The file name of the application. - * Returns: TRUE if the program is runable.
+ * @return TRUE if the program is runable. gboolean purple_program_is_valid(const char *program);
* Check if running GNOME.
- * Returns: TRUE if running GNOME, FALSE otherwise.
+ * @return TRUE if running GNOME, FALSE otherwise. gboolean purple_running_gnome(void);
- * Returns: TRUE if running KDE, FALSE otherwise.
+ * @return TRUE if running KDE, FALSE otherwise. gboolean purple_running_kde(void);
- * Returns: TRUE if running OS X, FALSE otherwise.
+ * @return TRUE if running OS X, FALSE otherwise. gboolean purple_running_osx(void);
* Returns the IP address from a socket file descriptor.
- * @fd: The socket file descriptor.
+ * @param fd The socket file descriptor. - * Returns: The IP address, or %NULL on error.
+ * @return The IP address, or @c NULL on error. char *purple_fd_get_ip(int fd);
* Returns the address family of a socket.
- * @fd: The socket file descriptor.
+ * @param fd The socket file descriptor. - * Returns: The address family of the socket (AF_INET, AF_INET6, etc) or -1
+ * @return The address family of the socket (AF_INET, AF_INET6, etc) or -1 int purple_socket_get_family(int fd);
@@ -913,8 +913,8 @@
* This is the case for IPv4 sockets and, on some systems, IPv6 sockets
* (due to the IPv4-mapped address functionality).
- * @fd: The socket file descriptor
- * Returns: TRUE if a socket can speak IPv4.
+ * @param fd The socket file descriptor + * @return TRUE if a socket can speak IPv4. gboolean purple_socket_speaks_ipv4(int fd);
@@ -930,12 +930,12 @@
* Tests two strings for equality.
* Unlike strcmp(), this function will not crash if one or both of the
- * @right: A string to compare with left
+ * @param right A string to compare with left - * Returns: %TRUE if the strings are the same, else %FALSE.
+ * @return @c TRUE if the strings are the same, else @c FALSE. gboolean purple_strequal(const gchar *left, const gchar *right);
@@ -947,14 +947,14 @@
* g_strdup() it. Also, calling normalize() twice in the same line
- * @account: The account the string belongs to, or NULL if you do
+ * @param account The account the string belongs to, or NULL if you do * not know the account. If you use NULL, the string
* will still be normalized, but if the protocol uses a
* custom normalization function then the string may
* not be normalized correctly.
- * @str: The string to normalize.
+ * @param str The string to normalize. - * Returns: A pointer to the normalized version stored in a static buffer.
+ * @return A pointer to the normalized version stored in a static buffer. const char *purple_normalize(const PurpleAccount *account, const char *str);
@@ -965,20 +965,20 @@
* function "normalize." It returns a lowercase and UTF-8
* normalized version of the string.
- * @account: The account the string belongs to.
- * @str: The string to normalize.
+ * @param account The account the string belongs to. + * @param str The string to normalize. - * Returns: A pointer to the normalized version stored in a static buffer.
+ * @return A pointer to the normalized version stored in a static buffer. const char *purple_normalize_nocase(const PurpleAccount *account, const char *str);
* Checks, if a string is valid.
- * @protocol: The protocol the string belongs to.
- * @str: The string to validate.
+ * @param protocol The protocol the string belongs to. + * @param str The string to validate. - * Returns: TRUE, if string is valid, otherwise FALSE.
+ * @return TRUE, if string is valid, otherwise FALSE. gboolean purple_validate(const PurpleProtocol *protocol, const char *str);
@@ -989,7 +989,7 @@
* @param s The string to check.
* @param p The prefix in question.
- * Returns: TRUE if p is a prefix of s, otherwise FALSE.
+ * @return TRUE if p is a prefix of s, otherwise FALSE. gboolean purple_str_has_prefix(const char *s, const char *p);
@@ -1000,7 +1000,7 @@
* @param s The string to check.
* @param x The suffix in question.
- * Returns: TRUE if x is a a suffix of s, otherwise FALSE.
+ * @return TRUE if x is a a suffix of s, otherwise FALSE. gboolean purple_str_has_suffix(const char *s, const char *x);
@@ -1008,18 +1008,18 @@
* Duplicates a string and replaces all newline characters from the
* source string with HTML linebreaks.
- * @src: The source string.
+ * @param src The source string. - * Returns: The new string. Must be g_free'd by the caller.
+ * @return The new string. Must be g_free'd by the caller. gchar *purple_strdup_withhtml(const gchar *src);
* Ensures that all linefeeds have a matching carriage return.
- * @str: The source string.
+ * @param str The source string. - * Returns: The string with carriage returns.
+ * @return The string with carriage returns. char *purple_str_add_cr(const char *str);
@@ -1031,8 +1031,8 @@
* purple_str_strip_char(my_dumb_string, '\n');
- * @str: The string to strip characters from.
- * @thechar: The character to strip from the given string.
+ * @param str The string to strip characters from. + * @param thechar The character to strip from the given string. void purple_str_strip_char(char *str, char thechar);
@@ -1041,9 +1041,9 @@
* with another. This happens inline (the original string IS
- * @string: The string from which to replace stuff.
- * @delimiter: The character you want replaced.
- * @replacement: The character you want inserted in place
+ * @param string The string from which to replace stuff. + * @param delimiter The character you want replaced. + * @param replacement The character you want inserted in place * of the delimiting character.
void purple_util_chrreplace(char *string, char delimiter,
@@ -1053,12 +1053,12 @@
* Given a string, this replaces one substring with another
* and returns a newly allocated string.
- * @string: The string from which to replace stuff.
- * @delimiter: The substring you want replaced.
- * @replacement: The substring you want inserted in place
+ * @param string The string from which to replace stuff. + * @param delimiter The substring you want replaced. + * @param replacement The substring you want inserted in place * of the delimiting substring.
- * Returns: A new string, after performing the substitution.
+ * @return A new string, after performing the substitution. * free this with g_free().
gchar *purple_strreplace(const char *string, const char *delimiter,
@@ -1070,9 +1070,9 @@
* the corresponding numerical character reference, and returns a newly
- * @in: The string which might contain utf-8 substrings
+ * @param in The string which might contain utf-8 substrings - * Returns: A new string, with utf-8 replaced with numerical character
+ * @return A new string, with utf-8 replaced with numerical character * references, free this with g_free()
char *purple_utf8_ncr_encode(const char *in);
@@ -1083,9 +1083,9 @@
* in that string with the corresponding actual utf-8 substrings,
* and returns a newly allocated string.
- * @in: The string which might contain numerical character references.
+ * @param in The string which might contain numerical character references. - * Returns: A new string, with numerical character references
+ * @return A new string, with numerical character references * replaced with actual utf-8, free this with g_free().
char *purple_utf8_ncr_decode(const char *in);
@@ -1095,12 +1095,12 @@
* Given a string, this replaces one substring with another
* ignoring case and returns a newly allocated string.
- * @string: The string from which to replace stuff.
- * @delimiter: The substring you want replaced.
- * @replacement: The substring you want inserted in place
+ * @param string The string from which to replace stuff. + * @param delimiter The substring you want replaced. + * @param replacement The substring you want inserted in place * of the delimiting substring.
- * Returns: A new string, after performing the substitution.
+ * @return A new string, after performing the substitution. * free this with g_free().
gchar *purple_strcasereplace(const char *string, const char *delimiter,
@@ -1110,10 +1110,10 @@
* This is like strstr, except that it ignores ASCII case in
* searching for the substring.
- * @haystack: The string to search in.
- * @needle: The substring to find.
+ * @param haystack The string to search in. + * @param needle The substring to find. - * Returns: the location of the substring if found, or NULL if not
+ * @return the location of the substring if found, or NULL if not const char *purple_strcasestr(const char *haystack, const char *needle);
@@ -1121,18 +1121,18 @@
* Returns a string representing a filesize in the appropriate
* units (MB, KB, GB, etc.)
- * Returns: The string in units form. This must be freed.
+ * @return The string in units form. This must be freed. char *purple_str_size_to_units(goffset size);
* Converts seconds into a human-readable form.
+ * @param sec The seconds. - * Returns: A human-readable form, containing days, hours, minutes, and
+ * @return A human-readable form, containing days, hours, minutes, and char *purple_str_seconds_to_string(guint sec);
@@ -1144,19 +1144,19 @@
* changed into two backslashes (\\\\). The returned, newly allocated
* string can be outputted to the console, and must be g_free()d.
- * @binary: A string of random data, possibly with embedded NULs
+ * @param binary A string of random data, possibly with embedded NULs - * @len: The length in bytes of the input string. Must not be 0.
+ * @param len The length in bytes of the input string. Must not be 0. - * Returns: A newly allocated ASCIIZ string.
+ * @return A newly allocated ASCIIZ string. char *purple_str_binary_to_ascii(const unsigned char *binary, guint len);
* Calculates UTF-16 string size (in bytes).
- * @str: String to check.
- * Returns: Number of bytes (including NUL character) that string occupies.
+ * @param str String to check. + * @return Number of bytes (including NUL character) that string occupies. size_t purple_utf16_size(const gunichar2 *str);
@@ -1165,7 +1165,7 @@
* It should be used to free sensitive data, like passwords.
- * @str: A NUL-terminated string to free, or a NULL-pointer.
+ * @param str A NUL-terminated string to free, or a NULL-pointer. void purple_str_wipe(gchar *str);
@@ -1174,7 +1174,7 @@
* It should be used to free sensitive data, like passwords.
- * @str: A NUL-terminated string to free, or a NULL-pointer.
+ * @param str A NUL-terminated string to free, or a NULL-pointer. void purple_utf16_wipe(gunichar2 *str);
@@ -1193,9 +1193,9 @@
* This will change hex codes and such to their ascii equivalents.
- * @str: The string to translate.
+ * @param str The string to translate. - * Returns: The resulting string.
+ * @return The resulting string. const char *purple_url_decode(const char *str);
@@ -1204,18 +1204,18 @@
* This will change non-alphanumeric characters to hex codes.
- * @str: The string to translate.
+ * @param str The string to translate. - * Returns: The resulting string.
+ * @return The resulting string. const char *purple_url_encode(const char *str);
* Checks if the given email address is syntactically valid.
- * @address: The email address to validate.
+ * @param address The email address to validate. - * Returns: True if the email address is syntactically correct.
+ * @return True if the email address is syntactically correct. gboolean purple_email_is_valid(const char *address);
@@ -1226,27 +1226,27 @@
* purple_ipv4_address_is_valid(), or for an IPv6 address use
* purple_ipv6_address_is_valid().
- * @ip: The IP address to validate.
+ * @param ip The IP address to validate. - * Returns: True if the IP address is syntactically correct.
+ * @return True if the IP address is syntactically correct. gboolean purple_ip_address_is_valid(const char *ip);
* Checks if the given IP address is a syntactically valid IPv4 address.
- * @ip: The IP address to validate.
+ * @param ip The IP address to validate. - * Returns: True if the IP address is syntactically correct.
+ * @return True if the IP address is syntactically correct. gboolean purple_ipv4_address_is_valid(const char *ip);
* Checks if the given IP address is a syntactically valid IPv6 address.
- * @ip: The IP address to validate.
+ * @param ip The IP address to validate. - * Returns: True if the IP address is syntactically correct.
+ * @return True if the IP address is syntactically correct. gboolean purple_ipv6_address_is_valid(const char *ip);
@@ -1254,9 +1254,9 @@
* This function extracts a list of URIs from the a "text/uri-list"
* string. It was "borrowed" from gnome_uri_list_extract_uris
- * @uri_list: An uri-list in the standard format.
+ * @param uri_list An uri-list in the standard format. - * Returns: A GList containing strings allocated with g_malloc
+ * @return A GList containing strings allocated with g_malloc * that have been splitted from uri-list.
GList *purple_uri_list_extract_uris(const gchar *uri_list);
@@ -1266,9 +1266,9 @@
* "text/uri-list" string. It was "borrowed" from
* gnome_uri_list_extract_filenames
- * @uri_list: A uri-list in the standard format.
+ * @param uri_list A uri-list in the standard format. - * Returns: A GList containing strings allocated with g_malloc that
+ * @return 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.
@@ -1287,9 +1287,9 @@
* This function checks the locale and tries sane defaults.
- * @str: The source string.
+ * @param str The source string. - * Returns: The UTF-8 string, or %NULL if it could not be converted.
+ * @return The UTF-8 string, or @c NULL if it could not be converted. gchar *purple_utf8_try_convert(const char *str);
@@ -1298,9 +1298,9 @@
* invalid characters with a filler character (currently hardcoded to
- * @str: The source string.
+ * @param str The source string. - * Returns: A valid UTF-8 string.
+ * @return A valid UTF-8 string. gchar *purple_utf8_salvage(const char *str);
@@ -1311,9 +1311,9 @@
* The returned string must be freed by the caller.
- * @str: A valid UTF-8 string.
+ * @param str A valid UTF-8 string. - * Returns: A newly allocated UTF-8 string without the unprintable characters.
+ * @return A newly allocated UTF-8 string without the unprintable characters. gchar *purple_utf8_strip_unprintables(const gchar *str);
@@ -1322,9 +1322,9 @@
* then converts the result to UTF-8. This function is analogous to
- * @errnum: The error code.
+ * @param errnum The error code. - * Returns: The UTF-8 error message.
+ * @return The UTF-8 error message. const gchar *purple_gai_strerror(gint errnum);
@@ -1337,7 +1337,7 @@
* @param a The first string.
* @param b The second string.
- * Returns: -1 if @a a is less than @a b.
+ * @return -1 if @a a is less than @a b. * 0 if @a a is equal to @a b.
* 1 if @a a is greater than @a b.
@@ -1348,10 +1348,10 @@
* must be contained in the haystack string and not be immediately
* preceded or immediately followed by another alpha-numeric character.
- * @haystack: The string to search in.
- * @needle: The substring to find.
+ * @param haystack The string to search in. + * @param needle The substring to find. - * Returns: TRUE if haystack has the word, otherwise FALSE
+ * @return TRUE if haystack has the word, otherwise FALSE gboolean purple_utf8_has_word(const char *haystack, const char *needle);
@@ -1360,18 +1360,18 @@
* tries to convert the UTF-8 message to user's locale. If this
* is not possible, the original UTF-8 text will be printed.
- * @filestream: The file stream (e.g. STDOUT or STDERR)
- * @message: The message to print.
+ * @param filestream The file stream (e.g. STDOUT or STDERR) + * @param message The message to print. void purple_print_utf8_to_console(FILE *filestream, char *message);
* Checks for messages starting (post-HTML) with "/me ", including the space.
- * @message: The message to check
- * @len: The message length, or -1
+ * @param message The message to check + * @param len The message length, or -1 - * Returns: TRUE if it starts with "/me ", and it has been removed, otherwise
+ * @return TRUE if it starts with "/me ", and it has been removed, otherwise gboolean purple_message_meify(char *message, gssize len);
@@ -1380,9 +1380,9 @@
* Removes the underscore characters from a string used identify the mnemonic
- * @in: The string to strip
+ * @param in The string to strip - * Returns: The stripped string
+ * @return The stripped string char *purple_text_strip_mnemonic(const char *in);
@@ -1395,7 +1395,7 @@
* @param x The number to add 8 to.
#define purple_add_eight(x) ((x)+8)
@@ -1404,27 +1404,27 @@
* This will change hex codes and such to their ascii equivalents.
- * @str: The string to translate.
+ * @param str The string to translate. - * Returns: The resulting string.
+ * @return The resulting string. const char *purple_unescape_filename(const char *str);
* Escapes filesystem-unfriendly characters from a filename
- * @str: The string to translate.
+ * @param str The string to translate. - * Returns: The resulting string.
+ * @return The resulting string. const char *purple_escape_filename(const char *str);
* Escapes javascript-unfriendly substrings from a string.
- * @str: The string to escape.
+ * @param str The string to escape. - * Returns: The javascript-safe string (must be g_free'd after use).
+ * @return The javascript-safe string (must be g_free'd after use). gchar * purple_escape_js(const gchar *str);
@@ -1439,14 +1439,14 @@
* Gets the host name of the machine. If it not possible to determine the
* host name, "localhost" is returned
- * Returns: The hostname
+ * @constreturn The hostname const gchar *purple_get_host_name(void);
* Returns a type 4 (random) UUID
- * Returns: A UUID, caller is responsible for freeing it
+ * @return A UUID, caller is responsible for freeing it gchar *purple_uuid_random(void);
@@ -1455,32 +1455,32 @@
* Function designed to be used as a GDestroyNotify callback.
- * @data: A pointer to variable, which should be set to NULL.
+ * @param data A pointer to variable, which should be set to NULL. void purple_callback_set_zero(gpointer data);
* Creates a new GValue of the specified type.
- * @type: The type of data to be held by the GValue
+ * @param type The type of data to be held by the GValue - * Returns: The created GValue
+ * @return The created GValue GValue *purple_value_new(GType type);
- * @value: The GValue to duplicate
+ * @param value The GValue to duplicate - * Returns: The duplicated GValue
+ * @return The duplicated GValue GValue *purple_value_dup(GValue *value);
- * @value: The GValue to free.
+ * @param value The GValue to free. void purple_value_free(GValue *value);
@@ -1489,14 +1489,14 @@
* See RFC 2617 for more information.
- * @algorithm: The hash algorithm to use
- * @username: The username provided by the user
- * @realm: The authentication realm provided by the server
- * @password: The password provided by the user
- * @nonce: The nonce provided by the server
- * @client_nonce: The nonce provided by the client
+ * @param algorithm The hash algorithm to use + * @param username The username provided by the user + * @param realm The authentication realm provided by the server + * @param password The password provided by the user + * @param nonce The nonce provided by the server + * @param client_nonce The nonce provided by the client - * Returns: The session key, or %NULL if an error occurred.
+ * @return The session key, or @c NULL if an error occurred. gchar *purple_http_digest_calculate_session_key(
const gchar *algorithm, const gchar *username,
@@ -1507,17 +1507,17 @@
* See RFC 2617 for more information.
- * @algorithm: The hash algorithm to use
- * @method: The HTTP method in use
- * @digest_uri: The URI from the initial request
- * @qop: The "quality of protection"
- * @entity: The entity body
- * @nonce: The nonce provided by the server
- * @nonce_count: The nonce count
- * @client_nonce: The nonce provided by the client
- * @session_key: The session key from purple_cipher_http_digest_calculate_session_key()
+ * @param algorithm The hash algorithm to use + * @param method The HTTP method in use + * @param digest_uri The URI from the initial request + * @param qop The "quality of protection" + * @param entity The entity body + * @param nonce The nonce provided by the server + * @param nonce_count The nonce count + * @param client_nonce The nonce provided by the client + * @param session_key The session key from purple_cipher_http_digest_calculate_session_key() - * Returns: The hashed response, or %NULL if an error occurred.
+ * @return The hashed response, or @c NULL if an error occurred. gchar *purple_http_digest_calculate_response(
const gchar *algorithm, const gchar *method,
--- a/libpurple/xfer.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/xfer.h Wed Jan 29 10:49:02 2014 +0530
@@ -91,11 +91,11 @@
* UI op to write data received from the protocol. The UI must deal with the
* entire buffer and return size, or it is treated as an error.
- * @xfer: The file transfer structure
- * @buffer: The buffer to write
- * @size: The size of the buffer
+ * @param xfer The file transfer structure + * @param buffer The buffer to write + * @param size The size of the buffer - * Returns: size if the write was successful, or a value between 0 and
+ * @return size if the write was successful, or a value between 0 and gssize (*ui_write)(PurpleXfer *xfer, const guchar *buffer, gssize size);
@@ -103,12 +103,12 @@
* UI op to read data to send to the protocol for a file transfer.
- * @xfer: The file transfer structure
- * @buffer: A pointer to a buffer. The UI must allocate this buffer.
+ * @param xfer The file transfer structure + * @param buffer A pointer to a buffer. The UI must allocate this buffer. * libpurple will free the data.
- * @size: The maximum amount of data to put in the buffer.
+ * @param size The maximum amount of data to put in the buffer. - * Returns:s The amount of data in the buffer, 0 if nothing is available,
+ * @returns The amount of data in the buffer, 0 if nothing is available, * and a negative value if an error occurred and the transfer
* should be cancelled (libpurple will cancel).
@@ -120,16 +120,16 @@
* This MUST be implemented if read and write are implemented.
- * @xfer: The file transfer structure
- * @buffer: A pointer to the beginning of the unwritten data.
- * @size: The amount of unwritten data.
+ * @param xfer The file transfer structure + * @param buffer A pointer to the beginning of the unwritten data. + * @param size The amount of unwritten data. void (*data_not_sent)(PurpleXfer *xfer, const guchar *buffer, gsize size);
* Op to create a thumbnail image for a file transfer
- * @xfer: The file transfer structure
+ * @param xfer The file transfer structure void (*add_thumbnail)(PurpleXfer *xfer, const gchar *formats);
@@ -175,11 +175,11 @@
* Creates a new file transfer handle.
* This is called by protocols.
- * @account: The account sending or receiving the file.
- * @type: The type of file transfer.
- * @who: The name of the remote user.
+ * @param account The account sending or receiving the file. + * @param type The type of file transfer. + * @param who The name of the remote user. - * Returns: A file transfer handle.
+ * @return A file transfer handle. PurpleXfer *purple_xfer_new(PurpleAccount *account,
PurpleXferType type, const char *who);
@@ -191,147 +191,147 @@
* to accept the file transfer. In this case protocol must call this function
* again once the filename is available.
- * @xfer: The file transfer to request confirmation on.
+ * @param xfer The file transfer to request confirmation on. void purple_xfer_request(PurpleXfer *xfer);
* Called if the user accepts the file transfer request.
- * @xfer: The file transfer.
- * @filename: The filename.
+ * @param xfer The file transfer. + * @param filename The filename. void purple_xfer_request_accepted(PurpleXfer *xfer, const char *filename);
* Called if the user rejects the file transfer request.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. void purple_xfer_request_denied(PurpleXfer *xfer);
* Returns the socket file descriptor.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The socket file descriptor.
+ * @return The socket file descriptor. int purple_xfer_get_fd(PurpleXfer *xfer);
* Returns the Watcher for the transfer.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The watcher.
int purple_xfer_get_watcher(PurpleXfer *xfer);
* Returns the type of file transfer.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The type of the file transfer.
+ * @return The type of the file transfer. PurpleXferType purple_xfer_get_xfer_type(const PurpleXfer *xfer);
* Returns the account the file transfer is using.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The account.
PurpleAccount *purple_xfer_get_account(const PurpleXfer *xfer);
* Sets the name of the remote user.
- * @xfer: The file transfer.
- * @who: The name of the remote user.
+ * @param xfer The file transfer. + * @param who The name of the remote user. void purple_xfer_set_remote_user(PurpleXfer *xfer, const char *who);
* Returns the name of the remote user.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The name of the remote user.
+ * @return The name of the remote user. const char *purple_xfer_get_remote_user(const PurpleXfer *xfer);
* Returns the status of the xfer.
- * @xfer: The file transfer.
+ * @param xfer The file transfer.
PurpleXferStatus purple_xfer_get_status(const PurpleXfer *xfer);
* Returns true if the file transfer was cancelled.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: Whether or not the transfer was cancelled.
+ * @return Whether or not the transfer was cancelled. gboolean purple_xfer_is_cancelled(const PurpleXfer *xfer);
* Returns the completed state for a file transfer.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The completed state.
+ * @return The completed state. gboolean purple_xfer_is_completed(const PurpleXfer *xfer);
* Returns the name of the file being sent or received.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The filename.
+ * @return The filename. const char *purple_xfer_get_filename(const PurpleXfer *xfer);
* Returns the file's destination filename,
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The destination filename.
+ * @return The destination filename. const char *purple_xfer_get_local_filename(const PurpleXfer *xfer);
* Returns the number of bytes sent (or received) so far.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The number of bytes sent.
+ * @return The number of bytes sent. goffset purple_xfer_get_bytes_sent(const PurpleXfer *xfer);
* Returns the number of bytes remaining to send or receive.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The number of bytes remaining.
+ * @return The number of bytes remaining. goffset purple_xfer_get_bytes_remaining(const PurpleXfer *xfer);
* Returns the size of the file being sent or received.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The total size of the file.
+ * @return The total size of the file. goffset purple_xfer_get_size(const PurpleXfer *xfer);
@@ -340,135 +340,135 @@
* This is a number between 0 (0%) and 1 (100%).
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The percentage complete.
+ * @return The percentage complete. double purple_xfer_get_progress(const PurpleXfer *xfer);
* Returns the local port number in the file transfer.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The port number on this end.
+ * @return The port number on this end. guint16 purple_xfer_get_local_port(const PurpleXfer *xfer);
* Returns the remote IP address in the file transfer.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The IP address on the other end.
+ * @return The IP address on the other end. const char *purple_xfer_get_remote_ip(const PurpleXfer *xfer);
* Returns the remote port number in the file transfer.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The port number on the other end.
+ * @return The port number on the other end. guint16 purple_xfer_get_remote_port(const PurpleXfer *xfer);
* Returns the time the transfer of a file started.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The time when the transfer started.
+ * @return The time when the transfer started. time_t purple_xfer_get_start_time(const PurpleXfer *xfer);
* Returns the time the transfer of a file ended.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The time when the transfer ended.
+ * @return The time when the transfer ended. time_t purple_xfer_get_end_time(const PurpleXfer *xfer);
* Sets the socket file descriptor.
- * @xfer: The file transfer.
- * @fd: The file descriptor.
+ * @param xfer The file transfer. + * @param fd The file descriptor. void purple_xfer_set_fd(PurpleXfer *xfer, int fd);
* Sets the watcher for the file transfer.
- * @xfer: The file transfer.
- * @watcher: The watcher.
+ * @param xfer The file transfer. + * @param watcher The watcher. void purple_xfer_set_watcher(PurpleXfer *xfer, int watcher);
* Sets the completed state for the file transfer.
- * @xfer: The file transfer.
- * @completed: The completed state.
+ * @param xfer The file transfer. + * @param completed The completed state. void purple_xfer_set_completed(PurpleXfer *xfer, gboolean completed);
* Sets the current status for the file transfer.
- * @xfer: The file transfer.
- * @status: The current status.
+ * @param xfer The file transfer. + * @param status The current status. void purple_xfer_set_status(PurpleXfer *xfer, PurpleXferStatus status);
* Sets the message for the file transfer.
- * @xfer: The file transfer.
- * @message: The message.
+ * @param xfer The file transfer. + * @param message The message. void purple_xfer_set_message(PurpleXfer *xfer, const char *message);
* Returns the message for the file transfer.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The message.
const char *purple_xfer_get_message(const PurpleXfer *xfer);
* Sets the filename for the file transfer.
- * @xfer: The file transfer.
- * @filename: The filename.
+ * @param xfer The file transfer. + * @param filename The filename. void purple_xfer_set_filename(PurpleXfer *xfer, const char *filename);
* Sets the local filename for the file transfer.
- * @xfer: The file transfer.
- * @filename: The filename
+ * @param xfer The file transfer. + * @param filename The filename void purple_xfer_set_local_filename(PurpleXfer *xfer, const char *filename);
* Sets the size of the file in a file transfer.
- * @xfer: The file transfer.
- * @size: The size of the file.
+ * @param xfer The file transfer. + * @param size The size of the file. void purple_xfer_set_size(PurpleXfer *xfer, goffset size);
* Sets the local port of the file transfer.
- * @xfer: The file transfer.
- * @local_port: The local port.
+ * @param xfer The file transfer. + * @param local_port The local port. void purple_xfer_set_local_port(PurpleXfer *xfer, guint16 local_port);
@@ -479,8 +479,8 @@
* It's used for pausing and resuming an oscar file transfer.
- * @xfer: The file transfer.
- * @bytes_sent: The new current position in the file. If we're
+ * @param xfer The file transfer. + * @param bytes_sent The new current position in the file. If we're * sending a file then this is the byte that we will
* send. If we're receiving a file, this is the
* next byte that we expect to receive.
@@ -490,17 +490,17 @@
* Returns the UI operations structure for a file transfer.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The UI operations structure.
+ * @return The UI operations structure. PurpleXferUiOps *purple_xfer_get_ui_ops(const PurpleXfer *xfer);
* Sets the read function for the file transfer.
- * @xfer: The file transfer.
- * @fnc: The read function.
+ * @param xfer The file transfer. + * @param fnc The read function. void purple_xfer_set_read_fnc(PurpleXfer *xfer,
gssize (*fnc)(guchar **, size_t, PurpleXfer *));
@@ -508,8 +508,8 @@
* Sets the write function for the file transfer.
- * @xfer: The file transfer.
- * @fnc: The write function.
+ * @param xfer The file transfer. + * @param fnc The write function. void purple_xfer_set_write_fnc(PurpleXfer *xfer,
gssize (*fnc)(const guchar *, size_t, PurpleXfer *));
@@ -517,8 +517,8 @@
* Sets the acknowledge function for the file transfer.
- * @xfer: The file transfer.
- * @fnc: The acknowledge function.
+ * @param xfer The file transfer. + * @param fnc The acknowledge function. void purple_xfer_set_ack_fnc(PurpleXfer *xfer,
void (*fnc)(PurpleXfer *, const guchar *, size_t));
@@ -526,8 +526,8 @@
* Sets the function to be called if the request is denied.
- * @xfer: The file transfer.
- * @fnc: The request denied protocol callback.
+ * @param xfer The file transfer. + * @param fnc The request denied protocol callback. void purple_xfer_set_request_denied_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
@@ -538,72 +538,72 @@
* the necessary parameters. This will be called if the file transfer
* is accepted by the user.
- * @xfer: The file transfer.
- * @fnc: The transfer initialization function.
+ * @param xfer The file transfer. + * @param fnc The transfer initialization function. void purple_xfer_set_init_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
* Sets the start transfer function for the file transfer.
- * @xfer: The file transfer.
- * @fnc: The start transfer function.
+ * @param xfer The file transfer. + * @param fnc The start transfer function. void purple_xfer_set_start_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
* Sets the end transfer function for the file transfer.
- * @xfer: The file transfer.
- * @fnc: The end transfer function.
+ * @param xfer The file transfer. + * @param fnc The end transfer function. void purple_xfer_set_end_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
* Sets the cancel send function for the file transfer.
- * @xfer: The file transfer.
- * @fnc: The cancel send function.
+ * @param xfer The file transfer. + * @param fnc The cancel send function. void purple_xfer_set_cancel_send_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
* Sets the cancel receive function for the file transfer.
- * @xfer: The file transfer.
- * @fnc: The cancel receive function.
+ * @param xfer The file transfer. + * @param fnc The cancel receive function. void purple_xfer_set_cancel_recv_fnc(PurpleXfer *xfer, void (*fnc)(PurpleXfer *));
* Reads in data from a file transfer stream.
- * @xfer: The file transfer.
- * @buffer: The buffer that will be created to contain the data.
+ * @param xfer The file transfer. + * @param buffer The buffer that will be created to contain the data. - * Returns: The number of bytes read, or -1.
+ * @return The number of bytes read, or -1. gssize purple_xfer_read(PurpleXfer *xfer, guchar **buffer);
* Writes data to a file transfer stream.
- * @xfer: The file transfer.
- * @buffer: The buffer to read the data from.
- * @size: The number of bytes to write.
+ * @param xfer The file transfer. + * @param buffer The buffer to read the data from. + * @param size The number of bytes to write. - * Returns: The number of bytes written, or -1.
+ * @return The number of bytes written, or -1. gssize purple_xfer_write(PurpleXfer *xfer, const guchar *buffer, gsize size);
* Writes chunk of received file.
- * @xfer: The file transfer.
- * @buffer: The buffer to read the data from.
- * @size: The number of bytes to write.
+ * @param xfer The file transfer. + * @param buffer The buffer to read the data from. + * @param size The number of bytes to write. - * Returns: TRUE on success, FALSE otherwise.
+ * @return TRUE on success, FALSE otherwise. purple_xfer_write_file(PurpleXfer *xfer, const guchar *buffer, gsize size);
@@ -611,11 +611,11 @@
* Writes chunk of file being sent.
- * @xfer: The file transfer.
- * @buffer: The buffer to write the data to.
- * @size: The size of buffer.
+ * @param xfer The file transfer. + * @param buffer The buffer to write the data to. + * @param size The size of buffer. - * Returns: Number of bytes written (0 means, the device is busy), or -1 on
+ * @return Number of bytes written (0 means, the device is busy), or -1 on @@ -631,17 +631,17 @@
* Passing @a fd as '-1' is a special-case and indicates to the
* protocol to facilitate the file transfer itself.
- * @xfer: The file transfer.
- * @fd: The file descriptor for the socket.
- * @ip: The IP address to connect to.
- * @port: The port to connect to.
+ * @param xfer The file transfer. + * @param fd The file descriptor for the socket. + * @param ip The IP address to connect to. + * @param port The port to connect to. void purple_xfer_start(PurpleXfer *xfer, int fd, const char *ip, guint16 port);
- * @xfer: The file transfer.
+ * @param xfer The file transfer. void purple_xfer_end(PurpleXfer *xfer);
@@ -649,21 +649,21 @@
* Adds a new file transfer to the list of file transfers. Call this only
* if you are not using purple_xfer_start.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. void purple_xfer_add(PurpleXfer *xfer);
* Cancels a file transfer on the local end.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. void purple_xfer_cancel_local(PurpleXfer *xfer);
* Cancels a file transfer from the remote end.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. void purple_xfer_cancel_remote(PurpleXfer *xfer);
@@ -674,17 +674,17 @@
* specifies a title ("File transfer to <i>user</i> failed" or
* "File Transfer from <i>user</i> failed").
- * @type: The type of file transfer.
- * @account: The account sending or receiving the file.
- * @who: The user on the other end of the transfer.
- * @msg: The message to display.
+ * @param type The type of file transfer. + * @param account The account sending or receiving the file. + * @param who The user on the other end of the transfer. + * @param msg The message to display. void purple_xfer_error(PurpleXferType type, PurpleAccount *account, const char *who, const char *msg);
* Updates file transfer progress.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. void purple_xfer_update_progress(PurpleXfer *xfer);
@@ -693,9 +693,9 @@
* This is a wrapper around purple_conversation_write
- * @xfer: The file transfer to which this message relates.
- * @message: The message to display.
- * @is_error: Is this an error message?.
+ * @param xfer The file transfer to which this message relates. + * @param message The message to display. + * @param is_error Is this an error message?. void purple_xfer_conversation_write(PurpleXfer *xfer, const gchar *message, gboolean is_error);
@@ -704,7 +704,7 @@
* the direction of the file transfer. Used when the UI is providing
* read/write/data_not_sent UI ops.
- * @xfer: The file transfer which is ready.
+ * @param xfer The file transfer which is ready. void purple_xfer_ui_ready(PurpleXfer *xfer);
@@ -713,25 +713,25 @@
* the direction of the file transfer. Used when the protocol provides read/write
* ops and cannot/does not provide a raw fd to the core.
- * @xfer: The file transfer which is ready.
+ * @param xfer The file transfer which is ready. void purple_xfer_protocol_ready(PurpleXfer *xfer);
* Gets the thumbnail data for a transfer
- * @xfer: The file transfer to get the thumbnail for
- * @len: If not %NULL, the length of the thumbnail data returned
+ * @param xfer The file transfer to get the thumbnail for + * @param len If not @c NULL, the length of the thumbnail data returned * will be set in the location pointed to by this.
- * Returns: The thumbnail data, or NULL if there is no thumbnail
+ * @return The thumbnail data, or NULL if there is no thumbnail gconstpointer purple_xfer_get_thumbnail(const PurpleXfer *xfer, gsize *len);
* Gets the mimetype of the thumbnail preview for a transfer
- * @xfer: The file transfer to get the mimetype for
- * Returns: The mimetype of the thumbnail, or %NULL if not thumbnail is set
+ * @param xfer The file transfer to get the mimetype for + * @return The mimetype of the thumbnail, or @c NULL if not thumbnail is set const gchar *purple_xfer_get_thumbnail_mimetype(const PurpleXfer *xfer);
@@ -739,10 +739,10 @@
* Sets the thumbnail data for a transfer
- * @xfer: The file transfer to set the data for
- * @thumbnail: A pointer to the thumbnail data, this will be copied
- * @size: The size in bytes of the passed in thumbnail data
- * @mimetype: The mimetype of the generated thumbnail
+ * @param xfer The file transfer to set the data for + * @param thumbnail A pointer to the thumbnail data, this will be copied + * @param size The size in bytes of the passed in thumbnail data + * @param mimetype The mimetype of the generated thumbnail void purple_xfer_set_thumbnail(PurpleXfer *xfer, gconstpointer thumbnail,
gsize size, const gchar *mimetype);
@@ -751,8 +751,8 @@
* Prepare a thumbnail for a transfer (if the UI supports it)
* will be no-op in case the UI doesn't implement thumbnail creation
- * @xfer: The file transfer to create a thumbnail for
- * @formats: A comma-separated list of mimetypes for image formats
+ * @param xfer The file transfer to create a thumbnail for + * @param formats A comma-separated list of mimetypes for image formats * the protocols can use for thumbnails.
void purple_xfer_prepare_thumbnail(PurpleXfer *xfer, const gchar *formats);
@@ -760,34 +760,34 @@
* Sets the protocol data for a file transfer.
- * @xfer: The file transfer.
- * @proto_data: The protocol data to set for the file transfer.
+ * @param xfer The file transfer. + * @param proto_data The protocol data to set for the file transfer. void purple_xfer_set_protocol_data(PurpleXfer *xfer, gpointer proto_data);
* Gets the protocol data for a file transfer.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The protocol data for the file transfer.
+ * @return The protocol data for the file transfer. gpointer purple_xfer_get_protocol_data(const PurpleXfer *xfer);
* Set the UI data associated with this file transfer.
- * @xfer: The file transfer.
- * @ui_data: A pointer to associate with this file transfer.
+ * @param xfer The file transfer. + * @param ui_data A pointer to associate with this file transfer. void purple_xfer_set_ui_data(PurpleXfer *xfer, gpointer ui_data);
* Get the UI data associated with this file transfer.
- * @xfer: The file transfer.
+ * @param xfer The file transfer. - * Returns: The UI data associated with this file transfer. This is a
+ * @return The UI data associated with this file transfer. This is a * convenience field provided to the UIs--it is not
* used by the libpurple core.
@@ -803,14 +803,14 @@
- * Returns: all current xfers with refs
+ * @return all current xfers with refs GList *purple_xfers_get_all(void);
* Returns the handle to the file transfer subsystem
void *purple_xfers_get_handle(void);
@@ -827,14 +827,14 @@
* Sets the UI operations structure to be used in all purple file transfers.
- * @ops: The UI operations structure.
+ * @param ops The UI operations structure. void purple_xfers_set_ui_ops(PurpleXferUiOps *ops);
* Returns the UI operations structure to be used in all purple file transfers.
- * Returns: The UI operations structure.
+ * @return The UI operations structure. PurpleXferUiOps *purple_xfers_get_ui_ops(void);
--- a/libpurple/xmlnode.h Wed Jan 29 10:10:12 2014 +0530
+++ b/libpurple/xmlnode.h Wed Jan 29 10:49:02 2014 +0530
@@ -52,10 +52,10 @@
PurpleXmlNodeType type; /**< The type of the node. */
char *data; /**< The data for the node. */
size_t data_sz; /**< The size of the data. */
- PurpleXmlNode *parent; /**< The parent node or %NULL.*/
- PurpleXmlNode *child; /**< The child node or %NULL.*/
- PurpleXmlNode *lastchild; /**< The last child node or %NULL.*/
- PurpleXmlNode *next; /**< The next node or %NULL. */
+ PurpleXmlNode *parent; /**< The parent node or @c NULL.*/ + PurpleXmlNode *child; /**< The child node or @c NULL.*/ + PurpleXmlNode *lastchild; /**< The last child node or @c NULL.*/ + PurpleXmlNode *next; /**< The next node or @c NULL. */ char *prefix; /**< The namespace prefix if any. */
GHashTable *namespace_map; /**< The namespace map. */
@@ -70,66 +70,66 @@
* Creates a new PurpleXmlNode.
- * @name: The name of the node.
+ * @param name The name of the node. - * Returns: The new node.
+ * @return The new node. PurpleXmlNode *purple_xmlnode_new(const char *name);
* Creates a new PurpleXmlNode child.
- * @parent: The parent node.
- * @name: The name of the child node.
+ * @param parent The parent node. + * @param name The name of the child node. - * Returns: The new child node.
+ * @return The new child node. PurpleXmlNode *purple_xmlnode_new_child(PurpleXmlNode *parent, const char *name);
* Inserts a node into a node as a child.
- * @parent: The parent node to insert child into.
- * @child: The child node to insert into parent.
+ * @param parent The parent node to insert child into. + * @param child The child node to insert into parent. void purple_xmlnode_insert_child(PurpleXmlNode *parent, PurpleXmlNode *child);
* Gets a child node named name.
- * @parent: The parent node.
- * @name: The child's name.
+ * @param parent The parent node. + * @param name The child's name. - * Returns: The child or NULL.
+ * @return The child or NULL. PurpleXmlNode *purple_xmlnode_get_child(const PurpleXmlNode *parent, const char *name);
* Gets a child node named name in a namespace.
- * @parent: The parent node.
- * @name: The child's name.
- * @xmlns: The namespace.
+ * @param parent The parent node. + * @param name The child's name. + * @param xmlns The namespace. - * Returns: The child or NULL.
+ * @return The child or NULL. PurpleXmlNode *purple_xmlnode_get_child_with_namespace(const PurpleXmlNode *parent, const char *name, const char *xmlns);
* Gets the next node with the same name as node.
- * @node: The node of a twin to find.
+ * @param node The node of a twin to find. - * Returns: The twin of node or NULL.
+ * @return The twin of node or NULL. PurpleXmlNode *purple_xmlnode_get_next_twin(PurpleXmlNode *node);
* Inserts data into a node.
- * @node: The node to insert data into.
- * @data: The data to insert.
- * @size: The size of the data to insert. If data is
+ * @param node The node to insert data into. + * @param data The data to insert. + * @param size The size of the data to insert. If data is * null-terminated you can pass in -1.
void purple_xmlnode_insert_data(PurpleXmlNode *node, const char *data, gssize size);
@@ -137,9 +137,9 @@
* Gets (escaped) data from a node.
- * @node: The node to get data from.
+ * @param node The node to get data from. - * Returns: The data from the node or NULL. This data is in raw escaped format.
+ * @return The data from the node or NULL. This data is in raw escaped format. * You must g_free this string when finished using it.
char *purple_xmlnode_get_data(const PurpleXmlNode *node);
@@ -147,9 +147,9 @@
* Gets unescaped data from a node.
- * @node: The node to get data from.
+ * @param node The node to get data from. - * Returns: The data from the node, in unescaped form. You must g_free
+ * @return The data from the node, in unescaped form. You must g_free * this string when finished using it.
char *purple_xmlnode_get_data_unescaped(const PurpleXmlNode *node);
@@ -157,20 +157,20 @@
* Sets an attribute for a node.
- * @node: The node to set an attribute for.
- * @attr: The name of the attribute.
- * @value: The value of the attribute.
+ * @param node The node to set an attribute for. + * @param attr The name of the attribute. + * @param value The value of the attribute. void purple_xmlnode_set_attrib(PurpleXmlNode *node, const char *attr, const char *value);
* Sets a namespaced attribute for a node
- * @node: The node to set an attribute for.
- * @attr: The name of the attribute to set
- * @xmlns: The namespace of the attribute to set
- * @prefix: The prefix of the attribute to set
- * @value: The value of the attribute
+ * @param node The node to set an attribute for. + * @param attr The name of the attribute to set + * @param xmlns The namespace of the attribute to set + * @param prefix The prefix of the attribute to set + * @param value The value of the attribute void purple_xmlnode_set_attrib_full(PurpleXmlNode *node, const char *attr, const char *xmlns,
const char *prefix, const char *value);
@@ -178,54 +178,54 @@
* Gets an attribute from a node.
- * @node: The node to get an attribute from.
- * @attr: The attribute to get.
+ * @param node The node to get an attribute from. + * @param attr The attribute to get. - * Returns: The value of the attribute.
+ * @return The value of the attribute. const char *purple_xmlnode_get_attrib(const PurpleXmlNode *node, const char *attr);
* Gets a namespaced attribute from a node
- * @node: The node to get an attribute from.
- * @attr: The attribute to get
- * @xmlns: The namespace of the attribute to get
+ * @param node The node to get an attribute from. + * @param attr The attribute to get + * @param xmlns The namespace of the attribute to get - * Returns: The value of the attribute/
+ * @return The value of the attribute/ const char *purple_xmlnode_get_attrib_with_namespace(const PurpleXmlNode *node, const char *attr, const char *xmlns);
* Removes an attribute from a node.
- * @node: The node to remove an attribute from.
- * @attr: The attribute to remove.
+ * @param node The node to remove an attribute from. + * @param attr The attribute to remove. void purple_xmlnode_remove_attrib(PurpleXmlNode *node, const char *attr);
* Removes a namespaced attribute from a node
- * @node: The node to remove an attribute from
- * @attr: The attribute to remove
- * @xmlns: The namespace of the attribute to remove
+ * @param node The node to remove an attribute from + * @param attr The attribute to remove + * @param xmlns The namespace of the attribute to remove void purple_xmlnode_remove_attrib_with_namespace(PurpleXmlNode *node, const char *attr, const char *xmlns);
* Sets the namespace of a node
- * @node: The node to qualify
- * @xmlns: The namespace of the node
+ * @param node The node to qualify + * @param xmlns The namespace of the node void purple_xmlnode_set_namespace(PurpleXmlNode *node, const char *xmlns);
* Returns the namespace of a node
- * @node: The node to get the namepsace from
- * Returns: The namespace of this node
+ * @param node The node to get the namepsace from + * @return The namespace of this node const char *purple_xmlnode_get_namespace(const PurpleXmlNode *node);
@@ -245,33 +245,33 @@
* The default namespace of all nodes (including 'child1') is "jabber:client",
* though the namespace for 'element' is "http://example.org/ns1".
- * @node: The node for which to return the default namespace
- * Returns: The default namespace of this node
+ * @param node The node for which to return the default namespace + * @return The default namespace of this node const char *purple_xmlnode_get_default_namespace(const PurpleXmlNode *node);
* Returns the defined namespace for a prefix.
- * @node: The node from which to start the search.
- * @prefix: The prefix for which to return the associated namespace.
- * Returns: The namespace for this prefix.
+ * @param node The node from which to start the search. + * @param prefix The prefix for which to return the associated namespace. + * @return The namespace for this prefix. const char *purple_xmlnode_get_prefix_namespace(const PurpleXmlNode *node, const char *prefix);
* Sets the prefix of a node
- * @node: The node to qualify
- * @prefix: The prefix of the node
+ * @param node The node to qualify + * @param prefix The prefix of the node void purple_xmlnode_set_prefix(PurpleXmlNode *node, const char *prefix);
* Returns the prefix of a node
- * @node: The node to get the prefix from
- * Returns: The prefix of this node
+ * @param node The node to get the prefix from + * @return The prefix of this node const char *purple_xmlnode_get_prefix(const PurpleXmlNode *node);
@@ -284,26 +284,26 @@
* break some applications (SOAP / XPath apparently often rely on
* the prefixes having the same name.
- * @node: The node from which to strip prefixes
+ * @param node The node from which to strip prefixes void purple_xmlnode_strip_prefixes(PurpleXmlNode *node);
- * @child: The child node.
+ * @param child The child node. - * Returns: The parent or NULL.
+ * @return The parent or NULL. PurpleXmlNode *purple_xmlnode_get_parent(const PurpleXmlNode *child);
* Returns the node in a string of xml.
- * @node: The starting node to output.
- * @len: Address for the size of the string.
+ * @param node The starting node to output. + * @param len Address for the size of the string. - * Returns: The node represented as a string. You must
+ * @return The node represented as a string. You must * g_free this string when finished using it.
char *purple_xmlnode_to_str(const PurpleXmlNode *node, int *len);
@@ -311,10 +311,10 @@
* Returns the node in a string of human readable xml.
- * @node: The starting node to output.
- * @len: Address for the size of the string.
+ * @param node The starting node to output. + * @param len Address for the size of the string. - * Returns: The node as human readable string including
+ * @return The node as human readable string including * tab and new line characters. You must
* g_free this string when finished using it.
@@ -325,27 +325,27 @@
* root node of an XML document will parse the entire document
* into a tree of nodes, and return the PurpleXmlNode of the root.
- * @str: The string of xml.
- * @size: The size of the string, or -1 if @a str is
+ * @param str The string of xml. + * @param size The size of the string, or -1 if @a str is - * Returns: The new node.
+ * @return The new node. PurpleXmlNode *purple_xmlnode_from_str(const char *str, gssize size);
* Creates a new node from the source node.
- * @src: The node to copy.
+ * @param src The node to copy. - * Returns: A new copy of the src node.
+ * @return A new copy of the src node. PurpleXmlNode *purple_xmlnode_copy(const PurpleXmlNode *src);
* Frees a node and all of its children.
- * @node: The node to free.
+ * @param node The node to free. void purple_xmlnode_free(PurpleXmlNode *node);
@@ -354,14 +354,14 @@
* root node of an XML document will parse the entire document
* into a tree of nodes, and return the PurpleXmlNode of the root.
- * @dir: The directory where the file is located
- * @filename: The filename
- * @description: A description of the file being parsed. Displayed to
+ * @param dir The directory where the file is located + * @param filename The filename + * @param description A description of the file being parsed. Displayed to * the user if the file cannot be read.
- * @process: The subsystem that is calling purple_xmlnode_from_file. Used as
+ * @param process The subsystem that is calling purple_xmlnode_from_file. Used as * the category for debugging.
- * Returns: The new node or NULL if an error occurred.
+ * @return The new node or NULL if an error occurred. PurpleXmlNode *purple_xmlnode_from_file(const char *dir, const char *filename,
const char *description, const char *process);
--- a/pidgin/gtkblist-theme.h Wed Jan 29 10:10:12 2014 +0530
+++ b/pidgin/gtkblist-theme.h Wed Jan 29 10:49:02 2014 +0530
@@ -88,60 +88,60 @@
* Create a new PidginThemeFont.
- * @color: The color of the font
+ * @param face The font face + * @param color The color of the font - * Returns: A newly created PidginThemeFont
+ * @return A newly created PidginThemeFont PidginThemeFont * pidgin_theme_font_new(const gchar *face, GdkColor *color);
* Frees a font and color pair
- * @font: The theme font
+ * @param font The theme font void pidgin_theme_font_free(PidginThemeFont *font);
* Set the font-face of a PidginThemeFont.
- * @font: The PidginThemeFont
+ * @param font The PidginThemeFont + * @param face The font-face void pidgin_theme_font_set_font_face(PidginThemeFont *font, const gchar *face);
* Set the color of a PidginThemeFont.
- * @font: The PidginThemeFont
+ * @param font The PidginThemeFont + * @param color The color void pidgin_theme_font_set_color(PidginThemeFont *font, const GdkColor *color);
* Get the font-face of a PidginThemeFont.
- * @font: The PidginThemeFont
+ * @param font The PidginThemeFont - * Returns: The font-face, or NULL if none is set.
+ * @return The font-face, or NULL if none is set. const gchar * pidgin_theme_font_get_font_face(PidginThemeFont *font);
* Get the color of a PidginThemeFont as a GdkColor object.
- * @font: The PidginThemeFont
+ * @param font The PidginThemeFont - * Returns: The color, or NULL if none is set.
+ * @return The color, or NULL if none is set. const GdkColor * pidgin_theme_font_get_color(PidginThemeFont *font);
* Get the color of a PidginThemeFont.
- * @font: The PidginThemeFont
+ * @param font The PidginThemeFont - * Returns: The color, or NULL if none is set.
+ * @return The color, or NULL if none is set. const gchar * pidgin_theme_font_get_color_describe(PidginThemeFont *font);
@@ -160,9 +160,9 @@
* Returns the background color of the buddy list.
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s A gdk color.
+ * @returns A gdk color. GdkColor *pidgin_blist_theme_get_background_color(PidginBlistTheme *theme);
@@ -170,117 +170,117 @@
* Returns the opacity of the buddy list window
* (0.0 or clear to 1.0 fully opaque).
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s The opacity
gdouble pidgin_blist_theme_get_opacity(PidginBlistTheme *theme);
* Returns the layout to be used with the buddy list.
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s The buddy list layout.
+ * @returns The buddy list layout. PidginBlistLayout *pidgin_blist_theme_get_layout(PidginBlistTheme *theme);
* Returns the background color to be used with expanded groups.
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s A gdk color.
+ * @returns A gdk color. GdkColor *pidgin_blist_theme_get_expanded_background_color(PidginBlistTheme *theme);
* Returns the text font and color to be used with expanded groups.
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s A font and color pair.
+ * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_expanded_text_info(PidginBlistTheme *theme);
* Returns the background color to be used with collapsed groups.
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s A gdk color.
+ * @returns A gdk color. GdkColor *pidgin_blist_theme_get_collapsed_background_color(PidginBlistTheme *theme);
* Returns the text font and color to be used with collapsed groups.
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s A font and color pair.
+ * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_collapsed_text_info(PidginBlistTheme *theme);
* Returns the colors to be used for contacts and chats.
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s A gdkcolor for contacts and chats.
+ * @returns A gdkcolor for contacts and chats. GdkColor *pidgin_blist_theme_get_contact_color(PidginBlistTheme *theme);
* Returns the text font and color to be used for expanded contacts.
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s A font and color pair.
+ * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_contact_text_info(PidginBlistTheme *theme);
* Returns the text font and color to be used for online buddies.
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s A font and color pair.
+ * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_online_text_info(PidginBlistTheme *theme);
* Returns the text font and color to be used for away and idle buddies.
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s A font and color pair.
+ * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_away_text_info(PidginBlistTheme *theme);
* Returns the text font and color to be used for offline buddies.
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s A font and color pair.
+ * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_offline_text_info(PidginBlistTheme *theme);
* Returns the text font and color to be used for idle buddies.
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s A font and color pair.
+ * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_idle_text_info(PidginBlistTheme *theme);
* Returns the text font and color to be used for buddies with unread messages.
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s A font and color pair.
+ * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_unread_message_text_info(PidginBlistTheme *theme);
@@ -288,18 +288,18 @@
* Returns the text font and color to be used for chats with unread messages
* that mention your nick.
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s A font and color pair.
+ * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_unread_message_nick_said_text_info(PidginBlistTheme *theme);
* Returns the text font and color to be used for a buddy's status message.
- * @theme: The PidginBlist theme.
+ * @param theme The PidginBlist theme. - * Returns:s A font and color pair.
+ * @returns A font and color pair. PidginThemeFont *pidgin_blist_theme_get_status_text_info(PidginBlistTheme *theme);
@@ -308,112 +308,112 @@
* Sets the background color to be used for this buddy list theme.
- * @theme: The PidginBlist theme.
- * @color: The new background color.
+ * @param theme The PidginBlist theme. + * @param color The new background color. void pidgin_blist_theme_set_background_color(PidginBlistTheme *theme, const GdkColor *color);
* Sets the opacity to be used for this buddy list theme.
- * @theme: The PidginBlist theme.
- * @opacity: The new opacity setting.
+ * @param theme The PidginBlist theme. + * @param opacity The new opacity setting. void pidgin_blist_theme_set_opacity(PidginBlistTheme *theme, gdouble opacity);
* Sets the buddy list layout to be used for this buddy list theme.
- * @theme: The PidginBlist theme.
- * @layout: The new layout.
+ * @param theme The PidginBlist theme. + * @param layout The new layout. void pidgin_blist_theme_set_layout(PidginBlistTheme *theme, const PidginBlistLayout *layout);
* Sets the background color to be used for expanded groups.
- * @theme: The PidginBlist theme.
- * @color: The new background color.
+ * @param theme The PidginBlist theme. + * @param color The new background color. void pidgin_blist_theme_set_expanded_background_color(PidginBlistTheme *theme, const GdkColor *color);
* Sets the text color and font to be used for expanded groups.
- * @theme: The PidginBlist theme.
- * @pair: The new text font and color pair.
+ * @param theme The PidginBlist theme. + * @param pair The new text font and color pair. void pidgin_blist_theme_set_expanded_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
* Sets the background color to be used for collapsed groups.
- * @theme: The PidginBlist theme.
- * @color: The new background color.
+ * @param theme The PidginBlist theme. + * @param color The new background color. void pidgin_blist_theme_set_collapsed_background_color(PidginBlistTheme *theme, const GdkColor *color);
* Sets the text color and font to be used for expanded groups.
- * @theme: The PidginBlist theme.
- * @pair: The new text font and color pair.
+ * @param theme The PidginBlist theme. + * @param pair The new text font and color pair. void pidgin_blist_theme_set_collapsed_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
* Sets the background color to be used for contacts and chats.
- * @theme: The PidginBlist theme.
- * @color: The color to use for contacts and chats.
+ * @param theme The PidginBlist theme. + * @param color The color to use for contacts and chats. void pidgin_blist_theme_set_contact_color(PidginBlistTheme *theme, const GdkColor *color);
* Sets the text color and font to be used for expanded contacts.
- * @theme: The PidginBlist theme.
- * @pair: The new text font and color pair.
+ * @param theme The PidginBlist theme. + * @param pair The new text font and color pair. void pidgin_blist_theme_set_contact_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
* Sets the text color and font to be used for online buddies.
- * @theme: The PidginBlist theme.
- * @pair: The new text font and color pair.
+ * @param theme The PidginBlist theme. + * @param pair The new text font and color pair. void pidgin_blist_theme_set_online_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
* Sets the text color and font to be used for away and idle buddies.
- * @theme: The PidginBlist theme.
- * @pair: The new text font and color pair.
+ * @param theme The PidginBlist theme. + * @param pair The new text font and color pair. void pidgin_blist_theme_set_away_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
* Sets the text color and font to be used for offline buddies.
- * @theme: The PidginBlist theme.
- * @pair: The new text font and color pair.
+ * @param theme The PidginBlist theme. + * @param pair The new text font and color pair. void pidgin_blist_theme_set_offline_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
* Sets the text color and font to be used for idle buddies.
- * @theme: The PidginBlist theme.
- * @pair: The new text font and color pair.
+ * @param theme The PidginBlist theme. + * @param pair The new text font and color pair. void pidgin_blist_theme_set_idle_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
* Sets the text color and font to be used for buddies with unread messages.
- * @theme: The PidginBlist theme.
- * @pair: The new text font and color pair.
+ * @param theme The PidginBlist theme. + * @param pair The new text font and color pair. void pidgin_blist_theme_set_unread_message_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
@@ -421,16 +421,16 @@
* Sets the text color and font to be used for a chat with unread messages
* that mention your nick.
- * @theme: The PidginBlist theme.
- * @pair: The new text font and color pair.
+ * @param theme The PidginBlist theme. + * @param pair The new text font and color pair. void pidgin_blist_theme_set_unread_message_nick_said_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
* Sets the text color and font to be used for buddy status messages.
- * @theme: The PidginBlist theme.
- * @pair: The new text font and color pair.
+ * @param theme The PidginBlist theme. + * @param pair The new text font and color pair. void pidgin_blist_theme_set_status_text_info(PidginBlistTheme *theme, const PidginThemeFont *pair);
--- a/pidgin/gtkimhtml.h Wed Jan 29 10:10:12 2014 +0530
+++ b/pidgin/gtkimhtml.h Wed Jan 29 10:49:02 2014 +0530
@@ -222,23 +222,23 @@
* Returns the GType object for an IM/HTML widget.
- * Returns: The GType for an IM/HTML widget.
+ * @return The GType for an IM/HTML widget. GType gtk_imhtml_get_type(void);
* Creates and returns a new GTK+ IM/HTML widget.
- * Returns: The GTK+ IM/HTML widget created.
+ * @return The GTK+ IM/HTML widget created. GtkWidget *gtk_imhtml_new(void *, void *);
* Returns the smiley object associated with the text.
- * @imhtml: The GTK+ IM/HTML.
- * @sml: The name of the smiley category.
- * @text: The text associated with the smiley.
+ * @param imhtml The GTK+ IM/HTML. + * @param sml The name of the smiley category. + * @param text The text associated with the smiley. GtkIMHtmlSmiley *gtk_imhtml_smiley_get(GtkIMHtml * imhtml,
@@ -248,23 +248,23 @@
* Associates a smiley with a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @sml: The name of the smiley category.
- * @smiley: The GtkIMSmiley to associate.
+ * @param imhtml The GTK+ IM/HTML. + * @param sml The name of the smiley category. + * @param smiley The GtkIMSmiley to associate. void gtk_imhtml_associate_smiley(GtkIMHtml *imhtml, const gchar *sml, GtkIMHtmlSmiley *smiley);
* Removes all smileys associated with a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. void gtk_imhtml_remove_smileys(GtkIMHtml *imhtml);
* Sets the function callbacks to use with a GTK+ IM/HTML instance.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. * @param f The GtkIMHTMLFuncs struct containing the functions to use.
void gtk_imhtml_set_funcs(GtkIMHtml *imhtml, GtkIMHtmlFuncs *f);
@@ -272,32 +272,32 @@
* Enables or disables showing the contents of HTML comments in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @show: %TRUE if comments should be shown, or %FALSE otherwise.
+ * @param imhtml The GTK+ IM/HTML. + * @param show @c TRUE if comments should be shown, or @c FALSE otherwise. void gtk_imhtml_show_comments(GtkIMHtml *imhtml, gboolean show);
* Gets the protocol name associated with this GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML
+ * @param imhtml The GTK+ IM/HTML const char *gtk_imhtml_get_protocol_name(GtkIMHtml *imhtml);
* Associates a protocol name with a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @protocol_name: The protocol name to associate with the IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. + * @param protocol_name The protocol name to associate with the IM/HTML. void gtk_imhtml_set_protocol_name(GtkIMHtml *imhtml, const gchar *protocol_name);
* Appends HTML formatted text to a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @text: The formatted text to append.
- * @options: A GtkIMHtmlOptions object indicating insert behavior.
+ * @param imhtml The GTK+ IM/HTML. + * @param text The formatted text to append. + * @param options A GtkIMHtmlOptions object indicating insert behavior. #define gtk_imhtml_append_text(imhtml, text, options) \
gtk_imhtml_append_text_with_images(imhtml, text, options, NULL)
@@ -305,10 +305,10 @@
* Appends HTML formatted text to a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @text: The formatted text to append.
- * @options: A GtkIMHtmlOptions object indicating insert behavior.
- * @unused: Use %NULL value.
+ * @param imhtml The GTK+ IM/HTML. + * @param text The formatted text to append. + * @param options A GtkIMHtmlOptions object indicating insert behavior. + * @param unused Use @c NULL value. void gtk_imhtml_append_text_with_images(GtkIMHtml *imhtml,
@@ -318,10 +318,10 @@
* Inserts HTML formatted text to a GTK+ IM/HTML at a given iter.
- * @imhtml: The GTK+ IM/HTML.
- * @text: The formatted text to append.
- * @options: A GtkIMHtmlOptions object indicating insert behavior.
- * @iter: A GtkTextIter in the GTK+ IM/HTML at which to insert text.
+ * @param imhtml The GTK+ IM/HTML. + * @param text The formatted text to append. + * @param options A GtkIMHtmlOptions object indicating insert behavior. + * @param iter A GtkTextIter in the GTK+ IM/HTML at which to insert text. void gtk_imhtml_insert_html_at_iter(GtkIMHtml *imhtml,
@@ -331,24 +331,24 @@
* Scrolls a GTK+ IM/HTML to the end of its contents.
- * @imhtml: The GTK+ IM/HTML.
- * @smooth: A boolean indicating if smooth scrolling should be used.
+ * @param imhtml The GTK+ IM/HTML. + * @param smooth A boolean indicating if smooth scrolling should be used. void gtk_imhtml_scroll_to_end(GtkIMHtml *imhtml, gboolean smooth);
* Delete the contents of a GTK+ IM/HTML between start and end.
- * @imhtml: The GTK+ IM/HTML.
- * @start: a postition in the imhtml's buffer
- * @end: another postition in the imhtml's buffer
+ * @param imhtml The GTK+ IM/HTML. + * @param start a postition in the imhtml's buffer + * @param end another postition in the imhtml's buffer void gtk_imhtml_delete(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *end);
* Purges the contents from a GTK+ IM/HTML and resets formatting.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. #define gtk_imhtml_clear(imhtml) \
gtk_imhtml_delete(imhtml, NULL, NULL)
@@ -356,44 +356,44 @@
* Scrolls a GTK+ IM/HTML up by one page.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. void gtk_imhtml_page_up(GtkIMHtml *imhtml);
* Scrolls a GTK+ IM/HTML down by one page.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. void gtk_imhtml_page_down(GtkIMHtml *imhtml);
* Creates and returns an new GTK+ IM/HTML scalable object.
- * Returns: A new IM/HTML Scalable object.
+ * @return A new IM/HTML Scalable object. GtkIMHtmlScalable *gtk_imhtml_scalable_new(void);
* Creates and returns an new GTK+ IM/HTML scalable with a horizontal rule.
- * Returns: A new IM/HTML Scalable object with an image.
+ * @return A new IM/HTML Scalable object with an image. GtkIMHtmlScalable *gtk_imhtml_hr_new(void);
* Destroys and frees a GTK+ IM/HTML scalable horizontal rule.
- * @scale: The GTK+ IM/HTML scalable.
+ * @param scale The GTK+ IM/HTML scalable. void gtk_imhtml_hr_free(GtkIMHtmlScalable *scale);
* Rescales a GTK+ IM/HTML scalable horizontal rule to a given size.
- * @scale: The GTK+ IM/HTML scalable.
- * @width: The new width.
- * @height: The new height.
+ * @param scale The GTK+ IM/HTML scalable. + * @param width The new width. + * @param height The new height. void gtk_imhtml_hr_scale(GtkIMHtmlScalable *scale, int width, int height);
@@ -401,34 +401,34 @@
* Adds a GTK+ IM/HTML scalable horizontal rule to a given GTK+ IM/HTML at
- * @scale: The GTK+ IM/HTML scalable.
- * @imhtml: The GTK+ IM/HTML.
- * @iter: The GtkTextIter at which to add the scalable.
+ * @param scale The GTK+ IM/HTML scalable. + * @param imhtml The GTK+ IM/HTML. + * @param iter The GtkTextIter at which to add the scalable. void gtk_imhtml_hr_add_to(GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter);
* Finds and highlights a given string in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @text: The string to search for.
+ * @param imhtml The GTK+ IM/HTML. + * @param text The string to search for. - * Returns: %TRUE if a search was performed, or %FALSE if not.
+ * @return @c TRUE if a search was performed, or @c FALSE if not. gboolean gtk_imhtml_search_find(GtkIMHtml *imhtml, const gchar *text);
* Clears the highlighting from a prior search in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. void gtk_imhtml_search_clear(GtkIMHtml *imhtml);
* Enables or disables editing in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @editable: %TRUE to make the widget editable, or %FALSE otherwise.
+ * @param imhtml The GTK+ IM/HTML. + * @param editable @c TRUE to make the widget editable, or @c FALSE otherwise. void gtk_imhtml_set_editable(GtkIMHtml *imhtml, gboolean editable);
@@ -437,36 +437,36 @@
* In this mode formatting options to the buffer take effect for the entire
* buffer instead of specific text.
- * @imhtml: The GTK+ IM/HTML.
- * @wbfo: %TRUE to enable the mode, or %FALSE otherwise.
+ * @param imhtml The GTK+ IM/HTML. + * @param wbfo @c TRUE to enable the mode, or @c FALSE otherwise. void gtk_imhtml_set_whole_buffer_formatting_only(GtkIMHtml *imhtml, gboolean wbfo);
* Indicates which formatting functions to enable and disable in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @buttons: A GtkIMHtmlButtons bitmask indicating which functions to use.
+ * @param imhtml The GTK+ IM/HTML. + * @param buttons A GtkIMHtmlButtons bitmask indicating which functions to use. void gtk_imhtml_set_format_functions(GtkIMHtml *imhtml, GtkIMHtmlButtons buttons);
* Returns which formatting functions are enabled in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. - * Returns: A GtkIMHtmlButtons bitmask indicating which functions to are enabled.
+ * @return A GtkIMHtmlButtons bitmask indicating which functions to are enabled. GtkIMHtmlButtons gtk_imhtml_get_format_functions(GtkIMHtml *imhtml);
- * Sets each boolean to %TRUE or %FALSE to indicate if that formatting option
+ * Sets each boolean to @c TRUE or @c FALSE to indicate if that formatting option * is enabled at the current position in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @bold: The boolean to set for bold or %NULL.
- * @italic: The boolean to set for italic or %NULL.
- * @underline: The boolean to set for underline or %NULL.
+ * @param imhtml The GTK+ IM/HTML. + * @param bold The boolean to set for bold or @c NULL. + * @param italic The boolean to set for italic or @c NULL. + * @param underline The boolean to set for underline or @c NULL. void gtk_imhtml_get_current_format(GtkIMHtml *imhtml, gboolean *bold, gboolean *italic, gboolean *underline);
@@ -474,9 +474,9 @@
* Returns a string containing the selected font face at the current position
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. - * Returns: A string containg the font face or %NULL if none is set.
+ * @return A string containg the font face or @c NULL if none is set. char *gtk_imhtml_get_current_fontface(GtkIMHtml *imhtml);
@@ -484,9 +484,9 @@
* Returns a string containing the selected foreground color at the current
* position in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. - * Returns: A string containg the foreground color or %NULL if none is set.
+ * @return A string containg the foreground color or @c NULL if none is set. char *gtk_imhtml_get_current_forecolor(GtkIMHtml *imhtml);
@@ -494,9 +494,9 @@
* Returns a string containing the selected font background color at the current
* position in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. - * Returns: A string containg the font background color or %NULL if none is set.
+ * @return A string containg the font background color or @c NULL if none is set. char *gtk_imhtml_get_current_backcolor(GtkIMHtml *imhtml);
@@ -504,9 +504,9 @@
* Returns a string containing the selected background color at the current
* position in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. - * Returns: A string containg the background color or %NULL if none is set.
+ * @return A string containg the background color or @c NULL if none is set. char *gtk_imhtml_get_current_background(GtkIMHtml *imhtml);
@@ -514,53 +514,53 @@
* Returns a integer containing the selected HTML font size at the current
* position in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. - * Returns: The HTML font size.
+ * @return The HTML font size. gint gtk_imhtml_get_current_fontsize(GtkIMHtml *imhtml);
* Checks whether a GTK+ IM/HTML is marked as editable.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. - * Returns: %TRUE if the IM/HTML is editable, or %FALSE otherwise.
+ * @return @c TRUE if the IM/HTML is editable, or @c FALSE otherwise. gboolean gtk_imhtml_get_editable(GtkIMHtml *imhtml);
* Clear all the formatting on a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. void gtk_imhtml_clear_formatting(GtkIMHtml *imhtml);
* Toggles bold at the cursor location or selection in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. void gtk_imhtml_toggle_bold(GtkIMHtml *imhtml);
* Toggles italic at the cursor location or selection in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. void gtk_imhtml_toggle_italic(GtkIMHtml *imhtml);
* Toggles underline at the cursor location or selection in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. void gtk_imhtml_toggle_underline(GtkIMHtml *imhtml);
* Toggles strikethrough at the cursor location or selection in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. void gtk_imhtml_toggle_strike(GtkIMHtml *imhtml);
@@ -568,10 +568,10 @@
* Toggles a foreground color at the current location or selection in a GTK
- * @imhtml: The GTK+ IM/HTML.
- * @color: The HTML-style color, or %NULL or "" to clear the color.
+ * @param imhtml The GTK+ IM/HTML. + * @param color The HTML-style color, or @c NULL or "" to clear the color. - * Returns: %TRUE if a color was set, or %FALSE if it was cleared.
+ * @return @c TRUE if a color was set, or @c FALSE if it was cleared. gboolean gtk_imhtml_toggle_forecolor(GtkIMHtml *imhtml, const char *color);
@@ -579,10 +579,10 @@
* Toggles a background color at the current location or selection in a GTK
- * @imhtml: The GTK+ IM/HTML.
- * @color: The HTML-style color, or %NULL or "" to clear the color.
+ * @param imhtml The GTK+ IM/HTML. + * @param color The HTML-style color, or @c NULL or "" to clear the color. - * Returns: %TRUE if a color was set, or %FALSE if it was cleared.
+ * @return @c TRUE if a color was set, or @c FALSE if it was cleared. gboolean gtk_imhtml_toggle_backcolor(GtkIMHtml *imhtml, const char *color);
@@ -590,20 +590,20 @@
* Toggles a background color at the current location or selection in a GTK
- * @imhtml: The GTK+ IM/HTML.
- * @color: The HTML-style color, or %NULL or "" to clear the color.
+ * @param imhtml The GTK+ IM/HTML. + * @param color The HTML-style color, or @c NULL or "" to clear the color. - * Returns: %TRUE if a color was set, or %FALSE if it was cleared.
+ * @return @c TRUE if a color was set, or @c FALSE if it was cleared. gboolean gtk_imhtml_toggle_background(GtkIMHtml *imhtml, const char *color);
* Toggles a font face at the current location or selection in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @face: The font face name, or %NULL or "" to clear the font.
+ * @param imhtml The GTK+ IM/HTML. + * @param face The font face name, or @c NULL or "" to clear the font. - * Returns: %TRUE if a font name was set, or %FALSE if it was cleared.
+ * @return @c TRUE if a font name was set, or @c FALSE if it was cleared. gboolean gtk_imhtml_toggle_fontface(GtkIMHtml *imhtml, const char *face);
@@ -611,36 +611,36 @@
* Toggles a link tag with the given URL at the current location or selection
- * @imhtml: The GTK+ IM/HTML.
- * @url: The URL for the link or %NULL to terminate the link.
+ * @param imhtml The GTK+ IM/HTML. + * @param url The URL for the link or @c NULL to terminate the link. void gtk_imhtml_toggle_link(GtkIMHtml *imhtml, const char *url);
* Inserts a link to the given url at the given GtkTextMark in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @mark: The GtkTextMark to insert the link at.
- * @url: The URL for the link.
- * @text: The string to use for the link description.
+ * @param imhtml The GTK+ IM/HTML. + * @param mark The GtkTextMark to insert the link at. + * @param url The URL for the link. + * @param text The string to use for the link description. void gtk_imhtml_insert_link(GtkIMHtml *imhtml, GtkTextMark *mark, const char *url, const char *text);
* Inserts a smiley at the current location or selection in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @sml: The category of the smiley.
- * @smiley: The text of the smiley to insert.
+ * @param imhtml The GTK+ IM/HTML. + * @param sml The category of the smiley. + * @param smiley The text of the smiley to insert. void gtk_imhtml_insert_smiley(GtkIMHtml *imhtml, const char *sml, char *smiley);
* Inserts a smiley at the given iter in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @sml: The category of the smiley.
- * @smiley: The text of the smiley to insert.
- * @iter: The GtkTextIter in the IM/HTML to insert the smiley at.
+ * @param imhtml The GTK+ IM/HTML. + * @param sml The category of the smiley. + * @param smiley The text of the smiley to insert. + * @param iter The GtkTextIter in the IM/HTML to insert the smiley at. void gtk_imhtml_insert_smiley_at_iter(GtkIMHtml *imhtml, const char *sml, char *smiley, GtkTextIter *iter);
@@ -648,17 +648,17 @@
* Inserts the IM/HTML scalable image with the given id at the given iter in a
- * @imhtml: The GTK+ IM/HTML.
- * @id: The id of the IM/HTML scalable.
- * @iter: The GtkTextIter in the IM/HTML to insert the image at.
+ * @param imhtml The GTK+ IM/HTML. + * @param id The id of the IM/HTML scalable. + * @param iter The GtkTextIter in the IM/HTML to insert the image at. void gtk_imhtml_insert_image_at_iter(GtkIMHtml *imhtml, int id, GtkTextIter *iter);
* Sets the font size at the current location or selection in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @size: The HTML font size to use.
+ * @param imhtml The GTK+ IM/HTML. + * @param size The HTML font size to use. void gtk_imhtml_font_set_size(GtkIMHtml *imhtml, gint size);
@@ -666,7 +666,7 @@
* Decreases the font size by 1 at the current location or selection in a GTK
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. void gtk_imhtml_font_shrink(GtkIMHtml *imhtml);
@@ -674,27 +674,27 @@
* Increases the font size by 1 at the current location or selection in a GTK
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. void gtk_imhtml_font_grow(GtkIMHtml *imhtml);
* Returns the HTML formatted contents between two iters in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @start: The GtkTextIter indicating the start point in the IM/HTML.
- * @end: The GtkTextIter indicating the end point in the IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. + * @param start The GtkTextIter indicating the start point in the IM/HTML. + * @param end The GtkTextIter indicating the end point in the IM/HTML. - * Returns: A string containing the HTML formatted text.
+ * @return A string containing the HTML formatted text. char *gtk_imhtml_get_markup_range(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *end);
* Returns the entire HTML formatted contents of a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. - * Returns: A string containing the HTML formatted text.
+ * @return A string containing the HTML formatted text. char *gtk_imhtml_get_markup(GtkIMHtml *imhtml);
@@ -702,9 +702,9 @@
* Returns a null terminated array of pointers to null terminated strings, each
* string for each line. g_strfreev() should be called to free it when done.
- * @imhtml: The GTK+ IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. - * Returns: A null terminated array of null terminated HTML formatted strings.
+ * @return A null terminated array of null terminated HTML formatted strings. char **gtk_imhtml_get_markup_lines(GtkIMHtml *imhtml);
@@ -712,31 +712,31 @@
* Returns the entire unformatted (plain text) contents of a GTK+ IM/HTML
* between two iters in a GTK+ IM/HTML.
- * @imhtml: The GTK+ IM/HTML.
- * @start: The GtkTextIter indicating the start point in the IM/HTML.
- * @stop: The GtkTextIter indicating the end point in the IM/HTML.
+ * @param imhtml The GTK+ IM/HTML. + * @param start The GtkTextIter indicating the start point in the IM/HTML. + * @param stop The GtkTextIter indicating the end point in the IM/HTML. - * Returns: A string containing the unformatted text.
+ * @return A string containing the unformatted text. char *gtk_imhtml_get_text(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *stop);
* Setup formatting for an imhtml depending on the flags specified.
- * @imhtml: The GTK+ IM/HTML.
- * @flags: The connection flag which describes the allowed types of formatting.
+ * @param imhtml The GTK+ IM/HTML. + * @param flags The connection flag which describes the allowed types of formatting. void gtk_imhtml_setup_entry(GtkIMHtml *imhtml, PurpleConnectionFlags flags);
* Create a new GtkIMHtmlSmiley.
- * @file: The image file for the smiley
- * @shortcut: The key shortcut for the smiley
- * @hide: %TRUE if the smiley should be hidden in the smiley dialog, %FALSE otherwise
- * @flags: The smiley flags
+ * @param file The image file for the smiley + * @param shortcut The key shortcut for the smiley + * @param hide @c TRUE if the smiley should be hidden in the smiley dialog, @c FALSE otherwise + * @param flags The smiley flags - * Returns: The newly created smiley
+ * @return The newly created smiley GtkIMHtmlSmiley *gtk_imhtml_smiley_create(const char *file, const char *shortcut, gboolean hide,
GtkIMHtmlSmileyFlags flags);
@@ -744,14 +744,14 @@
* Reload the image data for the smiley.
- * @smiley: The smiley to reload
+ * @param smiley The smiley to reload void gtk_imhtml_smiley_reload(GtkIMHtmlSmiley *smiley);
* Destroy a GtkIMHtmlSmiley.
- * @smiley: The smiley to destroy
+ * @param smiley The smiley to destroy void gtk_imhtml_smiley_destroy(GtkIMHtmlSmiley *smiley);
@@ -759,17 +759,17 @@
* Register a protocol with the GtkIMHtml widget. Registering a protocol would
* allow certain text to be clickable.
- * @name: The name of the protocol (e.g. http://)
- * @activate: The callback to trigger when the protocol text is clicked.
- * Removes any current protocol definition if %NULL. The
- * callback should return %TRUE if the link was activated
- * properly, %FALSE otherwise.
- * @context_menu: The callback to trigger when the context menu is popped
+ * @param name The name of the protocol (e.g. http://) + * @param activate The callback to trigger when the protocol text is clicked. + * Removes any current protocol definition if @c NULL. The + * callback should return @c TRUE if the link was activated + * properly, @c FALSE otherwise. + * @param context_menu The callback to trigger when the context menu is popped * up on the protocol text. The callback should return
- * %TRUE if the request for context menu was processed
- * successfully, %FALSE otherwise.
+ * @c TRUE if the request for context menu was processed + * successfully, @c FALSE otherwise. - * Returns: %TRUE if the protocol was successfully registered (or unregistered, when \a activate is %NULL)
+ * @return @c TRUE if the protocol was successfully registered (or unregistered, when \a activate is @c NULL) gboolean gtk_imhtml_class_register_protocol(const char *name,
gboolean (*activate)(GtkIMHtml *imhtml, GtkIMHtmlLink *link),
@@ -778,18 +778,18 @@
* Get the URL associated with a link. This should be used by the IMHtml protocol-callbacks.
- * @link: The GtkIMHtmlLink object sent to the callback functions
+ * @param link The GtkIMHtmlLink object sent to the callback functions
const char *gtk_imhtml_link_get_url(GtkIMHtmlLink *link);
* Get the GtkTextTag object (if any) associated with a particular link.
- * @link: The GtkIMHtmlLink object sent to the callback functions
+ * @param link The GtkIMHtmlLink object sent to the callback functions - * Returns: The GtkTextTag object, or %NULL
+ * @return The GtkTextTag object, or @c NULL const GtkTextTag *gtk_imhtml_link_get_text_tag(GtkIMHtmlLink *link);
@@ -797,9 +797,9 @@
* Activates a GtkIMHtmlLink object. This triggers the 'url-clicked' signal, marks the
* link as visited (when possible).
- * @link: The GtkIMHtmlLink object sent to the callback functions
+ * @param link The GtkIMHtmlLink object sent to the callback functions - * Returns: %TRUE if 'url-clicked' signal was emitted, %FALSE otherwise.
+ * @return @c TRUE if 'url-clicked' signal was emitted, @c FALSE otherwise. gboolean gtk_imhtml_link_activate(GtkIMHtmlLink *link);
@@ -809,7 +809,7 @@
* behavior, and you want the standard GtkTextView behavior of
* inserting a newline into the buffer, then call this function.
- * @imhtml: The GtkIMHtml where you want the "return" key to add
+ * @param imhtml The GtkIMHtml where you want the "return" key to add * newline and not emit the "message_send" signal.
void gtk_imhtml_set_return_inserts_newline(GtkIMHtml *imhtml);
@@ -819,8 +819,8 @@
* text (as you would expect). For scenarios (e.g. select-on-focus) where this
* would be problematic, this function can disable the PRIMARY population.
- * @imhtml: The GtkIMHtml to enable/disable populating PRIMARY
- * @populate: enable/disable PRIMARY population
+ * @param imhtml The GtkIMHtml to enable/disable populating PRIMARY + * @param populate enable/disable PRIMARY population void gtk_imhtml_set_populate_primary_clipboard(GtkIMHtml *imhtml, gboolean populate);
--- a/pidgin/gtkutils.h Wed Jan 29 10:10:12 2014 +0530
+++ b/pidgin/gtkutils.h Wed Jan 29 10:49:02 2014 +0530
@@ -82,7 +82,7 @@
* Sets up a gtkwebview widget, loads it with smileys, and sets the
* default signal handlers.
- * @webview: The gtkwebview widget to setup.
+ * @param webview The gtkwebview widget to setup. void pidgin_setup_webview(GtkWidget *webview);
@@ -91,74 +91,74 @@
* function puts both widgets in a nice GtkFrame. They're separated by an
* attractive GtkSeparator.
- * @editable: %TRUE if this webview should be editable. If this is
- * %FALSE, then the toolbar will NOT be created. If this webview
+ * @param editable @c TRUE if this webview should be editable. If this is + * @c FALSE, then the toolbar will NOT be created. If this webview * should be read-only at first, but may become editable later, then
- * pass in %TRUE here and then manually call gtk_webview_set_editable()
+ * pass in @c TRUE here and then manually call gtk_webview_set_editable() - * @webview_ret: A pointer to a pointer to a GtkWidget. This pointer
+ * @param webview_ret A pointer to a pointer to a GtkWidget. This pointer * will be set to the webview when this function exits.
- * @sw_ret: This will be filled with a pointer to the scrolled window
+ * @param sw_ret This will be filled with a pointer to the scrolled window * widget which contains the webview.
- * Returns: The GtkFrame containing the toolbar and webview.
+ * @return The GtkFrame containing the toolbar and webview. GtkWidget *pidgin_create_webview(gboolean editable, GtkWidget **webview_ret, GtkWidget **sw_ret);
- * @image: A button image.
+ * @param image A button image. - * Returns: A GtkButton created from the image.
+ * @return A GtkButton created from the image. GtkWidget *pidgin_create_small_button(GtkWidget *image);
- * @title: The window title, or %NULL
- * @border_width: The window's desired border width
- * @role: A string indicating what the window is responsible for doing, or %NULL
- * @resizable: Whether the window should be resizable (%TRUE) or not (%FALSE)
+ * @param title The window title, or @c NULL + * @param border_width The window's desired border width + * @param role A string indicating what the window is responsible for doing, or @c NULL + * @param resizable Whether the window should be resizable (@c TRUE) or not (@c FALSE) GtkWidget *pidgin_create_window(const char *title, guint border_width, const char *role, gboolean resizable);
* Creates a new dialog window
- * @title: The window title, or %NULL
- * @border_width: The window's desired border width
- * @role: A string indicating what the window is responsible for doing, or %NULL
- * @resizable: Whether the window should be resizable (%TRUE) or not (%FALSE)
+ * @param title The window title, or @c NULL + * @param border_width The window's desired border width + * @param role A string indicating what the window is responsible for doing, or @c NULL + * @param resizable Whether the window should be resizable (@c TRUE) or not (@c FALSE) GtkWidget *pidgin_create_dialog(const char *title, guint border_width, const char *role, gboolean resizable);
* Retrieves the main content box (vbox) from a pidgin dialog window
- * @dialog: The dialog window
- * @homogeneous: TRUE if all children are to be given equal space allotments.
- * @spacing: the number of pixels to place by default between children
+ * @param dialog The dialog window + * @param homogeneous TRUE if all children are to be given equal space allotments. + * @param spacing the number of pixels to place by default between children GtkWidget *pidgin_dialog_get_vbox_with_properties(GtkDialog *dialog, gboolean homogeneous, gint spacing);
* Retrieves the main content box (vbox) from a pidgin dialog window
- * @dialog: The dialog window
+ * @param dialog The dialog window GtkWidget *pidgin_dialog_get_vbox(GtkDialog *dialog);
* Add a button to a dialog created by #pidgin_create_dialog.
- * @dialog: The dialog window
- * @label: The stock-id or the label for the button
- * @callback: The callback function for the button
- * @callbackdata: The user data for the callback function
+ * @param dialog The dialog window + * @param label The stock-id or the label for the button + * @param callback The callback function for the button + * @param callbackdata The user data for the callback function - * Returns: The created button.
+ * @return The created button. GtkWidget *pidgin_dialog_add_button(GtkDialog *dialog, const char *label,
GCallback callback, gpointer callbackdata);
@@ -166,15 +166,15 @@
* Retrieves the action area (button box) from a pidgin dialog window
- * @dialog: The dialog window
+ * @param dialog The dialog window GtkWidget *pidgin_dialog_get_action_area(GtkDialog *dialog);
* Toggles the sensitivity of a widget.
- * @widget: %NULL. Used for signal handlers.
- * @to_toggle: The widget to toggle.
+ * @param widget @c NULL. Used for signal handlers. + * @param to_toggle The widget to toggle. void pidgin_toggle_sensitive(GtkWidget *widget, GtkWidget *to_toggle);
@@ -183,56 +183,56 @@
* so, the GTK_RESPONSE_OK on the given dialog is set to TRUE.
* Otherwise GTK_RESPONSE_OK is set to FALSE.
- * @entry: The text entry widget.
- * @dialog: The dialog containing the text entry widget.
+ * @param entry The text entry widget. + * @param dialog The dialog containing the text entry widget. void pidgin_set_sensitive_if_input(GtkWidget *entry, GtkWidget *dialog);
* Toggles the sensitivity of all widgets in a pointer array.
- * @param w %NULL. Used for signal handlers.
- * @data: The array containing the widgets to toggle.
+ * @param w @c NULL. Used for signal handlers. + * @param data The array containing the widgets to toggle. void pidgin_toggle_sensitive_array(GtkWidget *w, GPtrArray *data);
* Toggles the visibility of a widget.
- * @widget: %NULL. Used for signal handlers.
- * @to_toggle: The widget to toggle.
+ * @param widget @c NULL. Used for signal handlers. + * @param to_toggle The widget to toggle. void pidgin_toggle_showhide(GtkWidget *widget, GtkWidget *to_toggle);
* Adds a separator to a menu.
- * @menu: The menu to add a separator to.
+ * @param menu The menu to add a separator to. - * Returns: The separator.
+ * @return The separator. GtkWidget *pidgin_separator(GtkWidget *menu);
- * @menu: The menu to which to append the menu item.
- * @str: The title to use for the newly created menu item.
+ * @param menu The menu to which to append the menu item. + * @param str The title to use for the newly created menu item. - * Returns: The newly created menu item.
+ * @return The newly created menu item. GtkWidget *pidgin_new_item(GtkWidget *menu, const char *str);
* Creates a check menu item.
- * @menu: The menu to which to append the check menu item.
- * @str: The title to use for the newly created menu item.
- * @cb: A function to call when the menu item is activated.
- * @data: Data to pass to the signal function.
- * @checked: The initial state of the check item
+ * @param menu The menu to which to append the check menu item. + * @param str The title to use for the newly created menu item. + * @param cb A function to call when the menu item is activated. + * @param data Data to pass to the signal function. + * @param checked The initial state of the check item - * Returns: The newly created menu item.
+ * @return The newly created menu item. GtkWidget *pidgin_new_check_item(GtkWidget *menu, const char *str,
GCallback cb, gpointer data, gboolean checked);
@@ -240,17 +240,17 @@
- * @menu: The menu to which to append the menu item.
- * @str: The title for the menu item.
- * @icon: An icon to place to the left of the menu item,
- * or %NULL for no icon.
- * @cb: A function to call when the menu item is activated.
- * @data: Data to pass to the signal function.
- * @accel_key: Something.
- * @accel_mods: Something.
+ * @param menu The menu to which to append the menu item. + * @param str The title for the menu item. + * @param icon An icon to place to the left of the menu item, + * or @c NULL for no icon. + * @param cb A function to call when the menu item is activated. + * @param data Data to pass to the signal function. + * @param accel_key Something. + * @param accel_mods Something. + * @param mod Something. - * Returns: The newly created menu item.
+ * @return The newly created menu item. GtkWidget *pidgin_new_item_from_stock(GtkWidget *menu, const char *str,
const char *icon, GCallback cb,
@@ -260,11 +260,11 @@
* Creates a button with the specified text and stock icon.
- * @text: The text for the button.
- * @icon: The stock icon name.
- * @style: The orientation of the button.
+ * @param text The text for the button. + * @param icon The stock icon name. + * @param style The orientation of the button.
GtkWidget *pidgin_pixbuf_button_from_stock(const char *text, const char *icon,
PidginButtonOrientation style);
@@ -272,30 +272,30 @@
* Creates a toolbar button with the stock icon.
- * @stock: The stock icon name.
+ * @param stock The stock icon name.
GtkWidget *pidgin_pixbuf_toolbar_button_from_stock(const char *stock);
* Creates a HIG preferences frame.
- * @parent: The widget to put the frame into.
- * @title: The title for the frame.
+ * @param parent The widget to put the frame into. + * @param title The title for the frame. - * Returns: The vbox to put things into.
+ * @return The vbox to put things into. GtkWidget *pidgin_make_frame(GtkWidget *parent, const char *title);
* Creates a drop-down option menu filled with protocols.
- * @id: The protocol to select by default.
- * @cb: The callback to call when a protocol is selected.
- * @user_data: Data to pass to the callback function.
+ * @param id The protocol to select by default. + * @param cb The callback to call when a protocol is selected. + * @param user_data Data to pass to the callback function. - * Returns: The drop-down option menu.
+ * @return The drop-down option menu. GtkWidget *pidgin_protocol_option_menu_new(const char *id,
@@ -304,24 +304,24 @@
* Gets the currently selected protocol from a protocol drop down box.
- * @optmenu: The drop-down option menu created by
+ * @param optmenu The drop-down option menu created by * pidgin_account_option_menu_new.
- * Returns: Returns the protocol ID that is currently selected.
+ * @return Returns the protocol ID that is currently selected. const char *pidgin_protocol_option_menu_get_selected(GtkWidget *optmenu);
* Creates a drop-down option menu filled with accounts.
- * @default_account: The account to select by default.
- * @show_all: Whether or not to show all accounts, or just
+ * @param default_account The account to select by default. + * @param show_all Whether or not to show all accounts, or just - * @cb: The callback to call when an account is selected.
- * @filter_func: A function for checking if an account should
+ * @param cb The callback to call when an account is selected. + * @param filter_func A function for checking if an account should * be shown. This can be NULL.
- * @user_data: Data to pass to the callback function.
+ * @param user_data Data to pass to the callback function. - * Returns: The drop-down option menu.
+ * @return The drop-down option menu. GtkWidget *pidgin_account_option_menu_new(PurpleAccount *default_account,
gboolean show_all, GCallback cb,
@@ -330,41 +330,41 @@
* Gets the currently selected account from an account drop down box.
- * @optmenu: The drop-down option menu created by
+ * @param optmenu The drop-down option menu created by * pidgin_account_option_menu_new.
- * Returns: Returns the PurpleAccount that is currently selected.
+ * @return Returns the PurpleAccount that is currently selected. PurpleAccount *pidgin_account_option_menu_get_selected(GtkWidget *optmenu);
* Sets the currently selected account for an account drop down box.
- * @optmenu: The GtkOptionMenu created by
+ * @param optmenu The GtkOptionMenu created by * pidgin_account_option_menu_new.
- * @account: The PurpleAccount to select.
+ * @param account The PurpleAccount to select. void pidgin_account_option_menu_set_selected(GtkWidget *optmenu, PurpleAccount *account);
* Add autocompletion of screenames to an entry, supporting a filtering function.
- * @entry: The GtkEntry on which to setup autocomplete.
- * @optmenu: A menu for accounts, returned by pidgin_account_option_menu_new().
- * If @a optmenu is not %NULL, it'll be updated when a username is chosen
+ * @param entry The GtkEntry on which to setup autocomplete. + * @param optmenu A menu for accounts, returned by pidgin_account_option_menu_new(). + * If @a optmenu is not @c NULL, it'll be updated when a username is chosen * from the autocomplete list.
- * @filter_func: A function for checking if an autocomplete entry
- * should be shown. This can be %NULL.
- * @user_data: The data to be passed to the filter_func function.
+ * @param filter_func A function for checking if an autocomplete entry + * should be shown. This can be @c NULL. + * @param user_data The data to be passed to the filter_func function. void pidgin_setup_screenname_autocomplete(GtkWidget *entry, GtkWidget *optmenu, PidginFilterBuddyCompletionEntryFunc filter_func, gpointer user_data);
* The default filter function for username autocomplete.
- * @completion_entry: The completion entry to filter.
- * @all_accounts: If this is %FALSE, only the autocompletion entries
+ * @param completion_entry The completion entry to filter. + * @param all_accounts If this is @c FALSE, only the autocompletion entries * which belong to an online account will be filtered.
- * Returns: Returns %TRUE if the autocompletion entry is filtered.
+ * @return Returns @c TRUE if the autocompletion entry is filtered. gboolean pidgin_screenname_autocomplete_default_filter(const PidginBuddyCompletionEntry *completion_entry, gpointer all_accounts);
@@ -374,7 +374,7 @@
* This does nothing if Pidgin is not compiled with GtkSpell support.
- * @textview: The textview widget to setup spellchecking for.
+ * @param textview The textview widget to setup spellchecking for. void pidgin_setup_gtkspell(GtkTextView *textview);
@@ -398,17 +398,17 @@
* Get information about a user. Show immediate feedback.
- * @conn: The connection to get information from.
- * @name: The user to get information about.
+ * @param conn The connection to get information from. + * @param name The user to get information about. void pidgin_retrieve_user_info(PurpleConnection *conn, const char *name);
* Get information about a user in a chat. Show immediate feedback.
- * @conn: The connection to get information from.
- * @name: The user to get information about.
- * @chatid: The chat id.
+ * @param conn The connection to get information from. + * @param name The user to get information about. + * @param chatid The chat id. void pidgin_retrieve_user_info_in_chat(PurpleConnection *conn, const char *name, int chatid);
@@ -416,16 +416,16 @@
* Parses an application/x-im-contact MIME message and returns the
- * @msg: The MIME message.
- * @all_accounts: If TRUE, check all compatible accounts, online or
+ * @param msg The MIME message. + * @param all_accounts If TRUE, check all compatible accounts, online or * offline. If FALSE, check only online accounts.
- * @ret_account: The best guess at a compatible protocol,
+ * @param ret_account The best guess at a compatible protocol, * based on ret_protocol. If NULL, no account was found.
- * @ret_protocol: The returned protocol type.
- * @ret_username: The returned username.
- * @ret_alias: The returned alias.
+ * @param ret_protocol The returned protocol type. + * @param ret_username The returned username. + * @param ret_alias The returned alias. - * Returns: TRUE if the message was parsed for the minimum necessary data.
+ * @return TRUE if the message was parsed for the minimum necessary data. gboolean pidgin_parse_x_im_contact(const char *msg, gboolean all_accounts,
@@ -454,13 +454,13 @@
* A helper function for GtkMenuPositionFuncs. This ensures the menu will
* be kept on screen if possible.
- * @menu: The menu we are positioning.
+ * @param menu The menu we are positioning. * @param x Address of the gint representing the horizontal position
* where the menu shall be drawn. This is an output parameter.
* @param y Address of the gint representing the vertical position
* where the menu shall be drawn. This is an output parameter.
- * @push_in: This is an output parameter?
- * @data: Not used by this particular position function.
+ * @param push_in This is an output parameter? + * @param data Not used by this particular position function. void pidgin_menu_position_func_helper(GtkMenu *menu, gint *x, gint *y,
gboolean *push_in, gpointer data);
@@ -472,13 +472,13 @@
* then you should just use GTK's built-in position function,
* because it does a better job of positioning the menu.
- * @menu: The menu we are positioning.
+ * @param menu The menu we are positioning. * @param x Address of the gint representing the horizontal position
* where the menu shall be drawn. This is an output parameter.
* @param y Address of the gint representing the vertical position
* where the menu shall be drawn. This is an output parameter.
- * @push_in: This is an output parameter?
- * @user_data: Not used by this particular position function.
+ * @param push_in This is an output parameter? + * @param user_data Not used by this particular position function. void pidgin_treeview_popup_menu_position_func(GtkMenu *menu,
@@ -489,9 +489,9 @@
* Manages drag'n'drop of files.
- * @sd: GtkSelectionData for managing drag'n'drop
- * @account: Account to be used (may be NULL if conv is not NULL)
- * @who: Buddy name (may be NULL if conv is not NULL)
+ * @param sd GtkSelectionData for managing drag'n'drop + * @param account Account to be used (may be NULL if conv is not NULL) + * @param who Buddy name (may be NULL if conv is not NULL) void pidgin_dnd_file_manage(GtkSelectionData *sd, PurpleAccount *account, const char *who);
@@ -504,10 +504,10 @@
* Returns the base image to represent the account, based on
* the currently selected theme.
- * @account: The account.
- * @size: The size of the icon to return.
+ * @param account The account. + * @param size The size of the icon to return. - * Returns: A newly-created pixbuf with a reference count of 1,
+ * @return A newly-created pixbuf with a reference count of 1, * or NULL if any of several error conditions occurred:
* the file could not be opened, there was no loader
* for the file's format, there was not enough memory
@@ -519,39 +519,39 @@
* Creates a status icon for a given primitve
- * @primitive: The status primitive
+ * @param primitive The status primitive * @param w The widget to render this
- * @size: The icon size to render at
- * Returns: A GdkPixbuf, created from stock
+ * @param size The icon size to render at + * @return A GdkPixbuf, created from stock GdkPixbuf * pidgin_create_status_icon(PurpleStatusPrimitive primitive, GtkWidget *w, const char *size);
* Returns an appropriate stock-id for a status primitive.
- * @prim: The status primitive
+ * @param prim The status primitive - * Returns: The stock-id
const char *pidgin_stock_id_from_status_primitive(PurpleStatusPrimitive prim);
* Returns an appropriate stock-id for a PurplePresence.
- * @presence: The presence.
+ * @param presence The presence. - * Returns: The stock-id
const char *pidgin_stock_id_from_presence(PurplePresence *presence);
* Append a PurpleMenuAction to a menu.
- * @menu: The menu to append to.
- * @act: The PurpleMenuAction to append.
- * @gobject: The object to be passed to the action callback.
+ * @param menu The menu to append to. + * @param act The PurpleMenuAction to append. + * @param gobject The object to be passed to the action callback. - * Returns: The menuitem added.
+ * @return The menuitem added. GtkWidget *pidgin_append_menu_action(GtkWidget *menu, PurpleMenuAction *act,
@@ -562,42 +562,42 @@
* After setting the cursor, the display is flushed, so the change will
* take effect immediately.
- * If the window for @a widget is %NULL, this function simply returns.
+ * If the window for @a widget is @c NULL, this function simply returns. - * @widget: The widget for which to set the mouse pointer
- * @cursor_type: The type of cursor to set
+ * @param widget The widget for which to set the mouse pointer + * @param cursor_type The type of cursor to set void pidgin_set_cursor(GtkWidget *widget, GdkCursorType cursor_type);
* Sets the mouse point for a GtkWidget back to that of its parent window.
- * If @a widget is %NULL, this function simply returns.
+ * If @a widget is @c NULL, this function simply returns. - * If the window for @a widget is %NULL, this function simply returns.
+ * If the window for @a widget is @c NULL, this function simply returns. - * Note: The display is not flushed from this function.
+ * @note The display is not flushed from this function. void pidgin_clear_cursor(GtkWidget *widget);
* Creates a File Selection widget for choosing a buddy icon
- * @parent: The parent window
- * @callback: The callback to call when the window is closed. If the user chose an icon, the char* argument will point to its path
- * @data: Data to pass to @a callback
- * Returns: The file dialog
+ * @param parent The parent window + * @param callback The callback to call when the window is closed. If the user chose an icon, the char* argument will point to its path + * @param data Data to pass to @a callback + * @return The file dialog GtkWidget *pidgin_buddy_icon_chooser_new(GtkWindow *parent, void(*callback)(const char*,gpointer), gpointer data);
* Converts a buddy icon to the required size and format
- * @protocol: The protocol to convert the icon
- * @path: The path of a file to convert
- * @len: If not %NULL, the length of the returned data will be set here.
+ * @param protocol The protocol to convert the icon + * @param path The path of a file to convert + * @param len If not @c NULL, the length of the returned data will be set here. - * Returns: The converted image data, or %NULL if an error occurred.
+ * @return The converted image data, or @c NULL if an error occurred. gpointer pidgin_convert_buddy_icon(PurpleProtocol *protocol, const char *path, size_t *len);
@@ -605,8 +605,8 @@
* Converts "->" and "<-" in strings to Unicode arrow characters, for use in referencing
- * @str: The text to convert
- * Returns: A newly allocated string with unicode arrow characters
+ * @param str The text to convert + * @return A newly allocated string with unicode arrow characters char *pidgin_make_pretty_arrows(const char *str);
@@ -619,24 +619,24 @@
* Creates a #PidginMiniDialog, tied to a #PurpleConnection, suitable for
* embedding in the buddy list scrollbook with pidgin_blist_add_alert().
- * @handle: The #PurpleConnection to which this mini-dialog
- * refers, or %NULL if it does not refer to a
+ * @param handle The #PurpleConnection to which this mini-dialog + * refers, or @c NULL if it does not refer to a * connection. If @a handle is supplied, the mini-dialog
* will be automatically removed and destroyed when the
- * @stock_id: The ID of a stock image to use in the mini dialog.
- * @primary: The primary text
- * @secondary: The secondary text, or %NULL for no description.
- * @user_data: Data to pass to the callbacks
- * @...: a <tt>NULL</tt>-terminated list of button labels
+ * @param stock_id The ID of a stock image to use in the mini dialog. + * @param primary The primary text + * @param secondary The secondary text, or @c NULL for no description. + * @param user_data Data to pass to the callbacks + * @param ... a <tt>NULL</tt>-terminated list of button labels * (<tt>char *</tt>) and callbacks
* (#PidginUtilMiniDialogCallback). @a user_data will be
* passed as the first argument. (Callbacks may lack a
- * second argument, or be %NULL to take no action when
+ * second argument, or be @c NULL to take no action when * the corresponding button is pressed.) When a button is
* pressed, the callback (if any) will be called; when
* the callback returns the dialog will be destroyed.
- * Returns: A #PidginMiniDialog, suitable for passing to
+ * @return A #PidginMiniDialog, suitable for passing to * pidgin_blist_add_alert().
@@ -670,8 +670,8 @@
* Sets or resets a window to 'urgent,' by setting the URGENT hint in X
* or blinking in the win32 taskbar
- * @window: The window to draw attention to
- * @urgent: Whether to set the urgent hint or not
+ * @param window The window to draw attention to + * @param urgent Whether to set the urgent hint or not void pidgin_set_urgent(GtkWindow *window, gboolean urgent);
@@ -679,15 +679,15 @@
* Returns TRUE if the GdkPixbuf is opaque, as determined by no
* alpha at any of the edge pixels.
- * Returns: TRUE if the pixbuf is opaque around the edges, FALSE otherwise
+ * @param pixbuf The pixbug + * @return TRUE if the pixbuf is opaque around the edges, FALSE otherwise gboolean pidgin_gdk_pixbuf_is_opaque(GdkPixbuf *pixbuf);
* Rounds the corners of a 32x32 GdkPixbuf in place
- * @pixbuf: The buddy icon to transform
+ * @param pixbuf The buddy icon to transform void pidgin_gdk_pixbuf_make_round(GdkPixbuf *pixbuf);
@@ -695,18 +695,18 @@
* Returns an HTML-style color string for use as a dim grey
- * @widget: The widget to return dim grey for
- * Returns: The dim grey string
+ * @param widget The widget to return dim grey for + * @return The dim grey string const char *pidgin_get_dim_grey_string(GtkWidget *widget);
* Create a simple text GtkComboBoxEntry equivalent
- * @default_item: Initial contents of GtkEntry
- * @items: GList containing strings to add to GtkComboBox
+ * @param default_item Initial contents of GtkEntry + * @param items GList containing strings to add to GtkComboBox - * Returns: A newly created text GtkComboBox containing a GtkEntry
+ * @return A newly created text GtkComboBox containing a GtkEntry GtkWidget *pidgin_text_combo_box_entry_new(const char *default_item, GList *items);
@@ -714,50 +714,50 @@
* Retrieve the text from the entry of the simple text GtkComboBoxEntry equivalent
- * @widget: The simple text GtkComboBoxEntry equivalent widget
+ * @param widget The simple text GtkComboBoxEntry equivalent widget - * Returns: The text in the widget's entry. It must not be freed
+ * @return The text in the widget's entry. It must not be freed const char *pidgin_text_combo_box_entry_get_text(GtkWidget *widget);
* Set the text in the entry of the simple text GtkComboBoxEntry equivalent
- * @widget: The simple text GtkComboBoxEntry equivalent widget
- * @text: The text to set
+ * @param widget The simple text GtkComboBoxEntry equivalent widget + * @param text The text to set void pidgin_text_combo_box_entry_set_text(GtkWidget *widget, const char *text);
* Automatically make a window transient to a suitable parent window.
- * @window: The window to make transient.
+ * @param window The window to make transient. - * Returns: Whether the window was made transient or not.
+ * @return Whether the window was made transient or not. gboolean pidgin_auto_parent_window(GtkWidget *window);
* Add a labelled widget to a GtkVBox
- * @vbox: The GtkVBox to add the widget to.
- * @widget_label: The label to give the widget, can be %NULL.
- * @sg: The GtkSizeGroup to add the label to, can be %NULL.
- * @widget: The GtkWidget to add.
- * @expand: Whether to expand the widget horizontally.
- * @p_label: Place to store a pointer to the GtkLabel, or %NULL if you don't care.
+ * @param vbox The GtkVBox to add the widget to. + * @param widget_label The label to give the widget, can be @c NULL. + * @param sg The GtkSizeGroup to add the label to, can be @c NULL. + * @param widget The GtkWidget to add. + * @param expand Whether to expand the widget horizontally. + * @param p_label Place to store a pointer to the GtkLabel, or @c NULL if you don't care. - * Returns: A GtkHBox already added to the GtkVBox containing the GtkLabel and the GtkWidget.
+ * @return A GtkHBox already added to the GtkVBox containing the GtkLabel and the GtkWidget. GtkWidget *pidgin_add_widget_to_vbox(GtkBox *vbox, const char *widget_label, GtkSizeGroup *sg, GtkWidget *widget, gboolean expand, GtkWidget **p_label);
* Create a GdkPixbuf from a chunk of image data.
- * @buf: The raw binary image data.
- * @count: The length of buf in bytes.
+ * @param buf The raw binary image data. + * @param count The length of buf in bytes. - * Returns: A GdkPixbuf created from the image data, or NULL if
+ * @return A GdkPixbuf created from the image data, or NULL if * there was an error parsing the data.
GdkPixbuf *pidgin_pixbuf_from_data(const guchar *buf, gsize count);
@@ -765,10 +765,10 @@
* Create a GdkPixbufAnimation from a chunk of image data.
- * @buf: The raw binary image data.
- * @count: The length of buf in bytes.
+ * @param buf The raw binary image data. + * @param count The length of buf in bytes. - * Returns: A GdkPixbufAnimation created from the image data, or NULL if
+ * @return A GdkPixbufAnimation created from the image data, or NULL if * there was an error parsing the data.
GdkPixbufAnimation *pidgin_pixbuf_anim_from_data(const guchar *buf, gsize count);
@@ -776,9 +776,9 @@
* Create a GdkPixbuf from a PurpleStoredImage.
- * @image: A PurpleStoredImage.
+ * @param image A PurpleStoredImage. - * Returns: A GdkPixbuf created from the stored image.
+ * @return A GdkPixbuf created from the stored image. GdkPixbuf *pidgin_pixbuf_from_imgstore(PurpleStoredImage *image);
@@ -798,9 +798,9 @@
* gdk-pixbuf where the aforementioned bug is fixed. However, it might be
* nice to keep this function around for the debug message that it logs.
- * @filename: Name of file to load, in the GLib file name encoding
+ * @param filename Name of file to load, in the GLib file name encoding - * Returns: The GdkPixbuf if successful. Otherwise NULL is returned and
+ * @return The GdkPixbuf if successful. Otherwise NULL is returned and GdkPixbuf *pidgin_pixbuf_new_from_file(const char *filename);
@@ -821,11 +821,11 @@
* gdk-pixbuf where the aforementioned bug is fixed. However, it might be
* nice to keep this function around for the debug message that it logs.
- * @filename: Name of file to load, in the GLib file name encoding
- * @width: The width the image should have or -1 to not constrain the width
- * @height: The height the image should have or -1 to not constrain the height
+ * @param filename Name of file to load, in the GLib file name encoding + * @param width The width the image should have or -1 to not constrain the width + * @param height The height the image should have or -1 to not constrain the height - * Returns: The GdkPixbuf if successful. Otherwise NULL is returned and
+ * @return The GdkPixbuf if successful. Otherwise NULL is returned and GdkPixbuf *pidgin_pixbuf_new_from_file_at_size(const char *filename, int width, int height);
@@ -846,24 +846,24 @@
* gdk-pixbuf where the aforementioned bug is fixed. However, it might be
* nice to keep this function around for the debug message that it logs.
- * @filename: Name of file to load, in the GLib file name encoding
- * @width: The width the image should have or -1 to not constrain the width
- * @height: The height the image should have or -1 to not constrain the height
- * @preserve_aspect_ratio: TRUE to preserve the image's aspect ratio
+ * @param filename Name of file to load, in the GLib file name encoding + * @param width The width the image should have or -1 to not constrain the width + * @param height The height the image should have or -1 to not constrain the height + * @param preserve_aspect_ratio TRUE to preserve the image's aspect ratio - * Returns: The GdkPixbuf if successful. Otherwise NULL is returned and
+ * @return The GdkPixbuf if successful. Otherwise NULL is returned and GdkPixbuf *pidgin_pixbuf_new_from_file_at_scale(const char *filename, int width, int height, gboolean preserve_aspect_ratio);
* Add scrollbars to a widget
- * @child: The child widget
- * @hscrollbar_policy: Horizontal scrolling policy
- * @vscrollbar_policy: Vertical scrolling policy
- * @shadow_type: Shadow type
- * @width: Desired widget width, or -1 for default
- * @height: Desired widget height, or -1 for default
+ * @param child The child widget + * @param hscrollbar_policy Horizontal scrolling policy + * @param vscrollbar_policy Vertical scrolling policy + * @param shadow_type Shadow type + * @param width Desired widget width, or -1 for default + * @param height Desired widget height, or -1 for default GtkWidget *pidgin_make_scrollable(GtkWidget *child, GtkPolicyType hscrollbar_policy, GtkPolicyType vscrollbar_policy, GtkShadowType shadow_type, int width, int height);
--- a/pidgin/gtkwebview.h Wed Jan 29 10:10:12 2014 +0530
+++ b/pidgin/gtkwebview.h Wed Jan 29 10:49:02 2014 +0530
@@ -111,16 +111,16 @@
* Returns the GType for a GtkWebView widget
- * Returns: The GType for GtkWebView widget
+ * @return The GType for GtkWebView widget GType gtk_webview_get_type(void);
* Create a new GtkWebView object
- * @editable: Whether this GtkWebView will be user-editable
+ * @param editable Whether this GtkWebView will be user-editable - * Returns: A GtkWidget corresponding to the GtkWebView object
+ * @return A GtkWidget corresponding to the GtkWebView object GtkWidget *gtk_webview_new(gboolean editable);
@@ -128,16 +128,16 @@
* A very basic routine to append html, which can be considered
* equivalent to a "document.write" using JavaScript.
- * @webview: The GtkWebView object
- * @markup: The html markup to append
+ * @param webview The GtkWebView object + * @param markup The html markup to append void gtk_webview_append_html(GtkWebView *webview, const char *markup);
* Requests loading of the given content.
- * @webview: The GtkWebView object
- * @html: The HTML content to load
+ * @param webview The GtkWebView object + * @param html The HTML content to load void gtk_webview_load_html_string(GtkWebView *webview, const char *html);
@@ -147,8 +147,8 @@
* used to set the selection. This tag is then removed so that querying the
* WebView's HTML contents will no longer return it.
- * @webview: The GtkWebView object
- * @html: The HTML content to load
+ * @param webview The GtkWebView object + * @param html The HTML content to load void gtk_webview_load_html_string_with_selection(GtkWebView *webview, const char *html);
@@ -159,8 +159,8 @@
* conditions when calling JS functions immediately after opening the
- * @webview: The GtkWebView object
- * @script: The script to execute
+ * @param webview The GtkWebView object + * @param script The script to execute void gtk_webview_safe_execute_script(GtkWebView *webview, const char *script);
@@ -168,25 +168,25 @@
* A convenience routine to quote a string for use as a JavaScript
* string. For instance, "hello 'world'" becomes "'hello \\'world\\''"
- * @str: The string to escape and quote
+ * @param str The string to escape and quote - * Returns: The quoted string
+ * @return The quoted string char *gtk_webview_quote_js_string(const char *str);
* Set the vertical adjustment for the GtkWebView.
- * @webview: The GtkWebView object
- * @vadj: The GtkAdjustment that control the webview
+ * @param webview The GtkWebView object + * @param vadj The GtkAdjustment that control the webview void gtk_webview_set_vadjustment(GtkWebView *webview, GtkAdjustment *vadj);
* Scrolls the Webview to the end of its contents.
- * @webview: The GtkWebView object
- * @smooth: A boolean indicating if smooth scrolling should be used
+ * @param webview The GtkWebView object + * @param smooth A boolean indicating if smooth scrolling should be used void gtk_webview_scroll_to_end(GtkWebView *webview, gboolean smooth);
@@ -194,8 +194,8 @@
* Set whether the GtkWebView stays at its end when HTML content is appended. If
* not already at the end before appending, then scrolling will not occur.
- * @webview: The GtkWebView object
- * @scroll: Whether to automatically scroll
+ * @param webview The GtkWebView object + * @param scroll Whether to automatically scroll void gtk_webview_set_autoscroll(GtkWebView *webview, gboolean scroll);
@@ -203,39 +203,39 @@
* Set whether the GtkWebView stays at its end when HTML content is appended. If
* not already at the end before appending, then scrolling will not occur.
- * @webview: The GtkWebView object
+ * @param webview The GtkWebView object - * Returns: Whether to automatically scroll
+ * @return Whether to automatically scroll gboolean gtk_webview_get_autoscroll(GtkWebView *webview);
* Scrolls a GtkWebView up by one page.
- * @webview: The GtkWebView.
+ * @param webview The GtkWebView. void gtk_webview_page_up(GtkWebView *webview);
* Scrolls a GtkWebView down by one page.
- * @webview: The GtkWebView.
+ * @param webview The GtkWebView. void gtk_webview_page_down(GtkWebView *webview);
* Setup formatting for a GtkWebView depending on the flags specified.
- * @webview: The GtkWebView.
- * @flags: The connection flags describing the allowed formatting.
+ * @param webview The GtkWebView. + * @param flags The connection flags describing the allowed formatting. void gtk_webview_setup_entry(GtkWebView *webview, PurpleConnectionFlags flags);
* Setup spell-checking on a GtkWebView.
- * @webview: The GtkWebView.
- * @enable: Whether to enable or disable spell-checking.
+ * @param webview The GtkWebView. + * @param enable Whether to enable or disable spell-checking. void pidgin_webview_set_spellcheck(GtkWebView *webview, gboolean enable);
@@ -244,8 +244,8 @@
* In this mode formatting options to the buffer take effect for the entire
* buffer instead of specific text.
- * @webview: The GtkWebView
- * @wbfo: %TRUE to enable the mode, or %FALSE otherwise.
+ * @param webview The GtkWebView + * @param wbfo @c TRUE to enable the mode, or @c FALSE otherwise. void gtk_webview_set_whole_buffer_formatting_only(GtkWebView *webview,
@@ -253,8 +253,8 @@
* Indicates which formatting functions to enable and disable in a GtkWebView.
- * @webview: The GtkWebView
- * @buttons: A GtkWebViewButtons bitmask indicating which functions to use
+ * @param webview The GtkWebView + * @param buttons A GtkWebViewButtons bitmask indicating which functions to use void gtk_webview_set_format_functions(GtkWebView *webview,
GtkWebViewButtons buttons);
@@ -263,7 +263,7 @@
* Activates a WebKitDOMHTMLAnchorElement object. This triggers the navigation
* signals, and marks the link as visited (when possible).
- * @link: The WebKitDOMHTMLAnchorElement object
+ * @param link The WebKitDOMHTMLAnchorElement object void gtk_webview_activate_anchor(WebKitDOMHTMLAnchorElement *link);
@@ -272,18 +272,18 @@
* Register a protocol with the GtkWebView widget. Registering a protocol would
* allow certain text to be clickable.
- * @name: The name of the protocol (e.g. http://)
- * @activate: The callback to trigger when the protocol text is clicked.
- * Removes any current protocol definition if %NULL. The
- * callback should return %TRUE if the link was activated
- * properly, %FALSE otherwise.
- * @context_menu: The callback to trigger when the context menu is popped
+ * @param name The name of the protocol (e.g. http://) + * @param activate The callback to trigger when the protocol text is clicked. + * Removes any current protocol definition if @c NULL. The + * callback should return @c TRUE if the link was activated + * properly, @c FALSE otherwise. + * @param context_menu The callback to trigger when the context menu is popped * up on the protocol text. The callback should return
- * %TRUE if the request for context menu was processed
- * successfully, %FALSE otherwise.
+ * @c TRUE if the request for context menu was processed + * successfully, @c FALSE otherwise. - * Returns: %TRUE if the protocol was successfully registered
- * (or unregistered, when \a activate is %NULL)
+ * @return @c TRUE if the protocol was successfully registered + * (or unregistered, when \a activate is @c NULL) gboolean gtk_webview_class_register_protocol(const char *name,
gboolean (*activate)(GtkWebView *webview, const char *uri),
@@ -292,21 +292,21 @@
* Returns which formatting functions are enabled in a GtkWebView.
- * @webview: The GtkWebView
+ * @param webview The GtkWebView - * Returns: A GtkWebViewButtons bitmask indicating which functions to are enabled
+ * @return A GtkWebViewButtons bitmask indicating which functions to are enabled GtkWebViewButtons gtk_webview_get_format_functions(GtkWebView *webview);
- * Sets each boolean to %TRUE or %FALSE to indicate if that formatting
+ * Sets each boolean to @c TRUE or @c FALSE to indicate if that formatting * option is enabled at the current position in a GtkWebView.
- * @webview: The GtkWebView
- * @bold: The boolean to set for bold or %NULL.
- * @italic: The boolean to set for italic or %NULL.
- * @underline: The boolean to set for underline or %NULL.
- * @strikethrough: The boolean to set for strikethrough or %NULL.
+ * @param webview The GtkWebView + * @param bold The boolean to set for bold or @c NULL. + * @param italic The boolean to set for italic or @c NULL. + * @param underline The boolean to set for underline or @c NULL. + * @param strikethrough The boolean to set for strikethrough or @c NULL. void gtk_webview_get_current_format(GtkWebView *webview, gboolean *bold,
gboolean *italic, gboolean *underline,
@@ -316,9 +316,9 @@
* Returns a string containing the selected font face at the current position
- * @webview: The GtkWebView
+ * @param webview The GtkWebView - * Returns: A string containing the font face or %NULL if none is set.
+ * @return A string containing the font face or @c NULL if none is set. char *gtk_webview_get_current_fontface(GtkWebView *webview);
@@ -326,9 +326,9 @@
* Returns a string containing the selected foreground color at the current
* position in a GtkWebView.
- * @webview: The GtkWebView
+ * @param webview The GtkWebView - * Returns: A string containing the foreground color or %NULL if none is set.
+ * @return A string containing the foreground color or @c NULL if none is set. char *gtk_webview_get_current_forecolor(GtkWebView *webview);
@@ -336,9 +336,9 @@
* Returns a string containing the selected font background color at the current
* position in a GtkWebView.
- * @webview: The GtkWebView
+ * @param webview The GtkWebView - * Returns: A string containing the background color or %NULL if none is set.
+ * @return A string containing the background color or @c NULL if none is set. char *gtk_webview_get_current_backcolor(GtkWebView *webview);
@@ -346,45 +346,45 @@
* Returns a integer containing the selected HTML font size at the current
* position in a GtkWebView.
- * @webview: The GtkWebView
+ * @param webview The GtkWebView - * Returns: The HTML font size.
+ * @return The HTML font size. gint gtk_webview_get_current_fontsize(GtkWebView *webview);
* Gets the content of the head element of a GtkWebView as HTML.
- * @webview: The GtkWebView
+ * @param webview The GtkWebView - * Returns: The HTML from the head element.
+ * @return The HTML from the head element. gchar *gtk_webview_get_head_html(GtkWebView *webview);
* Gets the HTML content of a GtkWebView.
- * @webview: The GtkWebView
+ * @param webview The GtkWebView - * Returns: The HTML that is currently displayed.
+ * @return The HTML that is currently displayed. gchar *gtk_webview_get_body_html(GtkWebView *webview);
* Gets the text content of a GtkWebView.
- * @webview: The GtkWebView
+ * @param webview The GtkWebView - * Returns: The HTML-free text that is currently displayed.
+ * @return The HTML-free text that is currently displayed. gchar *gtk_webview_get_body_text(GtkWebView *webview);
* Gets the selected text of a GtkWebView.
- * @webview: The GtkWebView
+ * @param webview The GtkWebView - * Returns: The HTML-free text that is currently selected, or NULL if nothing is
+ * @return The HTML-free text that is currently selected, or NULL if nothing is gchar *gtk_webview_get_selected_text(GtkWebView *webview);
@@ -393,11 +393,11 @@
* Gets the container of the caret, along with its position in the container
- * @webview: The GtkWebView
- * @container_ret: A pointer to a pointer to a WebKitDOMNode. This pointer
+ * @param webview The GtkWebView + * @param container_ret A pointer to a pointer to a WebKitDOMNode. This pointer * will be set to the container the caret is in. Set to
- * %NULL if a range is selected.
- * @pos_ret: A pointer to a glong. This value will be set to the
+ * @c NULL if a range is selected. + * @param pos_ret A pointer to a glong. This value will be set to the * position of the caret in the container. Set to -1 if a
@@ -407,9 +407,9 @@
* Sets the caret position in container, in a GtkWebView.
- * @webview: The GtkWebView
- * @container: The WebKitDOMNode to set the caret in
- * @pos: The position of the caret in the container
+ * @param webview The GtkWebView + * @param container The WebKitDOMNode to set the caret in + * @param pos The position of the caret in the container void gtk_webview_set_caret(GtkWebView *webview, WebKitDOMNode *container,
@@ -417,35 +417,35 @@
* Clear all the formatting on a GtkWebView.
- * @webview: The GtkWebView
+ * @param webview The GtkWebView void gtk_webview_clear_formatting(GtkWebView *webview);
* Toggles bold at the cursor location or selection in a GtkWebView.
- * @webview: The GtkWebView
+ * @param webview The GtkWebView void gtk_webview_toggle_bold(GtkWebView *webview);
* Toggles italic at the cursor location or selection in a GtkWebView.
- * @webview: The GtkWebView
+ * @param webview The GtkWebView void gtk_webview_toggle_italic(GtkWebView *webview);
* Toggles underline at the cursor location or selection in a GtkWebView.
- * @webview: The GtkWebView
+ * @param webview The GtkWebView void gtk_webview_toggle_underline(GtkWebView *webview);
* Toggles strikethrough at the cursor location or selection in a GtkWebView.
- * @webview: The GtkWebView
+ * @param webview The GtkWebView void gtk_webview_toggle_strike(GtkWebView *webview);
@@ -453,10 +453,10 @@
* Toggles a foreground color at the current location or selection in a
- * @webview: The GtkWebView
- * @color: The HTML-style color, or %NULL or "" to clear the color.
+ * @param webview The GtkWebView + * @param color The HTML-style color, or @c NULL or "" to clear the color. - * Returns: %TRUE if a color was set, or %FALSE if it was cleared.
+ * @return @c TRUE if a color was set, or @c FALSE if it was cleared. gboolean gtk_webview_toggle_forecolor(GtkWebView *webview, const char *color);
@@ -464,28 +464,28 @@
* Toggles a background color at the current location or selection in a
- * @webview: The GtkWebView
- * @color: The HTML-style color, or %NULL or "" to clear the color.
+ * @param webview The GtkWebView + * @param color The HTML-style color, or @c NULL or "" to clear the color. - * Returns: %TRUE if a color was set, or %FALSE if it was cleared.
+ * @return @c TRUE if a color was set, or @c FALSE if it was cleared. gboolean gtk_webview_toggle_backcolor(GtkWebView *webview, const char *color);
* Toggles a font face at the current location or selection in a GtkWebView.
- * @webview: The GtkWebView
- * @face: The font face name, or %NULL or "" to clear the font.
+ * @param webview The GtkWebView + * @param face The font face name, or @c NULL or "" to clear the font. - * Returns: %TRUE if a font name was set, or %FALSE if it was cleared.
+ * @return @c TRUE if a font name was set, or @c FALSE if it was cleared. gboolean gtk_webview_toggle_fontface(GtkWebView *webview, const char *face);
* Sets the font size at the current location or selection in a GtkWebView.
- * @webview: The GtkWebView
- * @size: The HTML font size to use.
+ * @param webview The GtkWebView + * @param size The HTML font size to use. void gtk_webview_font_set_size(GtkWebView *webview, gint size);
@@ -493,7 +493,7 @@
* Decreases the font size by 1 at the current location or selection in a
- * @webview: The GtkWebView
+ * @param webview The GtkWebView void gtk_webview_font_shrink(GtkWebView *webview);
@@ -501,7 +501,7 @@
* Increases the font size by 1 at the current location or selection in a
- * @webview: The GtkWebView
+ * @param webview The GtkWebView void gtk_webview_font_grow(GtkWebView *webview);
@@ -509,16 +509,16 @@
* Inserts a horizontal rule at the current location or selection in a
- * @webview: The GtkWebView
+ * @param webview The GtkWebView void gtk_webview_insert_hr(GtkWebView *webview);
* Inserts a link at the current location or selection in a GtkWebView.
- * @webview: The GtkWebView
- * @url: The URL of the link
- * @desc: The text description of the link. If not supplied, the URL is
+ * @param webview The GtkWebView + * @param url The URL of the link + * @param desc The text description of the link. If not supplied, the URL is void gtk_webview_insert_link(GtkWebView *webview, const char *url, const char *desc);
@@ -526,36 +526,36 @@
* Inserts an image at the current location or selection in a GtkWebView.
- * @webview: The GtkWebView
- * @id: The PurpleStoredImage id
+ * @param webview The GtkWebView + * @param id The PurpleStoredImage id void gtk_webview_insert_image(GtkWebView *webview, int id);
* Gets the protocol name associated with this GtkWebView.
- * @webview: The GtkWebView
+ * @param webview The GtkWebView const char *gtk_webview_get_protocol_name(GtkWebView *webview);
* Associates a protocol name with a GtkWebView.
- * @webview: The GtkWebView
- * @protocol_name: The protocol name to associate with the GtkWebView
+ * @param webview The GtkWebView + * @param protocol_name The protocol name to associate with the GtkWebView void gtk_webview_set_protocol_name(GtkWebView *webview, const char *protocol_name);
* Create a new GtkWebViewSmiley.
- * @file: The image file for the smiley
- * @shortcut: The key shortcut for the smiley
- * @hide: %TRUE if the smiley should be hidden in the smiley dialog,
- * @flags: The smiley flags
+ * @param file The image file for the smiley + * @param shortcut The key shortcut for the smiley + * @param hide @c TRUE if the smiley should be hidden in the smiley dialog, + * @param flags The smiley flags - * Returns: The newly created smiley
+ * @return The newly created smiley GtkWebViewSmiley *gtk_webview_smiley_create(const char *file,
@@ -565,59 +565,59 @@
* Reload the image data for the smiley.
- * @smiley: The smiley to reload
+ * @param smiley The smiley to reload void gtk_webview_smiley_reload(GtkWebViewSmiley *smiley);
* Destroy a GtkWebViewSmiley.
- * @smiley: The smiley to destroy
+ * @param smiley The smiley to destroy void gtk_webview_smiley_destroy(GtkWebViewSmiley *smiley);
* Returns the text associated with a smiley.
+ * @param smiley The smiley
const char *gtk_webview_smiley_get_smile(const GtkWebViewSmiley *smiley);
* Returns the file associated with a smiley.
+ * @param smiley The smiley
const char *gtk_webview_smiley_get_file(const GtkWebViewSmiley *smiley);
* Returns the invisibility of a smiley.
+ * @param smiley The smiley - * Returns: The hidden status
+ * @return The hidden status gboolean gtk_webview_smiley_get_hidden(const GtkWebViewSmiley *smiley);
* Returns the flags associated with a smiley.
+ * @param smiley The smiley
GtkWebViewSmileyFlags gtk_webview_smiley_get_flags(const GtkWebViewSmiley *smiley);
* Returns the smiley object associated with the text.
- * @webview: The GtkWebView
- * @sml: The name of the smiley category
- * @text: The text associated with the smiley
+ * @param webview The GtkWebView + * @param sml The name of the smiley category + * @param text The text associated with the smiley GtkWebViewSmiley *gtk_webview_smiley_find(GtkWebView *webview, const char *sml,
@@ -625,9 +625,9 @@
* Associates a smiley with a GtkWebView.
- * @webview: The GtkWebView
- * @sml: The name of the smiley category
- * @smiley: The GtkWebViewSmiley to associate
+ * @param webview The GtkWebView + * @param sml The name of the smiley category + * @param smiley The GtkWebViewSmiley to associate void gtk_webview_associate_smiley(GtkWebView *webview, const char *sml,
GtkWebViewSmiley *smiley);
@@ -635,16 +635,16 @@
* Removes all smileys associated with a GtkWebView.
- * @webview: The GtkWebView.
+ * @param webview The GtkWebView. void gtk_webview_remove_smileys(GtkWebView *webview);
* Inserts a smiley at the current location or selection in a GtkWebView.
- * @webview: The GtkWebView
- * @sml: The category of the smiley
- * @smiley: The text of the smiley to insert
+ * @param webview The GtkWebView + * @param sml The category of the smiley + * @param smiley The text of the smiley to insert void gtk_webview_insert_smiley(GtkWebView *webview, const char *sml,
@@ -652,22 +652,22 @@
* Makes the toolbar associated with a GtkWebView visible.
- * @webview: The GtkWebView.
+ * @param webview The GtkWebView. void gtk_webview_show_toolbar(GtkWebView *webview);
* Makes the toolbar associated with a GtkWebView invisible.
- * @webview: The GtkWebView.
+ * @param webview The GtkWebView. void gtk_webview_hide_toolbar(GtkWebView *webview);
* Activate an action on the toolbar associated with a GtkWebView.
- * @webview: The GtkWebView
- * @action: The GtkWebViewAction
+ * @param webview The GtkWebView + * @param action The GtkWebViewAction void gtk_webview_activate_toolbar(GtkWebView *webview, GtkWebViewAction action);