From 593e574cf3094d9d6266712d69803262d9a34426 Mon Sep 17 00:00:00 2001 From: Linas Vepstas Date: Mon, 31 May 2004 04:43:21 +0000 Subject: [PATCH] add documentation git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@9991 57a11ea4-9604-0410-9ed3-97b8803252fd --- src/gnome-utils/dialog-utils.h | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/src/gnome-utils/dialog-utils.h b/src/gnome-utils/dialog-utils.h index 68055b4396..3ffb3b148e 100644 --- a/src/gnome-utils/dialog-utils.h +++ b/src/gnome-utils/dialog-utils.h @@ -159,17 +159,24 @@ void gnc_glade_autoconnect_full_func(const gchar *handler_name, /* Multibyte/wide char string helper functions. */ -/* Allocate new wide char string in dest_p. Return number of - * wide chars or < 0 if error. */ +/** Allocate new wide char string in dest_p. Return number of + * wide chars or < 0 if error. When the string is no longer + * needed, free it with g_free(). + */ gint gnc_mbstowcs (GdkWChar **dest_p, const char *src); -/* Return new multibyte string or NULL if failure. */ +/** Return new multibyte string or NULL if failure. + * XXX how are we supposed to free this?? + * with g_free or something else ?? + */ char * gnc_wcstombs (const GdkWChar *src); -/* Len of wide char string in chars */ +/** Len of wide char string in chars */ gint gnc_wcslen (const GdkWChar *src); -/* Duplicate wide char string */ +/** Duplicate wide char string. + * When the string is no longer needed, free it with g_free(). + */ GdkWChar * gnc_wcsdup (const GdkWChar *src); #endif