im.pidgin.pidgin: 795d7e0fc010741ba22123931ad0cca10f456bc8

[resiak at soc.pidgin.im]

-----------------------------------------------------------------
Revision: 795d7e0fc010741ba22123931ad0cca10f456bc8
Ancestor: ae5371ce9cb178a2cb623c9e04f28b5464d34629
Author: resiak at soc.pidgin.im
Date: 2008-01-02T14:01:50
Branch: im.pidgin.pidgin

Modified files:
        pidgin/gtkutils.h

ChangeLog: 

Clear up some documentation.

-------------- next part --------------
============================================================
--- pidgin/gtkutils.h	0e942b173e025518f0003b5afc7c28a1d50348f6
+++ pidgin/gtkutils.h	19c063fe41d1baef7bc7b90f8698211f2c8c6238
@@ -374,16 +374,20 @@ gboolean pidgin_screenname_autocomplete_
 gboolean pidgin_screenname_autocomplete_default_filter(const PidginBuddyCompletionEntry *completion_entry, gpointer all_accounts);
 
 /**
- * @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))
  *
+ * @deprecated
+ *   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 @@ void pidgin_menu_position_func_helper(Gt
 
 /**
  * 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.