# HG changeset patch # User Paul Aurich # Date 1251604851 0 # Node ID 63cb8c4f3c66910fbfc42f08208d2534fab850dd # Parent 2f66ad9c32a94434feecfd7ef2ca5932adfb71e1 Fix a bunch of doxygen warnings. diff -r 2f66ad9c32a9 -r 63cb8c4f3c66 libpurple/blist.h --- a/libpurple/blist.h Sun Aug 30 04:00:04 2009 +0000 +++ b/libpurple/blist.h Sun Aug 30 04:00:51 2009 +0000 @@ -223,7 +223,7 @@ * be set to a fallback function that saves data to blist.xml like in * previous libpurple versions. * - * @attrib node The node which has been modified. + * @param node The node which has been modified. * * @since 2.6.0. */ @@ -238,7 +238,7 @@ * be set to a fallback function that saves data to blist.xml like in * previous libpurple versions. * - * @attrib node The node which has been modified. + * @param node The node which has been modified. * @since 2.6.0. */ void (*remove_node)(PurpleBlistNode *node); @@ -252,7 +252,7 @@ * be set to a fallback function that saves data to blist.xml like in * previous libpurple versions. * - * @attrib account The account whose data to save. If NULL, save all data + * @param account The account whose data to save. If NULL, save all data * for all accounts. * @since 2.6.0. */ diff -r 2f66ad9c32a9 -r 63cb8c4f3c66 libpurple/conversation.h --- a/libpurple/conversation.h Sun Aug 30 04:00:04 2009 +0000 +++ b/libpurple/conversation.h Sun Aug 30 04:00:51 2009 +0000 @@ -1308,7 +1308,7 @@ * @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 #user or #message is @c NULL. + * prompted if either \a user or \a message is @c NULL. * * @since 2.6.0 */ diff -r 2f66ad9c32a9 -r 63cb8c4f3c66 libpurple/dnssrv.h --- a/libpurple/dnssrv.h Sun Aug 30 04:00:04 2009 +0000 +++ b/libpurple/dnssrv.h Sun Aug 30 04:00:51 2009 +0000 @@ -98,11 +98,11 @@ /** * Get the value of the current TXT record. * - * @param resp The TXT response record + * @param response The TXT response record * @returns The value of the current TXT record. * @since 2.6.0 */ -const gchar *purple_txt_response_get_content(PurpleTxtResponse *resp); +const gchar *purple_txt_response_get_content(PurpleTxtResponse *response); /** * Destroy a TXT DNS response object. @@ -110,7 +110,7 @@ * @param response The PurpleTxtResponse to destroy. * @since 2.6.0 */ -void purple_txt_response_destroy(PurpleTxtResponse *resp); +void purple_txt_response_destroy(PurpleTxtResponse *response); #ifdef __cplusplus } diff -r 2f66ad9c32a9 -r 63cb8c4f3c66 libpurple/smiley.h --- a/libpurple/smiley.h Sun Aug 30 04:00:04 2009 +0000 +++ b/libpurple/smiley.h Sun Aug 30 04:00:51 2009 +0000 @@ -192,7 +192,7 @@ * @param smiley The custom smiley. * * @return A full path to the file, or @c NULL under various conditions. - * The caller should use #g_free to free the returned string. + * The caller should use g_free to free the returned string. */ char *purple_smiley_get_full_path(PurpleSmiley *smiley); diff -r 2f66ad9c32a9 -r 63cb8c4f3c66 libpurple/status.h --- a/libpurple/status.h Sun Aug 30 04:00:04 2009 +0000 +++ b/libpurple/status.h Sun Aug 30 04:00:51 2009 +0000 @@ -72,6 +72,16 @@ * for the current PurpleSession. */ +/** + * PurpleStatusType's are created by each PRPL. They outline the + * available statuses of the protocol. AIM, for example, supports + * an available state with an optional available message, an away + * state with a mandatory message, and an invisible state (which is + * technically "independent" of the other two, but we'll get into + * that later). PurpleStatusTypes are very permanent. They are + * hardcoded in each PRPL and will not change often. And because + * they are hardcoded, they do not need to be saved to any XML file. + */ typedef struct _PurpleStatusType PurpleStatusType; typedef struct _PurpleStatusAttr PurpleStatusAttr; typedef struct _PurplePresence PurplePresence; diff -r 2f66ad9c32a9 -r 63cb8c4f3c66 libpurple/util.h --- a/libpurple/util.h Sun Aug 30 04:00:04 2009 +0000 +++ b/libpurple/util.h Sun Aug 30 04:00:51 2009 +0000 @@ -31,8 +31,14 @@ #include +/** + * An opaque structure representing a URL request. Can be used to cancel + * the request. + */ typedef struct _PurpleUtilFetchUrlData PurpleUtilFetchUrlData; +/** @copydoc _PurpleMenuAction */ typedef struct _PurpleMenuAction PurpleMenuAction; +/** @copydoc _PurpleKeyValuePair */ typedef struct _PurpleKeyValuePair PurpleKeyValuePair; #include "account.h" @@ -107,7 +113,7 @@ * @param album The album of the song, can be @c NULL. * @param unused Currently unused, must be @c NULL. * - * @return The formatted string. The caller must #g_free the returned string. + * @return The formatted string. The caller must g_free the returned string. * @since 2.4.0 */ char * purple_util_format_song_info(const char *title, const char *artist, diff -r 2f66ad9c32a9 -r 63cb8c4f3c66 pidgin/gtkimhtml.h --- a/pidgin/gtkimhtml.h Sun Aug 30 04:00:04 2009 +0000 +++ b/pidgin/gtkimhtml.h Sun Aug 30 04:00:51 2009 +0000 @@ -188,8 +188,8 @@ GSList *anchors; GtkIMHtmlSmileyFlags flags; GtkIMHtml *imhtml; - gpointer data; /** @Since 2.6.0 */ - gsize datasize; /** @Since 2.6.0 */ + gpointer data; /** @since 2.6.0 */ + gsize datasize; /** @since 2.6.0 */ }; struct _GtkIMHtmlScalable { @@ -906,7 +906,7 @@ * @c TRUE if the request for context menu was processed * successfully, @c FALSE otherwise. * - * @return @c TRUE if the protocol was successfully registered (or unregistered, when #activate is @c NULL) + * @return @c TRUE if the protocol was successfully registered (or unregistered, when \a activate is @c NULL) * * @since 2.6.0 */