# HG changeset patch # User Sadrul Habib Chowdhury # Date 1191990233 0 # Node ID 4511d15a8f80aa0ee093d3147e6fda2360879f31 # Parent acf284962b40241b01586775bd47b381e4a492a9 Doxygen @since tags for libpurple and pidgin. diff -r acf284962b40 -r 4511d15a8f80 ChangeLog.API --- a/ChangeLog.API Wed Oct 10 03:54:14 2007 +0000 +++ b/ChangeLog.API Wed Oct 10 04:23:53 2007 +0000 @@ -89,9 +89,6 @@ * purple_timeout_add_seconds Callers should prefer this to purple_timeout_add for timers longer than 1 second away. Be aware of the rounding, though. - * purple_timeout_add_seconds - Callers should prefer this to purple_timeout_add for timers - longer than 1 second away. Be aware of the rounding, though. * purple_xfer_get_remote_user * purple_pounces_get_all_for_ui * purple_prefs_get_children_names diff -r acf284962b40 -r 4511d15a8f80 doc/conversation-signals.dox --- a/doc/conversation-signals.dox Wed Oct 10 03:54:14 2007 +0000 +++ b/doc/conversation-signals.dox Wed Oct 10 04:23:53 2007 +0000 @@ -429,6 +429,7 @@ conversation. @param conv The conversation. @param list A pointer to the list of actions. + @since 2.1.0 @endsignaldef */ // vim: syntax=c.doxygen tw=75 et diff -r acf284962b40 -r 4511d15a8f80 doc/gtkconv-signals.dox --- a/doc/gtkconv-signals.dox Wed Oct 10 03:54:14 2007 +0000 +++ b/doc/gtkconv-signals.dox Wed Oct 10 04:23:53 2007 +0000 @@ -127,6 +127,7 @@ @signaldesc Emitted immediately before an existing conversation is hidden. @param gtkconv The PidginConversation + @since 2.2.0 @endsignaldef @signaldef conversation-displayed @@ -136,6 +137,7 @@ @signaldesc Emitted right after the Pidgin UI is attached to a new or a hidden conversation. @param gtkconv The PidginConversation + @since 2.2.0 @endsignaldef */ diff -r acf284962b40 -r 4511d15a8f80 doc/notify-signals.dox --- a/doc/notify-signals.dox Wed Oct 10 03:54:14 2007 +0000 +++ b/doc/notify-signals.dox Wed Oct 10 04:23:53 2007 +0000 @@ -35,6 +35,7 @@ @param from Who the email is from. @param to Who the email is to. @param url A url to view the email. + @since 2.1.0 @endsignaldef @signaldef displaying-emails-notification @@ -52,6 +53,7 @@ @param tos Who the emails are to. @param urls The urls to view the emails. @param count Number of emails being notified of. + @since 2.1.0 @endsignaldef */ diff -r acf284962b40 -r 4511d15a8f80 libpurple/certificate.h --- a/libpurple/certificate.h Wed Oct 10 03:54:14 2007 +0000 +++ b/libpurple/certificate.h Wed Oct 10 04:23:53 2007 +0000 @@ -2,6 +2,7 @@ * @file certificate.h Public-Key Certificate API * @ingroup core * @see @ref certificate-signals + * @since 2.2.0 */ /* diff -r acf284962b40 -r 4511d15a8f80 libpurple/conversation.h --- a/libpurple/conversation.h Wed Oct 10 03:54:14 2007 +0000 +++ b/libpurple/conversation.h Wed Oct 10 04:23:53 2007 +0000 @@ -285,6 +285,8 @@ /** * Description of a conversation message + * + * @since 2.2.0 */ struct _PurpleConvMessage { @@ -670,6 +672,8 @@ * @return A GList of PurpleConvMessage's. The must not modify the list or the data within. * The list contains the newest message at the beginning, and the oldest message at * the end. + * + * @since 2.2.0 */ GList *purple_conversation_get_message_history(PurpleConversation *conv); @@ -677,6 +681,8 @@ * Clear the message history of a conversation. * * @param conv The conversation + * + * @since 2.2.0 */ void purple_conversation_clear_message_history(PurpleConversation *conv); @@ -686,6 +692,8 @@ * @param msg A PurpleConvMessage * * @return The name of the sender of the message + * + * @since 2.2.0 */ const char *purple_conversation_message_get_sender(PurpleConvMessage *msg); @@ -695,6 +703,8 @@ * @param msg A PurpleConvMessage * * @return The name of the sender of the message + * + * @since 2.2.0 */ const char *purple_conversation_message_get_message(PurpleConvMessage *msg); @@ -704,6 +714,8 @@ * @param msg A PurpleConvMessage * * @return The name of the sender of the message + * + * @since 2.2.0 */ PurpleMessageFlags purple_conversation_message_get_flags(PurpleConvMessage *msg); @@ -713,6 +725,8 @@ * @param msg A PurpleConvMessage * * @return The name of the sender of the message + * + * @since 2.2.0 */ time_t purple_conversation_message_get_timestamp(PurpleConvMessage *msg); @@ -1318,6 +1332,8 @@ * @return A list of PurpleMenuAction items, harvested by the * chat-extended-menu signal. The list and the menuaction * items should be freed by the caller. + * + * @since 2.1.0 */ GList * purple_conversation_get_extended_menu(PurpleConversation *conv); @@ -1331,6 +1347,8 @@ * message, if not @c NULL. It must be freed by the caller with g_free(). * * @return @c TRUE if the command was executed successfully, @c FALSE otherwise. + * + * @since 2.1.0 */ gboolean purple_conversation_do_command(PurpleConversation *conv, const gchar *cmdline, const gchar *markup, gchar **error); diff -r acf284962b40 -r 4511d15a8f80 libpurple/eventloop.h --- a/libpurple/eventloop.h Wed Oct 10 03:54:14 2007 +0000 +++ b/libpurple/eventloop.h Wed Oct 10 04:23:53 2007 +0000 @@ -138,6 +138,8 @@ * @param data data to pass to @a function. * @return A handle to the timer which can be passed to * purple_timeout_remove to remove the timer. + * + * @since 2.1.0 */ guint purple_timeout_add_seconds(guint interval, GSourceFunc function, gpointer data); diff -r acf284962b40 -r 4511d15a8f80 libpurple/ft.h --- a/libpurple/ft.h Wed Oct 10 03:54:14 2007 +0000 +++ b/libpurple/ft.h Wed Oct 10 04:23:53 2007 +0000 @@ -242,6 +242,8 @@ * @param xfer The file transfer. * * @return The name of the remote user. + * + * @since 2.1.0 */ const char *purple_xfer_get_remote_user(const PurpleXfer *xfer); diff -r acf284962b40 -r 4511d15a8f80 libpurple/pluginpref.h --- a/libpurple/pluginpref.h Wed Oct 10 03:54:14 2007 +0000 +++ b/libpurple/pluginpref.h Wed Oct 10 04:23:53 2007 +0000 @@ -35,16 +35,16 @@ */ typedef enum { - PURPLE_STRING_FORMAT_TYPE_NONE = 0, - PURPLE_STRING_FORMAT_TYPE_MULTILINE = 1 << 0, - PURPLE_STRING_FORMAT_TYPE_HTML = 1 << 1 + PURPLE_STRING_FORMAT_TYPE_NONE = 0, /**< The string is plain text. */ + PURPLE_STRING_FORMAT_TYPE_MULTILINE = 1 << 0, /**< The string can have newlines. */ + PURPLE_STRING_FORMAT_TYPE_HTML = 1 << 1 /**< The string can be in HTML. */ } PurpleStringFormatType; typedef enum { PURPLE_PLUGIN_PREF_NONE, PURPLE_PLUGIN_PREF_CHOICE, - PURPLE_PLUGIN_PREF_INFO, /**< no-value label */ - PURPLE_PLUGIN_PREF_STRING_FORMAT + PURPLE_PLUGIN_PREF_INFO, /**< no-value label */ + PURPLE_PLUGIN_PREF_STRING_FORMAT /**< The preference has a string value. */ } PurplePluginPrefType; #include diff -r acf284962b40 -r 4511d15a8f80 libpurple/prefs.h --- a/libpurple/prefs.h Wed Oct 10 03:54:14 2007 +0000 +++ b/libpurple/prefs.h Wed Oct 10 04:23:53 2007 +0000 @@ -291,6 +291,8 @@ * @return A list of newly allocated strings denoting the names of the children. * Returns @c NULL if there are no children or if pref doesn't exist. * The caller must free all the strings and the list. + * + * @since 2.1.0 */ GList *purple_prefs_get_children_names(const char *name); diff -r acf284962b40 -r 4511d15a8f80 libpurple/sslconn.h --- a/libpurple/sslconn.h Wed Oct 10 03:54:14 2007 +0000 +++ b/libpurple/sslconn.h Wed Oct 10 04:23:53 2007 +0000 @@ -204,17 +204,19 @@ void *data); /** - * Makes a SSL connection using an already open file descriptor. - * - * @param account The account making the connection. - * @param fd The file descriptor. - * @param func The SSL input handler function. - * @param error_func The SSL error handler function. - * @param host The hostname of the other peer (to verify the CN) - * @param data User-defined data. - * - * @return The SSL connection handle. - */ + * Makes a SSL connection using an already open file descriptor. + * + * @param account The account making the connection. + * @param fd The file descriptor. + * @param func The SSL input handler function. + * @param error_func The SSL error handler function. + * @param host The hostname of the other peer (to verify the CN) + * @param data User-defined data. + * + * @return The SSL connection handle. + * + * @since 2.2.0 + */ PurpleSslConnection *purple_ssl_connect_with_host_fd(PurpleAccount *account, int fd, PurpleSslInputFunction func, PurpleSslErrorFunction error_func, @@ -268,6 +270,8 @@ * * @return The peer certificate chain, in the order of certificate, issuer, * issuer's issuer, etc. @a NULL if no certificates have been provided, + * + * @since 2.2.0 */ GList * purple_ssl_get_peer_certificates(PurpleSslConnection *gsc); diff -r acf284962b40 -r 4511d15a8f80 pidgin/gtkblist.h --- a/pidgin/gtkblist.h Wed Oct 10 03:54:14 2007 +0000 +++ b/pidgin/gtkblist.h Wed Oct 10 04:23:53 2007 +0000 @@ -371,6 +371,8 @@ * @param selected Whether this buddy is selected. If TRUE, the markup will not change the color. * @param aliased TRUE to return the appropriate alias of this buddy, FALSE to return its screenname and status information * @return The markup for this buddy + * + * @since 2.1.0 */ gchar *pidgin_blist_get_name_markup(PurpleBuddy *buddy, gboolean selected, gboolean aliased); @@ -382,11 +384,15 @@ * * @param node The buddy list node to show a tooltip for * @param widget The widget to draw the tooltip on + * + * @since 2.1.0 */ void pidgin_blist_draw_tooltip(PurpleBlistNode *node, GtkWidget *widget); /** * Destroys the current (if any) Buddy List tooltip + * + * @since 2.1.0 */ void pidgin_blist_tooltip_destroy(void); diff -r acf284962b40 -r 4511d15a8f80 pidgin/gtkconv.h --- a/pidgin/gtkconv.h Wed Oct 10 03:54:14 2007 +0000 +++ b/pidgin/gtkconv.h Wed Oct 10 04:23:53 2007 +0000 @@ -253,6 +253,8 @@ * @param conv The conversation. * * @return Wheter Pidgin UI was successfully attached. + * + * @since 2.2.0 */ gboolean pidgin_conv_attach_to_conversation(PurpleConversation *conv); diff -r acf284962b40 -r 4511d15a8f80 pidgin/gtkimhtml.h --- a/pidgin/gtkimhtml.h Wed Oct 10 03:54:14 2007 +0000 +++ b/pidgin/gtkimhtml.h Wed Oct 10 04:23:53 2007 +0000 @@ -441,6 +441,8 @@ * @param id The id to associate with the image. * * @return A new IM/HTML Scalable object with an image. + * + * @since 2.1.0 */ /* * TODO: All this animation code could be combined much better with @@ -837,6 +839,8 @@ * * @param imhtml The GTK+ IM/HTML. * @param flags The connection flag which describes the allowed types of formatting. + * + * @since 2.1.0 */ void gtk_imhtml_setup_entry(GtkIMHtml *imhtml, PurpleConnectionFlags flags); diff -r acf284962b40 -r 4511d15a8f80 pidgin/gtkutils.h --- a/pidgin/gtkutils.h Wed Oct 10 03:54:14 2007 +0000 +++ b/pidgin/gtkutils.h Wed Oct 10 04:23:53 2007 +0000 @@ -376,6 +376,8 @@ * * @param conn The connection to get information from. * @param name The user to get information about. + * + * @since 2.1.0 */ void pidgin_retrieve_user_info(PurpleConnection *conn, const char *name); @@ -385,6 +387,8 @@ * @param conn The connection to get information from. * @param name The user to get information about. * @param chatid The chat id. + * + * @since 2.1.0 */ void pidgin_retrieve_user_info_in_chat(PurpleConnection *conn, const char *name, int chatid); @@ -423,6 +427,8 @@ * * @param w The widget that we want to label. * @param l A GtkLabel that we want to use as the label for the widget. + * + * @since 2.2.0 */ void pidgin_set_accessible_relations(GtkWidget *w, GtkWidget *l); @@ -437,6 +443,8 @@ * where the menu shall be drawn. This is an output parameter. * @param push_in This is an output parameter? * @param data Not used by this particular position function. + * + * @since 2.1.0 */ void pidgin_menu_position_func_helper(GtkMenu *menu, gint *x, gint *y, gboolean *push_in, gpointer data); @@ -671,6 +679,8 @@ * * @return A newly created text GtkComboBox containing a GtkEntry * child. + * + * @since 2.2.0 */ GtkWidget *pidgin_text_combo_box_entry_new(const char *default_item, GList *items); @@ -680,6 +690,8 @@ * @param widget The simple text GtkComboBoxEntry equivalent widget * * @return The text in the widget's entry. It must not be freed + * + * @since 2.2.0 */ const char *pidgin_text_combo_box_entry_get_text(GtkWidget *widget); @@ -688,6 +700,8 @@ * * @param widget The simple text GtkComboBoxEntry equivalent widget * @param text The text to set + * + * @since 2.2.0 */ void pidgin_text_combo_box_entry_set_text(GtkWidget *widget, const char *text);