Small doc fixes.

This commit is contained in:
Matthias Clasen 2003-07-30 18:50:26 +00:00
parent 768bdf40b7
commit beca86c32b
9 changed files with 29 additions and 13 deletions

View File

@ -1,5 +1,7 @@
2003-07-30 Matthias Clasen <maclas@gmx.de> 2003-07-30 Matthias Clasen <maclas@gmx.de>
* 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-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 * glib/gfileutils.[hc]: Rename g_read_link() to g_file_read_link() to better match the remaining file

View File

@ -1,5 +1,7 @@
2003-07-30 Matthias Clasen <maclas@gmx.de> 2003-07-30 Matthias Clasen <maclas@gmx.de>
* 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-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 * glib/gfileutils.[hc]: Rename g_read_link() to g_file_read_link() to better match the remaining file

View File

@ -1,5 +1,7 @@
2003-07-30 Matthias Clasen <maclas@gmx.de> 2003-07-30 Matthias Clasen <maclas@gmx.de>
* 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-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 * glib/gfileutils.[hc]: Rename g_read_link() to g_file_read_link() to better match the remaining file

View File

@ -1,5 +1,7 @@
2003-07-30 Matthias Clasen <maclas@gmx.de> 2003-07-30 Matthias Clasen <maclas@gmx.de>
* 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-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 * glib/gfileutils.[hc]: Rename g_read_link() to g_file_read_link() to better match the remaining file

View File

@ -1,5 +1,7 @@
2003-07-30 Matthias Clasen <maclas@gmx.de> 2003-07-30 Matthias Clasen <maclas@gmx.de>
* 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-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 * glib/gfileutils.[hc]: Rename g_read_link() to g_file_read_link() to better match the remaining file

View File

@ -1,5 +1,7 @@
2003-07-30 Matthias Clasen <maclas@gmx.de> 2003-07-30 Matthias Clasen <maclas@gmx.de>
* 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-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 * glib/gfileutils.[hc]: Rename g_read_link() to g_file_read_link() to better match the remaining file

View File

@ -1,5 +1,7 @@
2003-07-30 Matthias Clasen <maclas@gmx.de> 2003-07-30 Matthias Clasen <maclas@gmx.de>
* glib/tmpl/string_utils.sgml: Small fixes.
* glib/glib-docs.sgml: Add paragraph about multi-threading policy. * glib/glib-docs.sgml: Add paragraph about multi-threading policy.
* glib/glib-sections.txt: Rename g_read_link to g_file_read_link. * glib/glib-sections.txt: Rename g_read_link to g_file_read_link.

View File

@ -162,7 +162,8 @@ an even better idea.
<!-- ##### FUNCTION g_strlcat ##### --> <!-- ##### FUNCTION g_strlcat ##### -->
<para> <para>
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 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 @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. strncat(), but for real security g_strconcat() is harder to mess up.
@ -555,8 +556,6 @@ possibly non-ASCII character in.
@str: @str:
@len: @len:
@Returns: @Returns:
<!-- # Unused Parameters # -->
@string:
<!-- ##### FUNCTION g_ascii_tolower ##### --> <!-- ##### FUNCTION g_ascii_tolower ##### -->
@ -636,7 +635,8 @@ Reverses all of the bytes in a string.
For example, <literal>g_strreverse ("abcdef")</literal> will result in "fedcba". For example, <literal>g_strreverse ("abcdef")</literal> will result in "fedcba".
</para> </para>
<para> <para>
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().
</para> </para>
@string: the string to reverse. @string: the string to reverse.
@ -690,8 +690,6 @@ The typical usage would be something like:
@buf_len: @buf_len:
@d: @d:
@Returns: @Returns:
<!-- # Unused Parameters # -->
@format:
<!-- ##### FUNCTION g_ascii_formatd ##### --> <!-- ##### FUNCTION g_ascii_formatd ##### -->
@ -754,7 +752,7 @@ to the @new_delimiter character.
@delimiters: a string containing the current delimiters, or %NULL to use the @delimiters: a string containing the current delimiters, or %NULL to use the
standard delimiters defined in #G_STR_DELIMITERS. standard delimiters defined in #G_STR_DELIMITERS.
@new_delimiter: the new delimiter character. @new_delimiter: the new delimiter character.
@Returns: @Returns: @string.
<!-- ##### MACRO G_STR_DELIMITERS ##### --> <!-- ##### MACRO G_STR_DELIMITERS ##### -->
@ -830,11 +828,15 @@ nesting such as <literal>g_ascii_strup (g_strcanon (str, "abc", '?'))</literal>.
<!-- ##### FUNCTION g_strconcat ##### --> <!-- ##### FUNCTION g_strconcat ##### -->
<para> <para>
Concatenates all of the given strings into one long string. The returned string 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 should be freed when no longer needed.
END WITH %NULL. If you forget the %NULL, g_strconcat() will start appending
random memory junk to your string.
</para> </para>
<warning><para>
The variable argument list <emphasis>must</emphasis> end with %NULL.
If you forget the %NULL, g_strconcat() will start appending
random memory junk to your string.
</para></warning>
@string1: The first string to add, which must not be %NULL. @string1: The first string to add, which must not be %NULL.
@Varargs: a %NULL-terminated list of strings to append to the string. @Varargs: a %NULL-terminated list of strings to append to the string.
@Returns: a newly-allocated string containing all the string arguments. @Returns: a newly-allocated string containing all the string arguments.
@ -875,7 +877,7 @@ strerror() function.
documentation. documentation.
@Returns: a string describing the error code. @Returns: a string describing the error code.
If the error code is unknown, it returns "unknown error (&lt;code&gt;)". If the error code is unknown, it returns "unknown error (&lt;code&gt;)".
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().
<!-- ##### FUNCTION g_strsignal ##### --> <!-- ##### FUNCTION g_strsignal ##### -->
@ -889,6 +891,6 @@ strsignal() function.
documentation. documentation.
@Returns: a string describing the signal. @Returns: a string describing the signal.
If the signal is unknown, it returns "unknown signal (&lt;signum&gt;)". If the signal is unknown, it returns "unknown signal (&lt;signum&gt;)".
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().

View File

@ -726,7 +726,7 @@ g_setenv (const gchar *variable,
/** /**
* g_unsetenv: * g_unsetenv:
* @name: the environment variable to remove. * @variable: the environment variable to remove.
* *
* Removes an environment variable from the environment. * Removes an environment variable from the environment.
* *