Mercurial > pidgin
changeset 21974:ecdb9f9b75e4
Clear up some documentation.
| author | Will Thompson <will.thompson@collabora.co.uk> |
|---|---|
| date | Wed, 02 Jan 2008 14:01:50 +0000 |
| parents | 966f98d4b04b |
| children | c7c5e2ff2b04 |
| files | pidgin/gtkutils.h |
| diffstat | 1 files changed, 12 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/pidgin/gtkutils.h Wed Jan 02 14:01:15 2008 +0000 +++ b/pidgin/gtkutils.h Wed Jan 02 14:01:50 2008 +0000 @@ -374,16 +374,20 @@ gboolean pidgin_screenname_autocomplete_default_filter(const PidginBuddyCompletionEntry *completion_entry, gpointer all_accounts); /** + * Add autocompletion of screenames to an entry. + * * @deprecated - * Add autocompletion of screenames to an entry. - * The usage of this function is deprecated. For new code, use the equivalent: - * pidgin_setup_screenname_autocomplete_with_filter(entry, optmenu, pidgin_screenname_autocomplete_default_filter, GINT_TO_POINTER(all)) + * For new code, use the equivalent: + * #pidgin_setup_screenname_autocomplete_with_filter(@a entry, @a optmenu, + * #pidgin_screenname_autocomplete_default_filter, <tt>GINT_TO_POINTER(@a + * all)</tt>) * * @param entry The GtkEntry on which to setup autocomplete. - * @param optmenu A menu for accounts, returned by pidgin_account_option_menu_new(). - * If @a optmenu is not @c NULL, it'll be updated when a screenname is chosen - * from the autocomplete list. - * @param all Whether to include screennames from disconnected accounts. + * @param optmenu A menu for accounts, returned by + * pidgin_account_option_menu_new(). If @a optmenu is not @c + * NULL, it'll be updated when a screenname is chosen from the + * autocomplete list. + * @param all Whether to include screennames from disconnected accounts. */ void pidgin_setup_screenname_autocomplete(GtkWidget *entry, GtkWidget *optmenu, gboolean all); @@ -506,7 +510,7 @@ /** * A valid GtkMenuPositionFunc. This is used to determine where - * to draw context menu's when the menu is activated with the + * to draw context menus when the menu is activated with the * keyboard (shift+F10). If the menu is activated with the mouse, * then you should just use GTK's built-in position function, * because it does a better job of positioning the menu.