More doc comments moved inline.

This commit is contained in:
Matthias Clasen
2002-11-01 00:45:32 +00:00
parent 1489222cab
commit ca00536f34
13 changed files with 609 additions and 282 deletions

View File

@ -122,14 +122,18 @@ find_a_display ()
return display;
}
/*
* gdk_wcstombs
*
* Returns a multi-byte string converted from the specified array
* of wide characters. The string is newly allocated. The array of
* wide characters must be null-terminated. If the conversion is
* failed, it returns NULL.
*/
/**
* gdk_wcstombs:
* @src: a wide character string.
*
* Converts a wide character string to a multi-byte string.
* (The function name comes from an acronym of 'Wide Character String TO
* Multi-Byte String').
*
* Return value: the multi-byte string corresponding to @src, or %NULL if the
* conversion failed. The returned string should be freed with g_free() when no
* longer needed.
**/
gchar *
gdk_wcstombs (const GdkWChar *src)
{
@ -188,14 +192,20 @@ gdk_wcstombs (const GdkWChar *src)
return mbstr;
}
/**
* gdk_mbstowcs:
* @dest: the space to place the converted wide character string into.
* @src: the multi-byte string to convert, which must be nul-terminated.
* @dest_max: the maximum number of wide characters to place in @dest.
*
* Converts a multi-byte string to a wide character string.
* (The function name comes from an acronym of 'Multi-Byte String TO Wide
* Character String').
*
* Return value: the number of wide characters written into @dest, or -1 if
* the conversion failed.
**/
/*
* gdk_mbstowcs
*
* Converts the specified string into wide characters, and, returns the
* number of wide characters written. The string 'src' must be
* null-terminated. If the conversion is failed, it returns -1.
*/
gint
gdk_mbstowcs (GdkWChar *dest, const gchar *src, gint dest_max)
{