[Gnucash-changes] add documentation

Linas Vepstas linas at cvs.gnucash.org
Mon May 31 00:43:22 EDT 2004


Log Message:
-----------
add documentation

Modified Files:
--------------
    gnucash/src/gnome-utils:
        dialog-utils.h

Revision Data
-------------
Index: dialog-utils.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/dialog-utils.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -Lsrc/gnome-utils/dialog-utils.h -Lsrc/gnome-utils/dialog-utils.h -u -r1.8 -r1.9
--- src/gnome-utils/dialog-utils.h
+++ src/gnome-utils/dialog-utils.h
@@ -159,17 +159,24 @@
 
 /* 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


More information about the gnucash-changes mailing list