changeset
Add (scope) annotation to callback parameters (account.h to proxy.h)
Thu, 03 Apr 2014 09:26:19 +0530
- author
- Ankit Vani <a@nevitus.org>
- date
- Thu, 03 Apr 2014 09:26:19 +0530
- changeset 35682
- 65c1912ee2c8
- parent 35681
- 54694ef14d46
- child 35683
- 8b6b8a3b5039
- child 37131
- fe9ff76f1c6c
Add (scope) annotation to callback parameters (account.h to proxy.h)
--- a/libpurple/account.h Thu Apr 03 04:58:04 2014 +0200 +++ b/libpurple/account.h Thu Apr 03 09:26:19 2014 +0530 @@ -160,9 +160,9 @@ /** * purple_account_set_register_callback: - * @account: The account for which this callback should be used - * @cb: The callback - * @user_data: The user data passed to the callback + * @account: The account for which this callback should be used + * @cb: (scope call): The callback + * @user_data: The user data passed to the callback * * Sets the callback for successful registration. */ @@ -189,8 +189,9 @@ /** * 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 + * @cb: (scope call): 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). */ @@ -260,8 +261,8 @@ * @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 + * @auth_cb: (scope call): The callback called when the local user accepts + * @deny_cb: (scope call): 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 @@ -295,8 +296,8 @@ /** * 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. + * @ok_cb: (scope call): The callback for the OK button. + * @cancel_cb: (scope call): 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 @@ -335,7 +336,7 @@ * purple_account_set_password: * @account: The account. * @password: The password. - * @cb: A callback for once the password is saved. + * @cb: (scope call): A callback for once the password is saved. * @data: A pointer to be passed to the callback. * * Sets the account's password. @@ -494,12 +495,12 @@ * 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). + * to unset the alias/nickname (or return it to + * a protocol-specific "default", like the username) + * @success_cb: (scope call): A callback which will be called if the alias + * is successfully set on the server (or %NULL). + * @failure_cb: (scope call): 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. @@ -514,9 +515,9 @@ /** * 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. + * @success_cb: (scope call): A callback which will be called with the alias + * @failure_cb: (scope call): 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. @@ -694,7 +695,7 @@ /** * purple_account_get_password: * @account: The account. - * @cb: The callback to give the password. + * @cb: (scope call): The callback to give the password. * @data: A pointer passed to the callback. * * Reads the password for the account.
--- a/libpurple/certificate.h Thu Apr 03 04:58:04 2014 +0200 +++ b/libpurple/certificate.h Thu Apr 03 09:26:19 2014 +0530 @@ -363,19 +363,19 @@ /** * purple_certificate_verify: - * @verifier: Verification logic to use. - * See purple_certificate_find_verifier(). - * @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 - * 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 - * Request struct. - * @cb: Callback function to be called with whether the - * certificate was approved or not. - * @cb_data: User-defined data for the above. + * @verifier: Verification logic to use. + * See purple_certificate_find_verifier(). + * @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 + * 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 + * Request struct. + * @cb: (scope call): Callback function to be called with whether the + * certificate was approved or not. + * @cb_data: User-defined data for the above. * * Constructs a verification request and passed control to the specified Verifier *
--- a/libpurple/cmds.h Thu Apr 03 04:58:04 2014 +0200 +++ b/libpurple/cmds.h Thu Apr 03 09:26:19 2014 +0530 @@ -131,46 +131,47 @@ * @cmd: The command. This should be a UTF-8 (or ASCII) string, with no spaces * or other white space. * @args: A string of characters describing to libpurple how to parse this - * command's arguments. If what the user types doesn't match this - * pattern, libpurple will keep looking for another command, unless - * the flag #PURPLE_CMD_FLAG_ALLOW_WRONG_ARGS is passed in @f. - * This string should contain no whitespace, and use a single - * character for each argument. The recognized characters are: - * <itemizedlist> - * <listitem><literal>'w'</literal>: Matches a single word.</listitem> - * <listitem><literal>'W'</literal>: Matches a single word, with - * formatting.</listitem> - * <listitem><literal>'s'</literal>: Matches the rest of the - * arguments after this point, - * as a single string.</listitem> - * <listitem><literal>'S'</literal>: Same as <literal>'s'</literal> - * but with formatting.</listitem> - * </itemizedlist> - * If args is the empty string, then the command accepts no - * arguments. The args passed to the callback @func will be a %NULL - * terminated array of %NULL terminated strings, and will always - * match the number of arguments asked for, unless - * #PURPLE_CMD_FLAG_ALLOW_WRONG_ARGS is passed. + * command's arguments. If what the user types doesn't match this + * pattern, libpurple will keep looking for another command, unless + * the flag #PURPLE_CMD_FLAG_ALLOW_WRONG_ARGS is passed in @f. + * This string should contain no whitespace, and use a single + * character for each argument. The recognized characters are: + * <itemizedlist> + * <listitem><literal>'w'</literal>: Matches a single word.</listitem> + * <listitem><literal>'W'</literal>: Matches a single word, with + * formatting.</listitem> + * <listitem><literal>'s'</literal>: Matches the rest of the + * arguments after this point, + * as a single string.</listitem> + * <listitem><literal>'S'</literal>: Same as <literal>'s'</literal> + * but with formatting.</listitem> + * </itemizedlist> + * If args is the empty string, then the command accepts no + * arguments. The args passed to the callback @func will be a %NULL + * terminated array of %NULL terminated strings, and will always + * match the number of arguments asked for, unless + * #PURPLE_CMD_FLAG_ALLOW_WRONG_ARGS is passed. * @p: This is the priority. Higher priority commands will be run first, - * and usually the first command will stop any others from being - * called. + * and usually the first command will stop any others from being + * called. * @f: Flags specifying various options about this command, combined with - * <literal>|</literal> (bitwise OR). You need to at least pass one of - * #PURPLE_CMD_FLAG_IM or #PURPLE_CMD_FLAG_CHAT (you may pass both) in - * order for the command to ever actually be called. + * <literal>|</literal> (bitwise OR). You need to at least pass one of + * #PURPLE_CMD_FLAG_IM or #PURPLE_CMD_FLAG_CHAT (you may pass both) in + * order for the command to ever actually be called. * @protocol_id: If the #PURPLE_CMD_FLAG_PRPL_ONLY flag is set, this is the id * of the protocol to which the command applies (such as * <literal>"prpl-msn"</literal>). If the flag is not set, this * parameter is ignored; pass %NULL (or a humourous string of * your choice!). - * @func: This is the function to call when someone enters this command. + * @func: (scope call): This is the function to call when someone enters this + * command. * @helpstr: a whitespace sensitive, UTF-8, HTML string describing how to - * use the command. The preferred format of this string is the - * command's name, followed by a space and any arguments it - * accepts (if it takes any arguments, otherwise no space), - * followed by a colon, two spaces, and a description of the - * command in sentence form. Do not include a slash before the - * command name. + * use the command. The preferred format of this string is the + * command's name, followed by a space and any arguments it + * accepts (if it takes any arguments, otherwise no space), + * followed by a colon, two spaces, and a description of the + * command in sentence form. Do not include a slash before the + * command name. * @data: User defined data to pass to the #PurpleCmdFunc @f. * * Register a new command with the core.
--- a/libpurple/dnsquery.h Thu Apr 03 04:58:04 2014 +0200 +++ b/libpurple/dnsquery.h Thu Apr 03 09:26:19 2014 +0530 @@ -115,7 +115,7 @@ * @account: The account that the query is being done for (or NULL) * @hostname: The hostname to resolve. * @port: A port number which is stored in the struct sockaddr. - * @callback: The callback function to call after resolving. + * @callback: (scope call): The callback function to call after resolving. * @data: Extra data to pass to the callback function. * * Perform an asynchronous DNS query.
--- a/libpurple/dnssrv.h Thu Apr 03 04:58:04 2014 +0200 +++ b/libpurple/dnssrv.h Thu Apr 03 09:26:19 2014 +0530 @@ -114,34 +114,34 @@ /** * purple_srv_resolve: - * @account: The account that the query is being done for (or NULL) + * @account: The account that the query is being done for (or %NULL) * @protocol: Name of the protocol (e.g. "sip") * @transport: Name of the transport ("tcp" or "udp") * @domain: Domain name to query (e.g. "blubb.com") - * @cb: A callback which will be called with the results + * @cb: (scope call): A callback which will be called with the results * @extradata: Extra data to be passed to the callback * * Queries an SRV record. * - * Returns: NULL if there was an error, otherwise return a reference to - * a data structure that can be used to cancel the pending - * DNS query, if needed. + * Returns: %NULL if there was an error, otherwise return a reference to + * a data structure that can be used to cancel the pending + * DNS query, if needed. */ PurpleSrvTxtQueryData *purple_srv_resolve(PurpleAccount *account, const char *protocol, const char *transport, const char *domain, PurpleSrvCallback cb, gpointer extradata); /** * purple_txt_resolve: - * @account: The account that the query is being done for (or NULL) + * @account: The account that the query is being done for (or %NULL) * @owner: Name of the protocol (e.g. "_xmppconnect") * @domain: Domain name to query (e.g. "blubb.com") - * @cb: A callback which will be called with the results + * @cb: (scope call): A callback which will be called with the results * @extradata: Extra data to be passed to the callback * * Queries an TXT record. * - * Returns: NULL if there was an error, otherwise return a reference to - * a data structure that can be used to cancel the pending - * DNS query, if needed. + * Returns: %NULL if there was an error, otherwise return a reference to + * a data structure that can be used to cancel the pending + * DNS query, if needed. */ PurpleSrvTxtQueryData *purple_txt_resolve(PurpleAccount *account, const char *owner, const char *domain, PurpleTxtCallback cb, gpointer extradata);
--- a/libpurple/e2ee.h Thu Apr 03 04:58:04 2014 +0200 +++ b/libpurple/e2ee.h Thu Apr 03 09:26:19 2014 +0530 @@ -216,7 +216,7 @@ /** * purple_e2ee_provider_set_conv_menu_cb: * @provider: The E2EE provider. - * @conv_menu_cb: The callback. + * @conv_menu_cb: (scope call): The callback. * * Sets the conversation menu callback for the E2EE provider. *
--- a/libpurple/eventloop.h Thu Apr 03 04:58:04 2014 +0200 +++ b/libpurple/eventloop.h Thu Apr 03 09:26:19 2014 +0530 @@ -158,10 +158,9 @@ /** * purple_timeout_add: - * @interval: The time between calls of the function, in - * milliseconds. - * @function: The function to call. - * @data: data to pass to @function. + * @interval: The time between calls of the function, in milliseconds. + * @function: (scope call): The function to call. + * @data: data to pass to @function. * * Creates a callback timer. * @@ -178,10 +177,9 @@ /** * purple_timeout_add_seconds: - * @interval: The time between calls of the function, in - * seconds. - * @function: The function to call. - * @data: data to pass to @function. + * @interval: The time between calls of the function, in seconds. + * @function: (scope call): The function to call. + * @data: data to pass to @function. * * Creates a callback timer. * @@ -210,7 +208,7 @@ * purple_input_add: * @fd: The input file descriptor. * @cond: The condition type. - * @func: The callback function for data. + * @func: (scope call): The callback function for data. * @user_data: User-specified data. * * Adds an input handler.
--- a/libpurple/http.h Thu Apr 03 04:58:04 2014 +0200 +++ b/libpurple/http.h Thu Apr 03 09:26:19 2014 +0530 @@ -156,7 +156,7 @@ /** * purple_http_get: * @gc: The connection for which the request is needed, or NULL. - * @callback: The callback function. + * @callback: (scope call): The callback function. * @user_data: The user data to pass to the callback function. * @url: The URL. * @@ -171,7 +171,7 @@ /** * purple_http_get_printf: * @gc: The connection for which the request is needed, or NULL. - * @callback: The callback function. + * @callback: (scope call): The callback function. * @user_data: The user data to pass to the callback function. * @format: The format string. * @@ -188,7 +188,7 @@ * purple_http_request: * @gc: The connection for which the request is needed, or NULL. * @request: The request. - * @callback: The callback function. + * @callback: (scope call): The callback function. * @user_data: The user data to pass to the callback function. * * Fetches a HTTP request and passes the response to a callback function. @@ -266,11 +266,11 @@ /** * purple_http_conn_set_progress_watcher: - * @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 - * watcher, or -1 for default. + * @http_conn: The HTTP connection. + * @watcher: (scope call): The watcher. + * @user_data: The user data to pass to the callback function. + * @interval_threshold: Minimum interval (in microseconds) of calls to + * watcher, or -1 for default. * * Sets the watcher, called after writing or reading data to/from HTTP stream. * May be used for updating transfer progress gauge. @@ -602,10 +602,10 @@ /** * purple_http_request_set_contents_reader: - * @request: The request. - * @reader: The reader callback. - * @contents_length: The size of all contents. - * @user_data: The user data to pass to the callback function. + * @request: The request. + * @reader: (scope call): The reader callback. + * @contents_length: The size of all contents. + * @user_data: The user data to pass to the callback function. * * Sets contents reader for HTTP request, used mainly for possible large * uploads. @@ -615,9 +615,9 @@ /** * purple_http_request_set_response_writer: - * @request: The request. - * @writer: The writer callback, or %NULL to remove existing. - * @user_data: The user data to pass to the callback function. + * @request: The request. + * @writer: (scope call): The writer callback, or %NULL to remove existing. + * @user_data: The user data to pass to the callback function. * * Set contents writer for HTTP response. */
--- a/libpurple/keyring.h Thu Apr 03 04:58:04 2014 +0200 +++ b/libpurple/keyring.h Thu Apr 03 09:26:19 2014 +0530 @@ -233,11 +233,11 @@ /** * purple_keyring_set_inuse: - * @newkeyring: The new keyring to use. - * @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. + * @newkeyring: The new keyring to use. + * @force: %FALSE if the change can be cancelled. If this is %TRUE + * and an error occurs, data might be lost. + * @cb: (scope call): A callback for once the change is complete. + * @data: Data to be passed to the callback. * * Set the keyring to use. This function will move all passwords from * the old keyring to the new one. @@ -329,9 +329,9 @@ /** * purple_keyring_get_password: - * @account: The account. - * @cb: A callback for once the password is read. - * @data: Data passed to the callback. + * @account: The account. + * @cb: (scope call): A callback for once the password is read. + * @data: Data passed to the callback. * * Read a password from the current keyring. */ @@ -341,10 +341,10 @@ /** * purple_keyring_set_password: - * @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. + * @account: The account. + * @password: The password to save. + * @cb: (scope call): A callback for once the password is saved. + * @data: Data to be passed to the callback. * * Save a password to the current keyring. */ @@ -476,8 +476,8 @@ /** * purple_keyring_set_read_password: - * @keyring: The keyring. - * @read_cb: Read password method. + * @keyring: The keyring. + * @read_cb: (scope call): Read password method. * * Sets read password method. * @@ -489,8 +489,8 @@ /** * purple_keyring_set_save_password: - * @keyring: The keyring. - * @save_cb: Save password method. + * @keyring: The keyring. + * @save_cb: (scope call): Save password method. * * Sets save password method. * @@ -500,29 +500,71 @@ purple_keyring_set_save_password(PurpleKeyring *keyring, PurpleKeyringSave save_cb); +/** + * purple_keyring_set_cancel_requests: + * @keyring: The keyring. + * @cancel_requests: (scope call): Cancel requests method. + * + * Sets cancel requests method. + */ void purple_keyring_set_cancel_requests(PurpleKeyring *keyring, PurpleKeyringCancelRequests cancel_requests); +/** + * purple_keyring_set_close_keyring: + * @keyring: The keyring. + * @close_cb: (scope call): Close keyring method. + * + * Sets close keyring method. + */ void purple_keyring_set_close_keyring(PurpleKeyring *keyring, PurpleKeyringClose close_cb); +/** + * purple_keyring_set_import_password: + * @keyring: The keyring. + * @import_password: (scope call): Import password method. + * + * Sets import password method. + */ void purple_keyring_set_import_password(PurpleKeyring *keyring, PurpleKeyringImportPassword import_password); +/** + * purple_keyring_set_export_password: + * @keyring: The keyring. + * @export_password: (scope call): Export password method. + * + * Sets export password method. + */ void purple_keyring_set_export_password(PurpleKeyring *keyring, PurpleKeyringExportPassword export_password); +/** + * purple_keyring_set_read_settings: + * @keyring: The keyring. + * @read_settings: (scope call): Read settings method. + * + * Sets read settings method. + */ void purple_keyring_set_read_settings(PurpleKeyring *keyring, -PurpleKeyringReadSettings read_settings); + PurpleKeyringReadSettings read_settings); +/** + * purple_keyring_set_apply_settings: + * @keyring: The keyring. + * @apply_settings: (scope call): Apply settings method. + * + * Sets apply settings method. + */ void purple_keyring_set_apply_settings(PurpleKeyring *keyring, -PurpleKeyringApplySettings apply_settings); + PurpleKeyringApplySettings apply_settings); /**************************************************************************/ /* Error Codes */
--- a/libpurple/network.h Thu Apr 03 04:58:04 2014 +0200 +++ b/libpurple/network.h Thu Apr 03 09:26:19 2014 +0530 @@ -116,19 +116,19 @@ * purple_network_listen: * @port: The port number to bind to. Must be greater than 0. * @socket_family: The protocol family of the socket. This should be - * AF_INET for IPv4 or AF_INET6 for IPv6. IPv6 sockets - * may or may not be able to accept IPv4 connections - * based on the system configuration (use - * purple_socket_speaks_ipv4 to check). If an IPv6 - * socket doesn't accept V4-mapped addresses, you will - * need a second listener to support both v4 and v6. + * AF_INET for IPv4 or AF_INET6 for IPv6. IPv6 sockets + * may or may not be able to accept IPv4 connections + * based on the system configuration (use + * purple_socket_speaks_ipv4 to check). If an IPv6 + * socket doesn't accept V4-mapped addresses, you will + * need a second listener to support both v4 and v6. * @socket_type: The type of socket to open for listening. - * This will be either SOCK_STREAM for TCP or SOCK_DGRAM for UDP. + * This will be either SOCK_STREAM for TCP or SOCK_DGRAM for UDP. * @map_external: Should the open port be mapped externally using - * NAT-PNP or UPnP? (default should be TRUE) - * @cb: The callback to be invoked when the port to listen on is available. - * The file descriptor of the listening socket will be specified in - * this callback, or -1 if no socket could be established. + * NAT-PNP or UPnP? (default should be %TRUE) + * @cb: (scope call): The callback to be invoked when the port to listen on is + * available. The file descriptor of the listening socket will be + * specified in this callback, or -1 if no socket could be established. * @cb_data: extra data to be returned when cb is called * * Attempts to open a listening port ONLY on the specified port number. @@ -148,8 +148,8 @@ * addresses, a mapping is done). * * Returns: A pointer to a data structure that can be used to cancel - * the pending listener, or NULL if unable to obtain a local - * socket to listen on. + * the pending listener, or %NULL if unable to obtain a local + * socket to listen on. */ PurpleNetworkListenData *purple_network_listen(unsigned short port, int socket_family, int socket_type, gboolean map_external, @@ -158,24 +158,24 @@ /** * purple_network_listen_range: * @start: The port number to bind to, or 0 to pick a random port. - * Users are allowed to override this arg in prefs. + * Users are allowed to override this arg in prefs. * @end: The highest possible port in the range of ports to listen on, - * or 0 to pick a random port. Users are allowed to override this - * arg in prefs. + * or 0 to pick a random port. Users are allowed to override this + * arg in prefs. * @socket_family: The protocol family of the socket. This should be - * AF_INET for IPv4 or AF_INET6 for IPv6. IPv6 sockets - * may or may not be able to accept IPv4 connections - * based on the system configuration (use - * purple_socket_speaks_ipv4 to check). If an IPv6 - * socket doesn't accept V4-mapped addresses, you will - * need a second listener to support both v4 and v6. + * AF_INET for IPv4 or AF_INET6 for IPv6. IPv6 sockets + * may or may not be able to accept IPv4 connections + * based on the system configuration (use + * purple_socket_speaks_ipv4 to check). If an IPv6 + * socket doesn't accept V4-mapped addresses, you will + * need a second listener to support both v4 and v6. * @socket_type: The type of socket to open for listening. - * This will be either SOCK_STREAM for TCP or SOCK_DGRAM for UDP. + * This will be either SOCK_STREAM for TCP or SOCK_DGRAM for UDP. * @map_external: Should the open port be mapped externally using - * NAT-PNP or UPnP? (default should be TRUE) - * @cb: The callback to be invoked when the port to listen on is available. - * The file descriptor of the listening socket will be specified in - * this callback, or -1 if no socket could be established. + * NAT-PNP or UPnP? (default should be %TRUE) + * @cb: (scope call): The callback to be invoked when the port to listen on is + * available. The file descriptor of the listening socket will be + * specified in this callback, or -1 if no socket could be established. * @cb_data: extra data to be returned when cb is called * * Opens a listening port selected from a range of ports. The range of @@ -196,8 +196,8 @@ * addresses, a mapping is done). * * Returns: A pointer to a data structure that can be used to cancel - * the pending listener, or NULL if unable to obtain a local - * socket to listen on. + * the pending listener, or %NULL if unable to obtain a local + * socket to listen on. */ PurpleNetworkListenData *purple_network_listen_range( unsigned short start, unsigned short end, int socket_family,
--- a/libpurple/notify.h Thu Apr 03 04:58:04 2014 +0200 +++ b/libpurple/notify.h Thu Apr 03 09:26:19 2014 +0530 @@ -236,14 +236,14 @@ * purple_notify_searchresults: * @gc: The PurpleConnection handle associated with the information. * @title: The title of the message. If this is NULL, the title - * will be "Search Results." + * 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 - * the notification. + * @cb: (scope call): The callback to call when the user closes + * the notification. * @user_data: The data to pass to the close callback and any other - * callback associated with a button. + * callback associated with a button. * * Displays results from a buddy search. This can be, for example, * a window with a list of all found buddies, where you are given the @@ -281,8 +281,8 @@ * purple_notify_searchresults_button_add: * @results: The search results object. * @type: Type of the button. (TODO: Only one button of a given type - * can be displayed.) - * @cb: Function that will be called on the click event. + * can be displayed.) + * @cb: (scope call): Function that will be called on the click event. * * Adds a stock button that will be displayed in the search results dialog. */ @@ -295,7 +295,7 @@ * purple_notify_searchresults_button_add_labeled: * @results: The search results object * @label: The label to display - * @cb: Function that will be called on the click event + * @cb: (scope call): Function that will be called on the click event * * Adds a plain labelled button that will be displayed in the search results * dialog. @@ -386,9 +386,9 @@ * @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 - * the notification. + * request, or %NULL if none is. + * @cb: (scope call): The callback to call when the user closes + * the notification. * @user_data: The data to pass to the callback. * * Displays a notification message to the user. @@ -407,8 +407,8 @@ * @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 - * the notification. + * @cb: (scope call): The callback to call when the user closes + * the notification. * @user_data: The data to pass to the callback. * * Displays a single email notification to the user. @@ -424,16 +424,16 @@ * purple_notify_emails: * @handle: The plugin or connection handle. * @count: The number of emails. '0' can be used to signify that - * the user has no unread emails and the UI should remove - * the mail notification. + * the user has no unread emails and the UI should remove + * the mail notification. * @detailed: %TRUE if there is information for each email in the - * arrays. + * arrays. * @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 - * the notification. + * @cb: (scope call): The callback to call when the user closes + * the notification. * @user_data: The data to pass to the callback. * * Displays a notification for multiple emails to the user. @@ -452,8 +452,8 @@ * @primary: The main point of the message. * @secondary: The secondary information. * @text: The formatted text. - * @cb: The callback to call when the user closes - * the notification. + * @cb: (scope call): The callback to call when the user closes + * the notification. * @user_data: The data to pass to the callback. * * Displays a notification with formatted text. @@ -472,7 +472,8 @@ * @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. + * @cb: (scope call): The callback to call when the user closes the + * notification. * @user_data: The data to pass to the callback. * * Displays user information with formatted text, passing information giving
--- a/libpurple/plugin.h Thu Apr 03 04:58:04 2014 +0200 +++ b/libpurple/plugin.h Thu Apr 03 09:26:19 2014 +0530 @@ -484,7 +484,7 @@ * purple_plugin_ipc_register: * @plugin: The plugin to register the command with. * @command: The name of the command. - * @func: The function to execute. + * @func: (scope call): The function to execute. * @marshal: The marshalling function. * @ret_type: The return type. * @num_params: The number of parameters. @@ -726,7 +726,8 @@ /** * purple_plugin_action_new: * @label: The description of the action to show to the user. - * @callback: The callback to call when the user selects this action. + * @callback: (scope call): The callback to call when the user selects this + * action. * * Allocates and returns a new PurplePluginAction. */
--- a/libpurple/pounce.h Thu Apr 03 04:58:04 2014 +0200 +++ b/libpurple/pounce.h Thu Apr 03 09:26:19 2014 +0530 @@ -335,7 +335,7 @@ /** * purple_pounces_register_handler: * @ui: The UI name. - * @cb: The callback function. + * @cb: (scope call): The callback function. * @new_pounce: The function called when a pounce is created. * @free_pounce: The function called when a pounce is freed. *
--- a/libpurple/prefs.h Thu Apr 03 04:58:04 2014 +0200 +++ b/libpurple/prefs.h Thu Apr 03 09:26:19 2014 +0530 @@ -360,7 +360,7 @@ * purple_prefs_connect_callback: * @handle: The handle of the receiver. * @name: The name of the preference - * @cb: The callback function + * @cb: (scope call): The callback function * @data: The data to pass to the callback function. * * Add a callback to a pref (and its children)
--- a/libpurple/proxy.h Thu Apr 03 04:58:04 2014 +0200 +++ b/libpurple/proxy.h Thu Apr 03 09:26:19 2014 +0530 @@ -248,17 +248,17 @@ /** * purple_proxy_connect: * @handle: A handle that should be associated with this - * connection attempt. The handle can be used - * to cancel the connection attempt using the - * purple_proxy_connect_cancel_with_handle() - * function. + * connection attempt. The handle can be used + * to cancel the connection attempt using the + * purple_proxy_connect_cancel_with_handle() + * function. * @account: The account making the connection. * @host: The destination host. * @port: The destination port. - * @connect_cb: The function to call when the connection is - * established. If the connection failed then - * fd will be -1 and error message will be set - * to something descriptive (hopefully). + * @connect_cb: (scope call): The function to call when the connection is + * established. If the connection failed then + * fd will be -1 and error message will be set + * to something descriptive (hopefully). * @data: User-defined data. * * Makes a connection to the specified host and port. Note that this @@ -278,17 +278,17 @@ /** * purple_proxy_connect_udp: * @handle: A handle that should be associated with this - * connection attempt. The handle can be used - * to cancel the connection attempt using the - * purple_proxy_connect_cancel_with_handle() - * function. + * connection attempt. The handle can be used + * to cancel the connection attempt using the + * purple_proxy_connect_cancel_with_handle() + * function. * @account: The account making the connection. * @host: The destination host. * @port: The destination port. - * @connect_cb: The function to call when the connection is - * established. If the connection failed then - * fd will be -1 and error message will be set - * to something descriptive (hopefully). + * @connect_cb: (scope call): The function to call when the connection is + * established. If the connection failed then + * fd will be -1 and error message will be set + * to something descriptive (hopefully). * @data: User-defined data. * * Makes a connection to the specified host and port. Note that this @@ -308,18 +308,18 @@ /** * purple_proxy_connect_socks5_account: * @handle: A handle that should be associated with this - * connection attempt. The handle can be used - * to cancel the connection attempt using the - * purple_proxy_connect_cancel_with_handle() - * function. + * connection attempt. The handle can be used + * to cancel the connection attempt using the + * purple_proxy_connect_cancel_with_handle() + * function. * @account: The account making the connection. * @gpi: The PurpleProxyInfo specifying the proxy settings * @host: The destination host. * @port: The destination port. - * @connect_cb: The function to call when the connection is - * established. If the connection failed then - * fd will be -1 and error message will be set - * to something descriptive (hopefully). + * @connect_cb: (scope call): The function to call when the connection is + * established. If the connection failed then + * fd will be -1 and error message will be set + * to something descriptive (hopefully). * @data: User-defined data. * * Makes a connection through a SOCKS5 proxy.
