pidgin: 204dcd9c: Document things.

[qulogic at pidgin.im]

----------------------------------------------------------------------
Revision: 204dcd9c030a0edd76edfc08e3b58b6b143938db
Parent:   df1c7cdf26e9190c7d0c68a61d216d8d10a65262
Author:   qulogic at pidgin.im
Date:     09/20/11 21:51:34
Branch:   im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/204dcd9c030a0edd76edfc08e3b58b6b143938db

Changelog: 

Document things.

Changes against parent df1c7cdf26e9190c7d0c68a61d216d8d10a65262

  patched  pidgin/gtkconv-theme.h

-------------- next part --------------
============================================================
--- pidgin/gtkconv-theme.h	bf4fcfe0051eb79ab135c49a1569f322e4c58faa
+++ pidgin/gtkconv-theme.h	817461c13e03e88e6b6deea44652f99ab88a53e3
@@ -109,6 +109,15 @@ void pidgin_conversation_theme_set_info(
  */
 void pidgin_conversation_theme_set_info(PidginConvTheme *theme, GHashTable *info);
 
+/**
+ * Get the template data from a conversation theme.
+ *
+ * @param theme The conversation theme
+ * @param type  The type of template data
+ *
+ * @return The template data requested. Fallback is made as required by styles.
+ *         Subsequent calls to this function will return cached values.
+ */
 const char *pidgin_conversation_theme_get_template(PidginConvTheme *theme, PidginConvThemeTemplateType type);
 
 /**