pidgin: 2abcbb94: Add documentation for some new API.

[sadrul at pidgin.im]

-----------------------------------------------------------------
Revision: 2abcbb9461812553614a4d11b0d48f1a2eface59
Ancestor: e26567827f46d5a98766576ffafb6a2e25a9e00a
Author: sadrul at pidgin.im
Date: 2008-05-28T05:10:43
Branch: im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/2abcbb9461812553614a4d11b0d48f1a2eface59

Modified files:
        pidgin/gtkimhtml.h

ChangeLog: 

Add documentation for some new API.

-------------- next part --------------
============================================================
--- pidgin/gtkimhtml.h	b7ea43cb41f2b3a733360fa97f10ef9eb587b369
+++ pidgin/gtkimhtml.h	70cae1aa620e19d608ff47451dbc760121d94468
@@ -854,11 +854,36 @@ void gtk_imhtml_setup_entry(GtkIMHtml *i
  */
 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);
 /*@}*/