From: John Darrington <john@darrington.wattle.id.au>
Date: Sun, 30 Aug 2015 11:14:25 +0000 (+0200)
Subject: PsppireEncodingSelector: Add comment
X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b769b3dac989df6dbc5f6367ed1246b7ec4ad6e1;p=pspp

PsppireEncodingSelector: Add comment
---

diff --git a/src/ui/gui/psppire-encoding-selector.c b/src/ui/gui/psppire-encoding-selector.c
index 82677d8f59..5b2d082b10 100644
--- a/src/ui/gui/psppire-encoding-selector.c
+++ b/src/ui/gui/psppire-encoding-selector.c
@@ -183,6 +183,10 @@ psppire_encoding_selector_new (const char *default_encoding,
   return hbox;
 }
 
+/* 
+   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)
 {
diff --git a/src/ui/gui/psppire-encoding-selector.h b/src/ui/gui/psppire-encoding-selector.h
index 107f871348..adf359f697 100644
--- 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 */