Mercurial > pidgin
changeset 10071:af06746954de
[gaim-migrate @ 11047]
sf patch 1038040: Doxygen Fixes #3
This is from Jonathan Champ (royanee)
Thanks!
committer: Tailor Script <tailor@pidgin.im>
| author | Mark Doliner <mark@kingant.net> |
|---|---|
| date | Fri, 01 Oct 2004 22:08:39 +0000 |
| parents | 2b6bf836c6b9 |
| children | cf3454eadc22 |
| files | src/account.h src/blist.h src/eventloop.h src/prefs.h src/prpl.h src/status.h src/value.h |
| diffstat | 7 files changed, 24 insertions(+), 14 deletions(-) [+] |
line wrap: on
line diff
--- a/src/account.h Wed Sep 29 15:01:33 2004 +0000 +++ b/src/account.h Fri Oct 01 22:08:39 2004 +0000 @@ -96,6 +96,8 @@ * * @param username The username. * @param protocol_id The protocol ID. + * + * @return The new account. */ GaimAccount *gaim_account_new(const char *username, const char *protocol_id); @@ -128,8 +130,6 @@ * Disconnects from an account. * * @param account The account to disconnect from. - * - * @return The gaim connection. */ void gaim_account_disconnect(GaimAccount *account);
--- a/src/blist.h Wed Sep 29 15:01:33 2004 +0000 +++ b/src/blist.h Fri Oct 01 22:08:39 2004 +0000 @@ -212,13 +212,15 @@ /** * Creates a new buddy list + * + * @return The new buddy list. */ GaimBuddyList *gaim_blist_new(); /** * Sets the main buddy list. * - * @return The main buddy list. + * @param blist The buddy list you want to use. */ void gaim_set_blist(GaimBuddyList *blist); @@ -231,7 +233,6 @@ /** * Shows the buddy list, creating a new one if necessary. - * */ void gaim_blist_show(); @@ -591,8 +592,8 @@ /** * Finds the buddy struct given a screenname and an account * + * @param account The account this buddy belongs to * @param name The buddy's screenname - * @param account The account this buddy belongs to * @return The buddy or NULL if the buddy does not exist */ GaimBuddy *gaim_find_buddy(GaimAccount *account, const char *name); @@ -600,8 +601,8 @@ /** * Finds the buddy struct given a screenname, an account, and a group * + * @param account The account this buddy belongs to * @param name The buddy's screenname - * @param account The account this buddy belongs to * @param group The group to look in * @return The buddy or NULL if the buddy does not exist in the group */ @@ -611,8 +612,8 @@ /** * Finds all GaimBuddy structs given a screenname and an account * + * @param account The account this buddy belongs to * @param name The buddy's screenname - * @param account The account this buddy belongs to * * @return A GSList of buddies (which must be freed), or NULL if the buddy doesn't exist */
--- a/src/eventloop.h Wed Sep 29 15:01:33 2004 +0000 +++ b/src/eventloop.h Fri Oct 01 22:08:39 2004 +0000 @@ -79,13 +79,15 @@ /*@{*/ /** * Creates a callback timer. - * The timer will repeat until the function returns <tt>FALSE</tt>. The + * The timer will repeat until the function returns @c FALSE. The * first call will be at the end of the first interval. * @param interval The time between calls of the function, in * milliseconds. * @param function The function to call. - * @param data data to pass to <tt>function</tt>. - **/ + * @param data data to pass to @a function. + * @return A handle to the timer which can be passed to + * gaim_timeout_remove to remove the timer. + */ guint gaim_timeout_add(guint interval, GSourceFunc function, gpointer data); /**
--- a/src/prefs.h Wed Sep 29 15:01:33 2004 +0000 +++ b/src/prefs.h Fri Oct 01 22:08:39 2004 +0000 @@ -215,7 +215,7 @@ const char *gaim_prefs_get_string(const char *name); /** - * Get string pref value + * Get string list pref value * * @param name The name of the pref * @return The value of the pref
--- a/src/prpl.h Wed Sep 29 15:01:33 2004 +0000 +++ b/src/prpl.h Fri Oct 01 22:08:39 2004 +0000 @@ -314,6 +314,7 @@ * This is meant to be called from protocol plugins. * * @param account The account the user is on. + * @param name Name of the user. * @param login_time The user's log-in time. */ void gaim_prpl_got_account_login_time(GaimAccount *account, const char *name,
--- a/src/status.h Wed Sep 29 15:01:33 2004 +0000 +++ b/src/status.h Fri Oct 01 22:08:39 2004 +0000 @@ -246,7 +246,7 @@ gboolean gaim_status_type_is_independent(const GaimStatusType *status_type); /** - * Returns whether or not the status type is exlusive. + * Returns whether the status type is exclusive. * * @param status_type The status type. * @@ -686,8 +686,8 @@ /** * Sets the login time on a presence. * - * @param presence The presence. - * @param level The login time. + * @param presence The presence. + * @param login_time The login time. */ void gaim_presence_set_login_time(GaimPresence *presence, time_t login_time);
--- a/src/value.h Wed Sep 29 15:01:33 2004 +0000 +++ b/src/value.h Fri Oct 01 22:08:39 2004 +0000 @@ -175,6 +175,8 @@ /** * Returns a value's type. * + * @param value The value whose type you want. + * * @return The value's type. */ GaimType gaim_value_get_type(const GaimValue *value); @@ -185,6 +187,8 @@ * If the value's type is not GAIM_TYPE_SUBTYPE, this will return 0. * Subtypes should never have a subtype of 0. * + * @param value The value whose subtype you want. + * * @return The value's subtype, or 0 if @a type is not GAIM_TYPE_SUBTYPE. */ unsigned int gaim_value_get_subtype(const GaimValue *value); @@ -194,6 +198,8 @@ * * If the value's type is not GAIM_TYPE_BOXED, this will return @c NULL. * + * @param value The value whose specific type you want. + * * @return The value's specific type, or @a NULL if not GAIM_TYPE_BOXED. */ const char *gaim_value_get_specific_type(const GaimValue *value);