diff src/gtkimhtml.h @ 12900:778d08e87ad0

[gaim-migrate @ 15253] Make gtk_imhtml_get_current_format() set values to FALSE instead of leaving them unset. Also, enable passing NULL in case you're only interested in one or two types of formatting. committer: Tailor Script <tailor@pidgin.im>
author Richard Laager <rlaager@wiktel.com>
date Tue, 17 Jan 2006 01:43:33 +0000
parents adf79d8ceb2d
children
line wrap: on
line diff
--- a/src/gtkimhtml.h	Tue Jan 17 01:42:46 2006 +0000
+++ b/src/gtkimhtml.h	Tue Jan 17 01:43:33 2006 +0000
@@ -523,13 +523,13 @@
 GtkIMHtmlButtons gtk_imhtml_get_format_functions(GtkIMHtml *imhtml);
 
 /**
- * Sets each boolean to TRUE if that formatting option is enabled at the
- * current position in a GTK+ IM/HTML.
+ * Sets each boolean to @c TRUE or @c FALSE to indicate if that formatting option
+ * is enabled at the current position in a GTK+ IM/HTML.
  *
  * @param imhtml    The GTK+ IM/HTML.
- * @param bold      A reference to a boolean for bold.
- * @param italic    A reference to a boolean for italic.
- * @param underline A reference to a boolean for underline.
+ * @param bold      The boolean to set for bold or @c NULL.
+ * @param italic    The boolean to set for italic or @c NULL.
+ * @param underline The boolean to set for underline or @c NULL.
  */
 void gtk_imhtml_get_current_format(GtkIMHtml *imhtml, gboolean *bold, gboolean *italic, gboolean *underline);