aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-request.c
diff options
context:
space:
mode:
authorDan Winship <danw@src.gnome.org>2002-03-22 23:46:20 +0800
committerDan Winship <danw@src.gnome.org>2002-03-22 23:46:20 +0800
commit3e6b83577e82d3d1795ba0fce874abebba44ea22 (patch)
treef29b719a744296fb8dacc450d363b12ec1fde2eb /e-util/e-request.c
parent209b7548bc44dc587b37e64bc412d68bc400bdda (diff)
downloadgsoc2013-evolution-3e6b83577e82d3d1795ba0fce874abebba44ea22.tar.gz
gsoc2013-evolution-3e6b83577e82d3d1795ba0fce874abebba44ea22.tar.zst
gsoc2013-evolution-3e6b83577e82d3d1795ba0fce874abebba44ea22.zip
Document the fact that this takes two locale charset strings and one UTF8
* e-request.c (e_request_string): Document the fact that this takes two locale charset strings and one UTF8 string and returns a UTF8 string. (Huh.) svn path=/trunk/; revision=16226
Diffstat (limited to 'e-util/e-request.c')
-rw-r--r--e-util/e-request.c14
1 files changed, 7 insertions, 7 deletions
diff --git a/e-util/e-request.c b/e-util/e-request.c
index 22ba53f21b..a54b46bf9d 100644
--- a/e-util/e-request.c
+++ b/e-util/e-request.c
@@ -36,15 +36,15 @@
/**
* e_request_string:
- * @parent:
- * @title:
- * @prompt:
- * @default:
+ * @parent: parent window, or %NULL
+ * @title: the dialog title (in the locale character set)
+ * @prompt: the prompt (in the locale character set)
+ * @default: default value (in UTF8)
*
- * Requst a string to the user.
+ * Request a string from the user.
*
- * Return value: NULL if the user cancelled the dialog, the inserted string
- * otherwise. The string must be freed by the caller.
+ * Return value: %NULL if the user cancelled the dialog, the inserted
+ * string (in UTF8) otherwise. The string must be freed by the caller.
**/
char *
e_request_string (GtkWindow *parent,