changeset 32194:4d85e218a52e

Document things.
author Elliott Sales de Andrade <qulogic@pidgin.im>
date Wed, 21 Sep 2011 01:51:34 +0000
parents 3294e08d7466
children 79d48418ba0b
files pidgin/gtkconv-theme.h
diffstat 1 files changed, 9 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/pidgin/gtkconv-theme.h	Wed Sep 21 00:24:10 2011 +0000
+++ b/pidgin/gtkconv-theme.h	Wed Sep 21 01:51:34 2011 +0000
@@ -109,6 +109,15 @@
  */
 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);
 
 /**