changeset 23225:fa7cbf88a0ec

Add documentation for some new API.
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Wed, 28 May 2008 05:10:43 +0000
parents dbde19256cab
children fda698fb2d1f
files pidgin/gtkimhtml.h
diffstat 1 files changed, 25 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/pidgin/gtkimhtml.h	Wed May 28 05:04:02 2008 +0000
+++ b/pidgin/gtkimhtml.h	Wed May 28 05:10:43 2008 +0000
@@ -854,11 +854,36 @@
  */
 void gtk_imhtml_setup_entry(GtkIMHtml *imhtml, PurpleConnectionFlags flags);
 
+/**
+ * Create a new GtkIMHtmlSmiley.
+ *
+ * @param file       The image file for the smiley
+ * @param shortcut   The key shortcut for the smiley
+ * @param hide       @c TRUE if the smiley should be hidden in the smiley dialog, @c FALSE otherwise
+ * @param flags      The smiley flags
+ *
+ * @return The newly created smiley
+ * @since 2.5.0
+ */
 GtkIMHtmlSmiley *gtk_imhtml_smiley_create(const char *file, const char *shortcut, gboolean hide,
 		GtkIMHtmlSmileyFlags flags);
 
+/**
+ * Reload the image data for the smiley.
+ *
+ * @param smiley   The smiley to reload
+ *
+ * @since 2.5.0
+ */
 void gtk_imhtml_smiley_reload(GtkIMHtmlSmiley *smiley);
 
+/**
+ * Destroy a GtkIMHtmlSmiley.
+ *
+ * @param smiley   The smiley to destroy
+ *
+ * @since 2.5.0
+ */
 void gtk_imhtml_smiley_destroy(GtkIMHtmlSmiley *smiley);
 /*@}*/