From 34928d8d057ab0ec93649e708071547ea084fa6a Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sat, 3 Jan 2009 04:15:17 +0000 Subject: Move docs inline svn path=/trunk/; revision=7761 --- docs/reference/ChangeLog | 4 + docs/reference/glib/tmpl/string_utils.sgml | 135 +++++++++-------------------- 2 files changed, 45 insertions(+), 94 deletions(-) (limited to 'docs/reference') diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 187ba326c..4c77983e8 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,7 @@ +2009-01-02 Matthias Clasen + + * glib/tmpl/string_utils.sgml: Move most function docs inline. + 2009-01-01 Matthias Clasen Bug 565831 – error in interface creation sample diff --git a/docs/reference/glib/tmpl/string_utils.sgml b/docs/reference/glib/tmpl/string_utils.sgml index 4a0552306..6a9aa4dad 100644 --- a/docs/reference/glib/tmpl/string_utils.sgml +++ b/docs/reference/glib/tmpl/string_utils.sgml @@ -42,13 +42,11 @@ wide characters (see g_unichar_iswide()) into account. -Duplicates a string. -If @str is %NULL it returns %NULL. -The returned string should be freed when no longer needed. + -@str: the string to duplicate. -@Returns: a newly-allocated copy of @str. +@str: +@Returns: @@ -153,65 +151,43 @@ The returned string should be freed when no longer needed. -Portability wrapper that calls strlcpy() on systems which have it, and emulates -strlcpy() otherwise. Copies @src to @dest; @dest is guaranteed to be -nul-terminated; @src must be nul-terminated; @dest_size is the buffer size, not -the number of chars to copy. Caveat: strlcpy() is supposedly more secure than -strcpy() or strncpy(), but if you really want to avoid screwups, g_strdup() is -an even better idea. + -@dest: destination buffer -@src: source buffer -@dest_size: length of @dest in bytes -@Returns: length of @src +@dest: +@src: +@dest_size: +@Returns: -Portability wrapper that calls strlcat() on systems which have it, and emulates it otherwise. -Appends nul-terminated @src string to @dest, guaranteeing -nul-termination for @dest. The total size of @dest won't exceed -@dest_size. Caveat: this is supposedly a more secure alternative to strcat() or -strncat(), but for real security g_strconcat() is harder to mess up. + -@dest: destination buffer, already containing one nul-terminated string -@src: source buffer -@dest_size: length of @dest buffer in bytes (not length of existing string inside @dest) -@Returns: length of @src plus initial length of string in @dest +@dest: +@src: +@dest_size: +@Returns: -Similar to the standard C sprintf() function -but safer, since it calculates the maximum space required and allocates -memory to hold the result. -The returned string should be freed when no longer needed. -@format: a standard printf() format string, but notice - string precision pitfalls. -@Varargs: the parameters to insert into the format string. -@Returns: a newly-allocated string holding the result. +@format: +@Varargs: +@Returns: -Similar to the standard C vsprintf() function -but safer, since it calculates the maximum space required and allocates -memory to hold the result. -The returned string should be freed when no longer needed. - - -See also g_vasprintf(), which offers the same functionality, but additionally -returns the length of the allocated string. + -@format: a standard printf() format string, but notice - string precision pitfalls. -@args: the list of parameters to insert into the format string. -@Returns: a newly-allocated string holding the result. +@format: +@args: +@Returns: @@ -637,16 +613,11 @@ possibly non-ASCII character in. -Reverses all of the bytes in a string. -For example, g_strreverse ("abcdef") will result in "fedcba". - - -Note that g_strreverse() doesn't work on UTF-8 strings containing multibyte characters. -For that purpose, use g_utf8_strreverse(). + -@string: the string to reverse. -@Returns: the same pointer passed in as @string. +@string: +@Returns: @@ -872,43 +843,32 @@ nesting such as g_ascii_strup (g_strcanon (str, "abc", '?')). -Concatenates all of the given strings into one long string. The returned string -should be freed when no longer needed. - - -The variable argument list must end with %NULL. -If you forget the %NULL, g_strconcat() will start appending -random memory junk to your string. - + -@string1: The first string to add, which must not be %NULL. -@Varargs: a %NULL-terminated list of strings to append to the string. -@Returns: a newly-allocated string containing all the string arguments. +@string1: +@Varargs: +@Returns: -Joins a number of strings together to form one long string, with the optional -@separator inserted between each of them. + -@separator: a string to insert between each of the strings, or %NULL. -@Varargs: a %NULL-terminated list of strings to join. -@Returns: a newly-allocated string containing all of the strings joined -together, with @separator between them. +@separator: +@Varargs: +@Returns: -Joins a number of strings together to form one long string, with the optional -@separator inserted between each of them. + -@separator: a string to insert between each of the strings, or %NULL. -@str_array: a %NULL-terminated array of strings to join. -@Returns: a newly-allocated string containing all of the strings joined -together, with @separator between them. +@separator: +@str_array: +@Returns: @@ -922,31 +882,18 @@ together, with @separator between them. -Returns a string corresponding to the given error code, e.g. "no such process". -You should use this function in preference to strerror(), because it returns a -string in UTF-8 encoding, and since not all platforms support the -strerror() function. + -@errnum: the system error number. See the standard C %errno -documentation. -@Returns: a UTF-8 string describing the error code. -If the error code is unknown, it returns "unknown error (<code>)". -The string can only be used until the next call to g_strerror(). +@errnum: +@Returns: -Returns a string describing the given signal, e.g. "Segmentation fault". -You should use this function in preference to strsignal(), because it returns a -string in UTF-8 encoding, and since not all platforms support the -strsignal() function. - -@signum: the signal number. See the signal -documentation. -@Returns: a UTF-8 string describing the signal. -If the signal is unknown, it returns "unknown signal (<signum>)". -The string can only be used until the next call to g_strsignal(). + +@signum: +@Returns: -- cgit v1.2.3