/soc/2013/ankitkv/gobjectification: 7bfe75a37af7: Convert docs f...
Ankit Vani
a at nevitus.org
Fri Jan 31 09:38:45 EST 2014
Changeset: 7bfe75a37af799faca068b7a36eac0a52a607a87
Author: Ankit Vani <a at nevitus.org>
Date: 2014-01-31 19:38 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/7bfe75a37af7
Description:
Convert docs from doxygen to gtk-doc format for account*, blist*, media/*
diffstat:
libpurple/account.h | 599 +++++++++++++++++++++++----------------
libpurple/accountopt.h | 183 +++++++----
libpurple/accounts.h | 56 ++-
libpurple/blistnode.h | 191 ++++++++----
libpurple/blistnodetypes.h | 274 +++++++++++------
libpurple/media/backend-fs2.h | 8 +-
libpurple/media/backend-iface.h | 65 ++-
libpurple/media/candidate.h | 92 +++--
libpurple/media/codec.h | 73 +++-
libpurple/media/enum-types.h | 54 +++-
10 files changed, 1005 insertions(+), 590 deletions(-)
diffs (truncated from 3943 to 300 lines):
diff --git a/libpurple/account.h b/libpurple/account.h
--- a/libpurple/account.h
+++ b/libpurple/account.h
@@ -36,9 +36,7 @@
#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);
@@ -59,14 +57,19 @@ typedef void (*PurpleGetPublicAliasFailu
#include "xmlnode.h"
/**
+ * PurpleAccountRequestType:
+ * @PURPLE_ACCOUNT_REQUEST_AUTHORIZATION: Account authorization request
+ *
* Account request types.
*/
typedef enum
{
- PURPLE_ACCOUNT_REQUEST_AUTHORIZATION = 0 /* Account authorization request */
+ PURPLE_ACCOUNT_REQUEST_AUTHORIZATION = 0
} PurpleAccountRequestType;
/**
+ * PurpleAccountRequestResponse:
+ *
* Account request response types
*/
typedef enum
@@ -78,6 +81,8 @@ typedef enum
} PurpleAccountRequestResponse;
/**
+ * PurpleAccountPrivacyType:
+ *
* Privacy data types.
*/
typedef enum
@@ -90,15 +95,16 @@ typedef enum
} PurpleAccountPrivacyType;
/**
+ * PurpleAccount:
+ * @ui_data: The UI data associated with this account. This is a convenience
+ * field provided to the UIs -- it is not used by the libpurple core.
+ *
* Structure representing an account.
*/
struct _PurpleAccount
{
GObject gparent;
- /** 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 ui_data;
};
@@ -125,95 +131,113 @@ G_BEGIN_DECLS
/*@{*/
/**
+ * purple_account_get_type:
+ *
* Returns the GType for the Account object.
*/
GType purple_account_get_type(void);
/**
- * Creates a new account.
- *
+ * purple_account_new:
* @username: The username.
* @protocol_id: The protocol ID.
*
+ * Creates a new account.
+ *
* Returns: 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.
- *
- * @account: The account to connect to.
*/
void purple_account_connect(PurpleAccount *account);
/**
- * Sets the callback for successful registration.
- *
+ * 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
+ *
+ * Sets the callback for successful registration.
*/
void purple_account_set_register_callback(PurpleAccount *account, PurpleAccountRegistrationCb cb, void *user_data);
/**
+ * purple_account_register:
+ * @account: The account to register.
+ *
* Registers an account.
- *
- * @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().
- *
- * @account: The account being registered.
- * @succeeded: Was the account registration successful?
*/
void purple_account_register_completed(PurpleAccount *account, gboolean succeeded);
/**
- * Unregisters an account (deleting it from the server).
- *
+ * 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).
*/
void purple_account_unregister(PurpleAccount *account, PurpleAccountUnregistrationCb cb, void *user_data);
/**
+ * purple_account_disconnect:
+ * @account: The account to disconnect from.
+ *
* Disconnects from an account.
- *
- * @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.
*
- * @account: The account
- *
* Returns: 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
* buddy list.
*
* This will present a dialog informing the user that he was added to the
* remote user's buddy list.
- *
- * @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.
*/
void purple_account_notify_added(PurpleAccount *account, const char *remote_user,
const char *id, const char *alias,
const char *message);
/**
+ * 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
* list.
@@ -221,24 +245,13 @@ void purple_account_notify_added(PurpleA
* 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.
- *
- * @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.
*/
void purple_account_request_add(PurpleAccount *account, const char *remote_user,
const char *id, const char *alias,
const char *message);
/**
- * 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.
- *
+ * 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.
@@ -249,6 +262,12 @@ void purple_account_request_add(PurpleAc
* @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.
*/
void *purple_account_request_authorization(PurpleAccount *account, const char *remote_user,
@@ -256,199 +275,219 @@ void *purple_account_request_authorizati
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
- *
- * @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
- *
- * @ui_handle: The ui specific handle for which requests should be closed
*/
void purple_account_request_close(void *ui_handle);
/**
- * Requests a password from the user for the account. Does not set the
- * account password on success; do that in ok_cb if desired.
- *
+ * 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.
*/
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.
- *
- * @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
* user information.
- *
- * @account: The account to change the user information on.
*/
void purple_account_request_change_user_info(PurpleAccount *account);
/**
More information about the Commits
mailing list