From: Matthias Clasen Date: Wed, 30 Jul 2003 18:50:26 +0000 (+0000) Subject: Small doc fixes. X-Git-Tag: GLIB_2_3_0~115 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=beca86c32bae083922293951e864a3f67f3ab8d0;p=platform%2Fupstream%2Fglib.git Small doc fixes. --- diff --git a/ChangeLog b/ChangeLog index 207c5c1..26b8875 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,7 @@ 2003-07-30 Matthias Clasen + * glib/gutils.c (g_unsetenv): Use same argument name as in header, to pacify gtk-doc. + * glib-2.0.pc.in (Libs): Remove forgotten @TRIO_LIBS@. (#118616, Noah Levitt) * glib/gfileutils.[hc]: Rename g_read_link() to g_file_read_link() to better match the remaining file diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 207c5c1..26b8875 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,5 +1,7 @@ 2003-07-30 Matthias Clasen + * glib/gutils.c (g_unsetenv): Use same argument name as in header, to pacify gtk-doc. + * glib-2.0.pc.in (Libs): Remove forgotten @TRIO_LIBS@. (#118616, Noah Levitt) * glib/gfileutils.[hc]: Rename g_read_link() to g_file_read_link() to better match the remaining file diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12 index 207c5c1..26b8875 100644 --- a/ChangeLog.pre-2-12 +++ b/ChangeLog.pre-2-12 @@ -1,5 +1,7 @@ 2003-07-30 Matthias Clasen + * glib/gutils.c (g_unsetenv): Use same argument name as in header, to pacify gtk-doc. + * glib-2.0.pc.in (Libs): Remove forgotten @TRIO_LIBS@. (#118616, Noah Levitt) * glib/gfileutils.[hc]: Rename g_read_link() to g_file_read_link() to better match the remaining file diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4 index 207c5c1..26b8875 100644 --- a/ChangeLog.pre-2-4 +++ b/ChangeLog.pre-2-4 @@ -1,5 +1,7 @@ 2003-07-30 Matthias Clasen + * glib/gutils.c (g_unsetenv): Use same argument name as in header, to pacify gtk-doc. + * glib-2.0.pc.in (Libs): Remove forgotten @TRIO_LIBS@. (#118616, Noah Levitt) * glib/gfileutils.[hc]: Rename g_read_link() to g_file_read_link() to better match the remaining file diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 207c5c1..26b8875 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,5 +1,7 @@ 2003-07-30 Matthias Clasen + * glib/gutils.c (g_unsetenv): Use same argument name as in header, to pacify gtk-doc. + * glib-2.0.pc.in (Libs): Remove forgotten @TRIO_LIBS@. (#118616, Noah Levitt) * glib/gfileutils.[hc]: Rename g_read_link() to g_file_read_link() to better match the remaining file diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 207c5c1..26b8875 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,5 +1,7 @@ 2003-07-30 Matthias Clasen + * glib/gutils.c (g_unsetenv): Use same argument name as in header, to pacify gtk-doc. + * glib-2.0.pc.in (Libs): Remove forgotten @TRIO_LIBS@. (#118616, Noah Levitt) * glib/gfileutils.[hc]: Rename g_read_link() to g_file_read_link() to better match the remaining file diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index d75ffe1..a2e9f90 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,5 +1,7 @@ 2003-07-30 Matthias Clasen + * glib/tmpl/string_utils.sgml: Small fixes. + * glib/glib-docs.sgml: Add paragraph about multi-threading policy. * glib/glib-sections.txt: Rename g_read_link to g_file_read_link. diff --git a/docs/reference/glib/tmpl/string_utils.sgml b/docs/reference/glib/tmpl/string_utils.sgml index 1464c04..4a19844 100644 --- a/docs/reference/glib/tmpl/string_utils.sgml +++ b/docs/reference/glib/tmpl/string_utils.sgml @@ -162,7 +162,8 @@ an even better idea. -Portability wrapper that calls strlcat() on systems which have it, and emulates it otherwise. Appends nul-terminated @src string to @dest, guaranteeing +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. @@ -555,8 +556,6 @@ possibly non-ASCII character in. @str: @len: @Returns: - -@string: @@ -636,7 +635,8 @@ 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(). +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. @@ -690,8 +690,6 @@ The typical usage would be something like: @buf_len: @d: @Returns: - -@format: @@ -754,7 +752,7 @@ to the @new_delimiter character. @delimiters: a string containing the current delimiters, or %NULL to use the standard delimiters defined in #G_STR_DELIMITERS. @new_delimiter: the new delimiter character. -@Returns: +@Returns: @string. @@ -830,11 +828,15 @@ 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. WARNING: THE VARIABLE ARGUMENT LIST MUST -END WITH %NULL. If you forget the %NULL, g_strconcat() will start appending -random memory junk to your 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. @@ -875,7 +877,7 @@ strerror() function. documentation. @Returns: a 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. +The string can only be used until the next call to g_strerror(). @@ -889,6 +891,6 @@ strsignal() function. documentation. @Returns: a 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. +The string can only be used until the next call to g_strsignal(). diff --git a/glib/gutils.c b/glib/gutils.c index d534288..8629793 100644 --- a/glib/gutils.c +++ b/glib/gutils.c @@ -726,7 +726,7 @@ g_setenv (const gchar *variable, /** * g_unsetenv: - * @name: the environment variable to remove. + * @variable: the environment variable to remove. * * Removes an environment variable from the environment. *