Mercurial > pidgin
changeset 16201:36b09c6f7957
Doxygen updates. This eliminated all the warnings from Doxygen.
| author | Richard Laager <rlaager@wiktel.com> |
|---|---|
| date | Mon, 16 Apr 2007 05:07:21 +0000 |
| parents | 470caa5fe675 |
| children | 0973688f4b74 4f6a6443a1e3 |
| files | doc/conversation-signals.dox finch/gntft.h libpurple/account.h libpurple/mime.h libpurple/proxy.h libpurple/server.h libpurple/util.h pidgin/gtkutils.h |
| diffstat | 8 files changed, 33 insertions(+), 24 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/conversation-signals.dox Mon Apr 16 03:37:48 2007 +0000 +++ b/doc/conversation-signals.dox Mon Apr 16 05:07:21 2007 +0000 @@ -382,7 +382,7 @@ @param chat The name of the chat you're being invited to. @param invite_message The optional invite message. @param components The components necessary if you want to call - serv_join_chat + serv_join_chat() @return Less than zero if the invitation should be rejected, greater than zero if the invitation should be accepted. If zero is returned, the default behavior will be maintained: the user will be prompted.
--- a/finch/gntft.h Mon Apr 16 03:37:48 2007 +0000 +++ b/finch/gntft.h Mon Apr 16 05:07:21 2007 +0000 @@ -42,30 +42,23 @@ /** * Destroys a file transfer dialog. - * - * @param dialog The file transfer dialog. */ void finch_xfer_dialog_destroy(void); /** * Displays the file transfer dialog given. * If dialog is @c NULL, displays the default dialog, creating one if necessary - * - * @param dialog The file transfer dialog to show. */ void finch_xfer_dialog_show(void); /** * Hides the file transfer dialog. - * - * @param dialog The file transfer dialog to hide. */ void finch_xfer_dialog_hide(); /** * Adds a file transfer to the dialog. * - * @param dialog The file transfer dialog. * @param xfer The file transfer. */ void finch_xfer_dialog_add_xfer(PurpleXfer *xfer); @@ -73,7 +66,6 @@ /** * Removes a file transfer from the dialog. * - * @param dialog The file transfer dialog. * @param xfer The file transfer. */ void finch_xfer_dialog_remove_xfer(PurpleXfer *xfer); @@ -81,7 +73,6 @@ /** * Indicate in a file transfer dialog that a transfer was canceled. * - * @param dialog The file transfer dialog. * @param xfer The file transfer that was canceled. */ void finch_xfer_dialog_cancel_xfer(PurpleXfer *xfer); @@ -89,7 +80,6 @@ /** * Updates the information for a transfer in the dialog. * - * @param dialog The file transfer dialog. * @param xfer The file transfer. */ void finch_xfer_dialog_update_xfer(PurpleXfer *xfer);
--- a/libpurple/account.h Mon Apr 16 03:37:48 2007 +0000 +++ b/libpurple/account.h Mon Apr 16 05:07:21 2007 +0000 @@ -195,10 +195,11 @@ * user authorizes or denies the remote user from adding him. * * @param account The account that was added - * @param remote_user The name of the usre that added this account. + * @param remote_user The name of the user that added this account. * @param id The optional ID of the local account. Rarely used. * @param alias The optional alias of the remote user. * @param message The optional message sent from the uer requesting you + * @param on_list Is the remote user already on the buddy list? * @param auth_cb The callback called when the local user accepts * @param deny_cb The callback called when the local user rejects * @param user_data Data to be passed back to the above callbacks
--- a/libpurple/mime.h Mon Apr 16 03:37:48 2007 +0000 +++ b/libpurple/mime.h Mon Apr 16 05:07:21 2007 +0000 @@ -40,12 +40,12 @@ */ /** - * @typedef PurpleMimeDocument A MIME document. + * A MIME document. */ typedef struct _PurpleMimeDocument PurpleMimeDocument; /** - * @typedef PurpleMimePart A part of a multipart MIME document. + * A part of a multipart MIME document. */ typedef struct _PurpleMimePart PurpleMimePart;
--- a/libpurple/proxy.h Mon Apr 16 03:37:48 2007 +0000 +++ b/libpurple/proxy.h Mon Apr 16 05:07:21 2007 +0000 @@ -250,6 +250,11 @@ /** * Makes a connection through a SOCKS5 proxy. * + * @param handle A handle that should be associated with this + * connection attempt. The handle can be used + * to cancel the connection attempt using the + * purple_proxy_connect_cancel_with_handle() + * function. * @param gpi The PurpleProxyInfo specifying the proxy settings * @param host The destination host. * @param port The destination port.
--- a/libpurple/server.h Mon Apr 16 03:37:48 2007 +0000 +++ b/libpurple/server.h Mon Apr 16 05:07:21 2007 +0000 @@ -38,6 +38,8 @@ * * TODO: Could probably move this into the conversation API. * + * @param gc The connection over which to send the typing notification. + * @param name The user to send the typing notification to. * @param state One of PURPLE_TYPING, PURPLE_TYPED, or PURPLE_NOT_TYPING. * @return A quiet-period, specified in seconds, where Purple will not * send any additional typing notification messages. Most @@ -73,11 +75,14 @@ * * TODO: Could probably move this into the conversation API. * + * @param gc The connection on which the typing message was received. + * @param name The name of the remote user. * @param timeout If this is a number greater than 0, then * Purple will wait this number of seconds and then * set this buddy to the PURPLE_NOT_TYPING state. This * is used by protocols that send repeated typing messages * while the user is composing the message. + * @param state The typing state received */ void serv_got_typing(PurpleConnection *gc, const char *name, int timeout, PurpleTypingState state); @@ -103,8 +108,15 @@ void serv_reject_chat(PurpleConnection *, GHashTable *data); /** - * @param data The hash function should be g_str_hash() and the equal - * function should be g_str_equal(). + * Called by a prpl when an account is invited into a chat. + * + * @param gc The connection on which the invite arrived. + * @param name The name of the chat you're being invited to. + * @param who The username of the person inviting the account. + * @param message The optional invite message. + * @param data The components necessary if you want to call serv_join_chat(). + * The hash function should be g_str_hash() and the equal + * function should be g_str_equal(). */ void serv_got_chat_invite(PurpleConnection *gc, const char *name, const char *who, const char *message,
--- a/libpurple/util.h Mon Apr 16 03:37:48 2007 +0000 +++ b/libpurple/util.h Mon Apr 16 05:07:21 2007 +0000 @@ -483,13 +483,13 @@ /** * Returns a newly allocated string containing the value of the CSS property specified * in opt. The @a style argument is expected to point to a HTML inline CSS. - * (i.e. <span style="[inline css]"> ) The function will seek for the CSS property and - * return its value. + * The function will seek for the CSS property and return its value. * - * For example, purple_markup_get_css_property("direction:rtl;color:#dc4d1b;", "color") - * would return "#dc4d1b". + * For example, purple_markup_get_css_property("direction:rtl;color:#dc4d1b;", + * "color") would return "#dc4d1b". * - * On error or if the requested property was not found, the function returns @c NULL. + * On error or if the requested property was not found, the function returns + * @c NULL. * * @param style A string containing the inline CSS text. * @param opt The requested CSS property.
--- a/pidgin/gtkutils.h Mon Apr 16 03:37:48 2007 +0000 +++ b/pidgin/gtkutils.h Mon Apr 16 05:07:21 2007 +0000 @@ -437,7 +437,7 @@ * * @param parent The parent window * @param callback The callback to call when the window is closed. If the user chose an icon, the char* argument will point to its path - * @param data Data to pass to @callback + * @param data Data to pass to @a callback * @return The file dialog */ GtkWidget *pidgin_buddy_icon_chooser_new(GtkWindow *parent, void(*callback)(const char*,gpointer), gpointer data); @@ -485,6 +485,7 @@ * Creates a "mini-dialog" suitable for embedding in the buddy list scrollbook * * @param handle A handle + * @param stock_id The ID of a stock image to use in the mini dialog * @param primary The primary text * @param secondary The secondary text * @param user_data Data to pass to the callbacks @@ -527,10 +528,10 @@ /** * This is copied from Gtk to support Gtk 2.0 * - * Creates a new path with @first_index and @varargs as indices. + * Creates a new path with @a first_index and the varargs as indices. * * @param first_index first integer - * @param varargs list of integers terminated by -1 + * @param ... list of integers terminated by -1 * * @return A newly created GtkTreePath. *