PsppireEncodingSelector: Add comment

[pspp] / src / ui / gui / psppire-encoding-selector.h

diff --git a/src/ui/gui/psppire-encoding-selector.h b/src/ui/gui/psppire-encoding-selector.h
index 107f871348a357b740963c42a9b90d931460998e..adf359f6970edc220875c0cb030349110a9cdf73 100644 (file)
--- a/src/ui/gui/psppire-encoding-selector.h
+++ b/src/ui/gui/psppire-encoding-selector.h
@@ -21,6 +21,11 @@
 
 GtkWidget *psppire_encoding_selector_new (const char *default_encoding,
                                           gboolean allow_auto);
+
+/* 
+   Return a string describing the currently selected encoding. 
+   The caller should free this string when no longer required.
+*/
 gchar *psppire_encoding_selector_get_encoding (GtkWidget *selector);
 
 #endif /* PSPPIRE_ENCODING_SELECTOR_H */