/soc/2013/ankitkv/gobjectification: ab926e75ab5b: Convert doxyge...
Ankit Vani
a at nevitus.org
Wed Jan 29 14:20:03 EST 2014
Changeset: ab926e75ab5beb505317144e1032ed4a3030dfe5
Author: Ankit Vani <a at nevitus.org>
Date: 2014-01-30 00:39 +0530
Branch: soc.2013.gobjectification.gtkdoc
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/ab926e75ab5b
Description:
Convert doxygen comments to gtk-doc format in accounts, blist, buddyicon, certificate, cipher
diffstat:
libpurple/account.h | 5 +-
libpurple/accountopt.h | 183 +++++++++++++++++++-----------
libpurple/accounts.h | 56 ++++++--
libpurple/blistnode.h | 191 ++++++++++++++++++++-----------
libpurple/blistnodetypes.h | 266 ++++++++++++++++++++++++++++---------------
libpurple/buddyicon.h | 218 ++++++++++++++++++++++--------------
libpurple/buddylist.h | 184 +++++++++++++++++++----------
libpurple/certificate.h | 269 +++++++++++++++++++++++++++++++-------------
libpurple/cipher.h | 115 +++++++++++-------
9 files changed, 958 insertions(+), 529 deletions(-)
diffs (truncated from 3786 to 300 lines):
diff --git a/libpurple/account.h b/libpurple/account.h
--- a/libpurple/account.h
+++ b/libpurple/account.h
@@ -96,6 +96,8 @@ typedef enum
/**
* 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.
*/
@@ -103,9 +105,6 @@ 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;
};
diff --git a/libpurple/accountopt.h b/libpurple/accountopt.h
--- a/libpurple/accountopt.h
+++ b/libpurple/accountopt.h
@@ -32,9 +32,24 @@
/** Data Structures */
/**************************************************************************/
-/** @copydoc _PurpleAccountOption */
+/**
+ * PurpleAccountOption:
+ *
+ * An option for an account.
+ *
+ * This is set by protocols, and appears in the account settings
+ * dialogs.
+ */
typedef struct _PurpleAccountOption PurpleAccountOption;
-/** @copydoc _PurpleAccountUserSplit */
+
+/**
+ * PurpleAccountUserSplit:
+ *
+ * A username split.
+ *
+ * This is used by some protocols to separate the fields of the username
+ * into more human-readable components.
+ */
typedef struct _PurpleAccountUserSplit PurpleAccountUserSplit;
G_BEGIN_DECLS
@@ -45,57 +60,66 @@ G_BEGIN_DECLS
/*@{*/
/**
+ * purple_account_option_new:
+ * @type: The type of option.
+ * @text: The text of the option.
+ * @pref_name: The account preference name for the option.
+ *
* Creates a new account option. If you know what @a type will be in advance,
* consider using purple_account_option_bool_new(),
* purple_account_option_int_new(), purple_account_option_string_new() or
* purple_account_option_list_new() (as appropriate) instead.
*
- * @type: The type of option.
- * @text: The text of the option.
- * @pref_name: The account preference name for the option.
- *
* Returns: The account option.
*/
PurpleAccountOption *purple_account_option_new(PurplePrefType type,
const char *text, const char *pref_name);
/**
- * Creates a new boolean account option.
- *
+ * purple_account_option_bool_new:
* @text: The text of the option.
* @pref_name: The account preference name for the option.
* @default_value: The default value.
*
+ * Creates a new boolean account option.
+ *
* Returns: The account option.
*/
PurpleAccountOption *purple_account_option_bool_new(const char *text,
const char *pref_name, gboolean default_value);
/**
- * Creates a new integer account option.
- *
+ * purple_account_option_int_new:
* @text: The text of the option.
* @pref_name: The account preference name for the option.
* @default_value: The default value.
*
+ * Creates a new integer account option.
+ *
* Returns: The account option.
*/
PurpleAccountOption *purple_account_option_int_new(const char *text,
const char *pref_name, int default_value);
/**
- * Creates a new string account option.
- *
+ * purple_account_option_string_new:
* @text: The text of the option.
* @pref_name: The account preference name for the option.
* @default_value: The default value.
*
+ * Creates a new string account option.
+ *
* Returns: The account option.
*/
PurpleAccountOption *purple_account_option_string_new(const char *text,
const char *pref_name, const char *default_value);
/**
+ * purple_account_option_list_new:
+ * @text: The text of the option.
+ * @pref_name: The account preference name for the option.
+ * @list: The key, value list.
+ *
* Creates a new list account option.
*
* The list passed will be owned by the account option, and the
@@ -106,73 +130,79 @@ PurpleAccountOption *purple_account_opti
* the internal ID that should be passed to purple_account_set_string() to
* choose that value.
*
- * @text: The text of the option.
- * @pref_name: The account preference name for the option.
- * @list: The key, value list.
- *
* Returns: The account option.
*/
PurpleAccountOption *purple_account_option_list_new(const char *text,
const char *pref_name, GList *list);
/**
+ * purple_account_option_destroy:
+ * @option: The option to destroy.
+ *
* Destroys an account option.
- *
- * @option: The option to destroy.
*/
void purple_account_option_destroy(PurpleAccountOption *option);
/**
- * Sets the default boolean value for an account option.
- *
+ * purple_account_option_set_default_bool:
* @option: The account option.
* @value: The default boolean value.
+ *
+ * Sets the default boolean value for an account option.
*/
void purple_account_option_set_default_bool(PurpleAccountOption *option,
gboolean value);
/**
- * Sets the default integer value for an account option.
- *
+ * purple_account_option_set_default_int:
* @option: The account option.
* @value: The default integer value.
+ *
+ * Sets the default integer value for an account option.
*/
void purple_account_option_set_default_int(PurpleAccountOption *option,
int value);
/**
- * Sets the default string value for an account option.
- *
+ * purple_account_option_set_default_string:
* @option: The account option.
* @value: The default string value.
+ *
+ * Sets the default string value for an account option.
*/
void purple_account_option_set_default_string(PurpleAccountOption *option,
const char *value);
/**
+ * purple_account_option_string_set_masked:
+ * @option: The account option.
+ * @masked: The masking.
+ *
* Sets the masking for an account option. Setting this to %TRUE acts
* as a hint to the UI that the option's value should be obscured from
* view, like a password.
- *
- * @option: The account option.
- * @masked: The masking.
*/
void
purple_account_option_string_set_masked(PurpleAccountOption *option, gboolean masked);
/**
+ * purple_account_option_string_set_hints:
+ * @option: The account option.
+ * @hints: The list of hints, stored as strings.
+ *
* Sets the hint list for an account option.
*
* 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.
*/
void purple_account_option_string_set_hints(PurpleAccountOption *option,
GSList *hints);
/**
+ * purple_account_option_set_list:
+ * @option: The account option.
+ * @values: The default list value.
+ *
* Sets the list values for an account option.
*
* The list passed will be owned by the account option, and the
@@ -180,115 +210,123 @@ void purple_account_option_string_set_hi
*
* 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.
*/
void purple_account_option_set_list(PurpleAccountOption *option, GList *values);
/**
- * Adds an item to a list account option.
- *
+ * purple_account_option_add_list_item:
* @option: The account option.
* @key: The key.
* @value: The value.
+ *
+ * Adds an item to a list account option.
*/
void purple_account_option_add_list_item(PurpleAccountOption *option,
const char *key, const char *value);
/**
+ * purple_account_option_get_type:
+ * @option: The account option.
+ *
* Returns the specified account option's type.
*
- * @option: The account option.
- *
* Returns: The account option's type.
*/
PurplePrefType purple_account_option_get_type(const PurpleAccountOption *option);
/**
+ * purple_account_option_get_text:
+ * @option: The account option.
+ *
* Returns the text for an account option.
*
- * @option: The account option.
- *
* Returns: The account option's text.
*/
const char *purple_account_option_get_text(const PurpleAccountOption *option);
/**
+ * purple_account_option_get_setting:
+ * @option: The account option.
+ *
* Returns the name of an account option. This corresponds to the @c pref_name
* parameter supplied to purple_account_option_new() or one of the
* type-specific constructors.
*
- * @option: The account option.
- *
* Returns: The option's name.
*/
const char *purple_account_option_get_setting(const PurpleAccountOption *option);
/**
+ * purple_account_option_get_default_bool:
+ * @option: The account option.
+ *
* Returns the default boolean value for an account option.
*
- * @option: The account option.
- *
* Returns: The default boolean value.
*/
gboolean purple_account_option_get_default_bool(const PurpleAccountOption *option);
More information about the Commits
mailing list