pidgin: 6aaac4c2: Fix a bunch of doxygen warnings.
darkrain42 at pidgin.im
darkrain42 at pidgin.im
Sun Aug 30 00:05:57 EDT 2009
-----------------------------------------------------------------
Revision: 6aaac4c2ade05169219a85683c8fceda40bf29ca
Ancestor: 2d790ce3b1ede639f02a4feb1808231e03da8f6a
Author: darkrain42 at pidgin.im
Date: 2009-08-30T04:00:51
Branch: im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/6aaac4c2ade05169219a85683c8fceda40bf29ca
Modified files:
libpurple/blist.h libpurple/conversation.h
libpurple/dnssrv.h libpurple/smiley.h libpurple/status.h
libpurple/util.h pidgin/gtkimhtml.h
ChangeLog:
Fix a bunch of doxygen warnings.
-------------- next part --------------
============================================================
--- libpurple/blist.h c3102fc0dd9d5ef293c42dcf1d6818d77491c1f9
+++ libpurple/blist.h 77356121b24a252d2aac3c67d1fb863f93d34c9f
@@ -223,7 +223,7 @@ struct _PurpleBlistUiOps
* 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 @@ struct _PurpleBlistUiOps
* 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 @@ struct _PurpleBlistUiOps
* 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.
*/
============================================================
--- libpurple/conversation.h 769452aaf88fa90cbeee16647d00cc617a2cf6b1
+++ libpurple/conversation.h eb9a100fa3cf70e84c6f4e335f3a9b1d76eb04c7
@@ -1308,7 +1308,7 @@ void purple_conv_chat_left(PurpleConvCha
* @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
*/
============================================================
--- libpurple/dnssrv.h e3d07f2b900c09f2bf5d601e9578426380ca3aa8
+++ libpurple/dnssrv.h f11ce6a54bb734cc907d4085e7ecfabb9bdb5946
@@ -98,11 +98,11 @@ void purple_txt_cancel(PurpleSrvQueryDat
/**
* 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 @@ const gchar *purple_txt_response_get_con
* @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
}
============================================================
--- libpurple/smiley.h 29dfc5a86414efa0d940080733ed3ccf5836b0a9
+++ libpurple/smiley.h 2f37c7d0c8c3ceecc9980095592c58e01e93f093
@@ -192,7 +192,7 @@ const char *purple_smiley_get_extension(
* @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);
============================================================
--- libpurple/status.h 442b472aa6297d7c1fa129ef7174b9c4d231ec30
+++ libpurple/status.h 7e2b54e46ce291b7fb270239e4c432409d0050ef
@@ -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;
============================================================
--- libpurple/util.h fe601b6313642f6948d3cc89aff32bbd8ff08454
+++ libpurple/util.h 274bc7b30331d9ecde19c7af243be947462b545f
@@ -31,8 +31,14 @@
#include <stdio.h>
+/**
+ * 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 @@ void purple_util_set_current_song(const
* @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,
============================================================
--- pidgin/gtkimhtml.h 20eee9c5d50be3f1c26420094621c0e39bd0fb39
+++ pidgin/gtkimhtml.h f3a1884dcd575634acb1b27afea5e946b55cf44f
@@ -188,8 +188,8 @@ struct _GtkIMHtmlSmiley {
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 @@ void gtk_imhtml_smiley_destroy(GtkIMHtml
* @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
*/
More information about the Commits
mailing list